Developer Documentation

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