Developer Documentation

PluginFunctionsPolyLine.hh
Go to the documentation of this file.
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 // Standard Functions
59 //
60 //=============================================================================
61
67 //
68 #ifndef PLUGINFUNCTIONSPOLYLINE_HH
69 #define PLUGINFUNCTIONSPOLYLINE_HH
70
71 #include <OpenFlipper/common/Types.hh>
72
74 namespace PluginFunctions {
75
76
82 OBJECTTYPEDLLEXPORT
83 bool getSourcePolylines( std::vector<PolyLine*>& _polylines );
84
90 OBJECTTYPEDLLEXPORT
91 bool getTargetPolylines( std::vector<PolyLine*>& _polylines );
92
93
97 OBJECTTYPEDLLEXPORT
98 bool getObject( int _identifier , PolyLineObject*& _object );
99
105 OBJECTTYPEDLLEXPORT
106 PolyLine* polyLine( BaseObjectData* _object );
107
113 OBJECTTYPEDLLEXPORT
114 PolyLineObject* polyLineObject( BaseObjectData* _object );
115
121 OBJECTTYPEDLLEXPORT
122 PolyLineObject* polyLineObject( int _objectId );
123
124 }
125
126 #endif // PLUGINFUNCTIONSPOLYLINE_HH
PluginFunctions::polyLine
PolyLine * polyLine(BaseObjectData *_object)
Get a poly Line from an object.
Definition: PluginFunctionsPolyLine.cc:133
PluginFunctions::polyLineObject
PolyLineObject * polyLineObject(BaseObjectData *_object)
Cast an BaseObject to a PolyLineObject if possible.
Definition: PluginFunctionsPolyLine.cc:142
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:296
PolyLineObject
Definition: PolyLineObject.hh:76
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::getTargetPolylines
bool getTargetPolylines(std::vector< PolyLine *> &_polylines)
Get a pointer to every Polyline which is marked as a target.
Definition: PluginFunctionsPolyLine.cc:94
BaseObjectData
Definition: BaseObjectData.hh:102
Types.hh
PluginFunctions
Definition: PluginFunctions.cc:57
ACG::PolyLineT
Definition: PolyLineT.hh:84