Developer Documentation
PluginFunctionsPlane.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 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 
51 //=============================================================================
52 //
53 // Plugin Functions for Planes
54 //
55 //=============================================================================
56 
58 #include "Plane.hh"
59 
61 
62 namespace PluginFunctions {
63 
64 // ===============================================================================
65 // Get objects
66 // ===============================================================================
67 
68 bool getObject( int _identifier , PlaneObject*& _object ) {
69 
70  if ( _identifier == BaseObject::NOOBJECT ) {
71  _object = 0;
72  return false;
73  }
74 
75  // Get object by using the map accelerated plugin function
76  BaseObjectData* object = 0;
77  PluginFunctions::getObject(_identifier,object);
78 
79  _object = dynamic_cast< PlaneObject* >(object);
80  return ( _object != 0 );
81 }
82 
83 
84 // ===============================================================================
85 // Getting data from objects and casting between them
86 // ===============================================================================
87 
89 
90  if ( _object->dataType(DATA_PLANE) ) {
91  PlaneObject* object = dynamic_cast< PlaneObject* >(_object);
92  return object->planeNode();
93  } else
94  return 0;
95 }
96 
97 
98 Plane* plane( BaseObjectData* _object ) {
99  if ( _object->dataType(DATA_PLANE) ) {
100  PlaneObject* object = dynamic_cast< PlaneObject* >(_object);
101  return & object->plane();
102  } else
103  return 0;
104 }
105 
107  if ( ! _object->dataType(DATA_PLANE) )
108  return 0;
109  return dynamic_cast< PlaneObject* >( _object );
110 }
111 
112 PlaneObject* planeObject( int _objectId ) {
113  if ( _objectId == BaseObject::NOOBJECT ) {
114  return 0;
115  }
116 
117  // Get object by using the map accelerated plugin function
118  BaseObjectData* object = 0;
119  PluginFunctions::getObject(_objectId,object);
120 
121  PlaneObject* plane = dynamic_cast< PlaneObject* >(object);
122  return plane;
123 }
124 
125 }
bool getObject(int _identifier, BSplineCurveObject *&_object)
bool dataType(DataType _type) const
Definition: BaseObject.cc:232
static int NOOBJECT
Definition: BaseObject.hh:118
PlaneNode * planeNode(BaseObjectData *_object)
Get a PlaneNode from an object.
Plane * plane(BaseObjectData *_object)
Get a Plane from an object.
PlaneObject * planeObject(BaseObjectData *_object)
Cast an BaseObject to a PlaneObject if possible.
#define DATA_PLANE
Definition: Plane.hh:64
PlaneNode * planeNode()
Get the scenegraph Node.
Definition: PlaneObject.cc:177