Developer Documentation

PluginFunctionsPolyLineCollection.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 *
44 * $Revision$
45 * $Date$
46 *
47 \*===========================================================================*/
48
49
50
51
52
53
54
55
56 //=============================================================================
57 //
58 // Plugin Functions for Polyline Collections
59 //
60 //=============================================================================
61
62 #include <OpenFlipper/common/Types.hh>
63 #include "PolyLineCollection.hh"
64
65 #include "PluginFunctionsPolyLineCollection.hh"
66 #include <OpenFlipper/BasePlugin/PluginFunctions.hh>
67
68 namespace PluginFunctions {
69
70 // ===============================================================================
71 // Get source polylines
72 // ===============================================================================
73
74
75 bool getSourcePolylineCollections( std::vector<PolyLineCollection*>& _polylines )
76 {
77 _polylines.clear();
78
79 for ( ObjectIterator o_it(PluginFunctions::SOURCE_OBJECTS,DATA_POLY_LINE_COLLECTION ) ;
80 o_it != PluginFunctions::objectsEnd(); ++o_it) {
81 _polylines.push_back ( PluginFunctions::polyLineCollection( *o_it ) );
82 if( _polylines.back() == 0)
83 std::cerr << "ERROR: Polyine get_source_polyline_collections fatal error\n";
84 }
85
86 return ( !_polylines.empty() );
87 }
88
89
90 // ===============================================================================
91 // Get target polylines
92 // ===============================================================================
93
94
95 bool getTargetPolylines( std::vector<PolyLineCollection*>& _polylines )
96 {
97 _polylines.clear();
98
99 for ( ObjectIterator o_it(PluginFunctions::TARGET_OBJECTS,DATA_POLY_LINE_COLLECTION ) ;
100 o_it != PluginFunctions::objectsEnd(); ++o_it) {
101 _polylines.push_back ( PluginFunctions::polyLineCollection( *o_it ) );
102 if( _polylines.back() == 0)
103 std::cerr << "ERROR: Polyine getTargetPolylines fatal error\n";
104 }
105
106 return ( !_polylines.empty() );
107 }
108
109
110 // ===============================================================================
111 // Get objects
112 // ===============================================================================
113
114 bool getObject( int _identifier , PolyLineCollectionObject*& _object ) {
115
116 /*if ( _identifier == BaseObject::NOOBJECT ) {
117 _object = 0;
118 return false;
119 }*/
120
121 // Get object by using the map accelerated plugin function
122 BaseObjectData* object = 0;
123 PluginFunctions::getObject(_identifier,object);
124
125 _object = dynamic_cast< PolyLineCollectionObject* >(object);
126 return ( _object != 0 );
127 }
128
129
130 // ===============================================================================
131 // Getting data from objects and casting between them
132 // ===============================================================================
133
134 PolyLineCollection* polyLineCollection( BaseObjectData* _object ) {
135 if ( _object->dataType(DATA_POLY_LINE_COLLECTION) ) {
136 PolyLineCollectionObject* object = dynamic_cast< PolyLineCollectionObject* >(_object);
137 return object->collection();
138 } else
139 return 0;
140 }
141
142
143 PolyLineCollectionObject* polyLineCollectionObject( BaseObjectData* _object ) {
144 if ( ! _object->dataType(DATA_POLY_LINE_COLLECTION) )
145 return 0;
146 return dynamic_cast< PolyLineCollectionObject* >( _object );
147 }
148
149 PolyLineCollectionObject* polyLineCollectionObject( int _objectId ) {
150
151 // Get object by using the map accelerated plugin function
152 BaseObjectData* object = 0;
153 PluginFunctions::getObject(_objectId,object);
154
155 if ( object == 0 )
156 return 0;
157
158 PolyLineCollectionObject* meshObject = dynamic_cast< PolyLineCollectionObject* >(object);
159
160 return meshObject;
161 }
162
163
164 }
165
PluginFunctions::getSourcePolylineCollections
bool getSourcePolylineCollections(std::vector< PolyLineCollection *> &_polylines)
Get a pointer to every Polyline Collection which is marked as a source.
Definition: PluginFunctionsPolyLineCollection.cc:75
PluginFunctions::SOURCE_OBJECTS
const QStringList SOURCE_OBJECTS("source")
Iterable object range.
PluginFunctions.hh
PluginFunctions::getTargetPolylines
bool getTargetPolylines(std::vector< PolyLine *> &_polylines)
Get a pointer to every Polyline which is marked as a target.
Definition: PluginFunctionsPolyLine.cc:94
PluginFunctionsPolyLineCollection.hh
PluginFunctions::polyLineCollectionObject
PolyLineCollectionObject * polyLineCollectionObject(BaseObjectData *_object)
Cast an BaseObject to a Polyline Collection Object if possible.
Definition: PluginFunctionsPolyLineCollection.cc:143
BaseObject::dataType
bool dataType(DataType _type) const
Definition: BaseObject.cc:221
PolyLineCollectionObject
Definition: PolyLineCollectionObject.hh:74
PluginFunctions::TARGET_OBJECTS
const QStringList TARGET_OBJECTS("target")
Iterable object range.
PolyLineCollection.hh
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:294
PolyLineCollectionObject::collection
PolyLineCollection * collection()
return a pointer to the line
Definition: PolyLineCollectionObject.cc:194
DATA_POLY_LINE_COLLECTION
#define DATA_POLY_LINE_COLLECTION
Definition: PolyLineCollection.hh:63
Types.hh
PolyLineCollectionT
Definition: PolyLineCollectionT.hh:49
PluginFunctions::ObjectIterator
Core Data Iterator.
Definition: PluginFunctions.hh:441
PluginFunctions::objectsEnd
DLLEXPORT ObjectIterator objectsEnd()
Return Iterator to Object End.
Definition: PluginFunctionsIterator.cc:177
PluginFunctions
Definition: PluginFunctions.cc:57
PluginFunctions::polyLineCollection
PolyLineCollection * polyLineCollection(BaseObjectData *_object)
Get a polyLine Collection from an object.
Definition: PluginFunctionsPolyLineCollection.cc:134
BaseObjectData
Definition: BaseObjectData.hh:102