Developer Documentation

PluginFunctionsPlane.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
45 //=============================================================================
46 //
47 // Standard Functions
48 //
49 //=============================================================================
50
56 //
57 #ifndef PLUGINFUNCTIONSPLANE_HH
58 #define PLUGINFUNCTIONSPLANE_HH
59
60 #include <OpenFlipper/common/Types.hh>
61 #include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
62 #include "PlaneObject.hh"
63
65 namespace PluginFunctions {
66
70 OBJECTTYPEDLLEXPORT
71 bool getObject( int _identifier , PlaneObject*& _object );
72
78 OBJECTTYPEDLLEXPORT
79 PlaneNode* planeNode( BaseObjectData* _object );
80
86 OBJECTTYPEDLLEXPORT
87 ACG::Geometry::Plane* plane( BaseObjectData* _object );
88
94 OBJECTTYPEDLLEXPORT
95 PlaneObject* planeObject( BaseObjectData* _object );
96
101 OBJECTTYPEDLLEXPORT
102 PlaneObject* planeObject( int _objectId );
103
104 }
105
106 #endif // PLUGINFUNCTIONSPLANE_HH
PlaneObject.hh
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:296
ObjectTypeDLLDefines.hh
PluginFunctions::planeNode
PlaneNode * planeNode(BaseObjectData *_object)
Get a PlaneNode from an object.
Definition: PluginFunctionsPlane.cc:82
BaseObjectData
Definition: BaseObjectData.hh:102
PluginFunctions::planeObject
PlaneObject * planeObject(BaseObjectData *_object)
Cast an BaseObject to a PlaneObject if possible.
Definition: PluginFunctionsPlane.cc:100
PluginFunctions::plane
Plane * plane(BaseObjectData *_object)
Get a Plane from an object.
Definition: PluginFunctionsPlane.cc:92
PlaneObject
Definition: PlaneObject.hh:75
ACG::Geometry::Plane
Definition: PlaneType.hh:50
Types.hh
PluginFunctions
Definition: PluginFunctions.cc:57
PlaneNode
Definition: PlaneNode.hh:74