Developer Documentation

ObjectSelectionFunctions.cc
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43 #include "ObjectSelectionPlugin.hh"
44
45 #include <OpenFlipper/common/GlobalOptions.hh>
46
47 #include <QMessageBox>
48
50 void ObjectSelectionPlugin::selectAllObjects() {
51
52 for (PluginFunctions::ObjectIterator o_it(PluginFunctions::ALL_OBJECTS, DataType(DATA_ALL));
53 o_it != PluginFunctions::objectsEnd(); ++o_it) {
54
55 o_it->target(true);
56 }
57
58 emit scriptInfo("selectAllObjects()");
59 }
60
62 void ObjectSelectionPlugin::selectObjects(IdList _list) {
63
64 for(IdList::iterator it = _list.begin(); it != _list.end(); ++it) {
65 BaseObjectData* object = 0;
66 PluginFunctions::getObject(*it, object);
67 if(object) {
68 object->target(true);
69 }
70 }
71
72 emit scriptInfo("selectObjects(IdList)");
73 }
74
76 void ObjectSelectionPlugin::deselectAllObjects() {
77
78 for (PluginFunctions::ObjectIterator o_it(PluginFunctions::ALL_OBJECTS, DataType(DATA_ALL));
79 o_it != PluginFunctions::objectsEnd(); ++o_it) {
80
81 o_it->target(false);
82 }
83
84 emit scriptInfo("deselectAllObjects()");
85 }
86
88 void ObjectSelectionPlugin::invertObjectSelection() {
89
90 for (PluginFunctions::ObjectIterator o_it(PluginFunctions::ALL_OBJECTS, DataType(DATA_ALL));
91 o_it != PluginFunctions::objectsEnd(); ++o_it) {
92
93 o_it->target(!o_it->target());
94 }
95
96 emit scriptInfo("invertObjectSelection()");
97 }
98
100 void ObjectSelectionPlugin::deleteSelectedObjects() {
101
102 if(!OpenFlipper::Options::nogui()) {
103 int ret = QMessageBox::warning(0, tr("Open Flipper"),
104 tr("Do you really want to delete the selected objects?"),
105 QMessageBox::Yes | QMessageBox::Cancel,
106 QMessageBox::Cancel);
107
108 if(ret == QMessageBox::Cancel) return;
109 }
110
111 std::vector<int> deleteIds;
112
113 for (PluginFunctions::ObjectIterator o_it(PluginFunctions::TARGET_OBJECTS, DataType(DATA_ALL));
114 o_it != PluginFunctions::objectsEnd(); ++o_it) {
115
116 deleteIds.push_back(o_it->id());
117 }
118
119 for(std::vector<int>::iterator it = deleteIds.begin(); it != deleteIds.end(); ++it) {
120 emit deleteObject(*it);
121 }
122
123 emit scriptInfo("invertObjectSelection()");
124 }
125
127 IdList ObjectSelectionPlugin::getObjectSelection() {
128
129 IdList list;
130 for (PluginFunctions::ObjectIterator o_it(PluginFunctions::TARGET_OBJECTS, DataType(DATA_ALL));
131 o_it != PluginFunctions::objectsEnd(); ++o_it) {
132
133 list.push_back(o_it->id());
134 }
135 return list;
136 }
ObjectSelectionPlugin::deselectAllObjects
void deselectAllObjects()
Deselect all objects.
Definition: ObjectSelectionFunctions.cc:76
PluginFunctions::TARGET_OBJECTS
const QStringList TARGET_OBJECTS("target")
Iterable object range.
ObjectSelectionPlugin::deleteSelectedObjects
void deleteSelectedObjects()
Delete selected objects.
Definition: ObjectSelectionFunctions.cc:100
PluginFunctions::ALL_OBJECTS
const QStringList ALL_OBJECTS
Iterable object range.
Definition: PluginFunctions.hh:430
GlobalOptions.hh
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:294
IdList
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:179
ObjectSelectionPlugin::selectObjects
void selectObjects(IdList _list)
Select specified objects.
Definition: ObjectSelectionFunctions.cc:62
ObjectSelectionPlugin::selectAllObjects
void selectAllObjects()
Select all objects.
Definition: ObjectSelectionFunctions.cc:50
DataType
Predefined datatypes.
Definition: DataTypes.hh:83
PluginFunctions::ObjectIterator
Core Data Iterator.
Definition: PluginFunctions.hh:441
ObjectSelectionPlugin::invertObjectSelection
void invertObjectSelection()
Invert object selection.
Definition: ObjectSelectionFunctions.cc:88
PluginFunctions::objectsEnd
DLLEXPORT ObjectIterator objectsEnd()
Return Iterator to Object End.
Definition: PluginFunctionsIterator.cc:177
ObjectSelectionPlugin::getObjectSelection
IdList getObjectSelection()
Get selected objects.
Definition: ObjectSelectionFunctions.cc:127
BaseObjectData
Definition: BaseObjectData.hh:102
DATA_ALL
const DataType DATA_ALL(UINT_MAX)
Identifier for all available objects.