Developer Documentation

PluginFunctionsPolyLineCollection.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 #pragma once
68
69 #include <OpenFlipper/common/Types.hh>
70 #include "PolyLineCollectionTypes.hh"
71 #include "PolyLineCollectionObject.hh"
72
74 namespace PluginFunctions {
75
76
83 OBJECTTYPEDLLEXPORT
84 bool getSourcePolylineCollections( std::vector<PolyLineCollection*>& _polylines );
85
92 OBJECTTYPEDLLEXPORT
93 bool getTargetPolylineCollections( std::vector<PolyLineCollection*>& _polylines );
94
95
100 OBJECTTYPEDLLEXPORT
101 bool getObject( int _identifier , PolyLineCollectionObject*& _object );
102
109 OBJECTTYPEDLLEXPORT
110 PolyLineCollection* polyLineCollection( BaseObjectData* _object );
111
118 OBJECTTYPEDLLEXPORT
119 PolyLineCollectionObject* polyLineCollectionObject( BaseObjectData* _object );
120
127 OBJECTTYPEDLLEXPORT
128 PolyLineCollectionObject* polyLineCollectionObject( int _objectId );
129
130 }
131
PolyLineCollectionTypes.hh
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::polyLineCollectionObject
PolyLineCollectionObject * polyLineCollectionObject(BaseObjectData *_object)
Cast an BaseObject to a Polyline Collection Object if possible.
Definition: PluginFunctionsPolyLineCollection.cc:143
PolyLineCollectionObject
Definition: PolyLineCollectionObject.hh:74
PluginFunctions::getTargetPolylineCollections
OBJECTTYPEDLLEXPORT bool getTargetPolylineCollections(std::vector< PolyLineCollection *> &_polylines)
Get a pointer to every Polyline Collection which is marked as a target.
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:294
Types.hh
PolyLineCollectionT
Definition: PolyLineCollectionT.hh:49
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