Developer Documentation
PluginFunctionsSphere.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 
45 
46 
47 //=============================================================================
48 //
49 // Plugin Functions for Spheres
50 //
51 //=============================================================================
52 
54 #include "Sphere.hh"
55 
57 
58 namespace PluginFunctions {
59 
60 // ===============================================================================
61 // Get objects
62 // ===============================================================================
63 
64 bool getObject( int _identifier , SphereObject*& _object ) {
65 
66  if ( _identifier == BaseObject::NOOBJECT ) {
67  _object = 0;
68  return false;
69  }
70 
71  // Get object by using the map accelerated plugin function
72  BaseObjectData* object = 0;
73  PluginFunctions::getObject(_identifier,object);
74 
75  _object = dynamic_cast< SphereObject* >(object);
76  return ( _object != 0 );
77 }
78 
79 SphereObject* sphereObject( int _objectId ) {
80 
81  if ( _objectId == BaseObject::NOOBJECT ) {
82  return 0;
83  }
84 
85  // Get object by using the map accelerated plugin function
86  BaseObjectData* object = 0;
87  PluginFunctions::getObject(_objectId,object);
88 
89  SphereObject* sphereObject = dynamic_cast< SphereObject* >(object);
90  return sphereObject;
91 
92 }
93 
94 
95 // ===============================================================================
96 // Getting data from objects and casting between them
97 // ===============================================================================
98 
100 
101  if ( _object->dataType(DATA_SPHERE) ) {
102  SphereObject* object = dynamic_cast< SphereObject* >(_object);
103  return object->sphereNode();
104  } else
105  return 0;
106 }
107 
108 
110  if ( ! _object->dataType(DATA_SPHERE) )
111  return 0;
112  return dynamic_cast< SphereObject* >( _object );
113 }
114 
115 }
SphereObject * sphereObject(int _objectId)
Get a SphereObject from id if possible.
#define DATA_SPHERE
Definition: Sphere.hh:58
bool dataType(DataType _type) const
Definition: BaseObject.cc:221
SphereNode * sphereNode()
Get the scenegraph Node.
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
static int NOOBJECT
Definition: BaseObject.hh:106
SphereNode * sphereNode(BaseObjectData *_object)
Get a SphereNode from an object.