Developer Documentation
PluginFunctionsLight.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 //=============================================================================
54 //
55 // Plugin Functions for Lights
56 //
57 //=============================================================================
58 
60 
61 
62 #include "PluginFunctionsLight.hh"
63 
64 namespace PluginFunctions {
65 
66 // ===============================================================================
67 // Get objects
68 // ===============================================================================
69 
70 bool getObject( int _identifier , LightObject*& _object ) {
71 
72  if ( _identifier == BaseObject::NOOBJECT ) {
73  _object = 0;
74  return false;
75  }
76 
77  // Get object by using the map accelerated plugin function
78  BaseObjectData* object = 0;
79  PluginFunctions::getObject(_identifier,object);
80 
81  _object = dynamic_cast< LightObject* >(object);
82  return ( _object != 0 );
83 }
84 
85 
86 // ===============================================================================
87 // Getting data from objects and casting between them
88 // ===============================================================================
89 
91 
92  if ( _object->dataType(DATA_LIGHT) ) {
93  LightObject* object = dynamic_cast< LightObject* >(_object);
94  return object->lightNode();
95  } else
96  return 0;
97 }
98 
99 
101  if ( ! _object->dataType(DATA_LIGHT) )
102  return 0;
103  return dynamic_cast< LightObject* >( _object );
104 }
105 
107 
108  if ( ! _object->dataType(DATA_LIGHT) )
109  return 0;
110  LightObject* light = dynamic_cast< LightObject* >( _object );
111 
112  return light->lightSource();
113 }
114 
115 DLLEXPORT
117 
118  if ( ! _object )
119  return 0;
120 
121  return _object->lightSource();
122 }
123 
124 }
LightObject * lightObject(BaseObjectData *_object)
Cast an BaseObject to a LightObject if possible.
LightNode * lightNode()
Get the scenegraph Node.
Definition: LightObject.cc:229
LightNode * lightNode(BaseObjectData *_object)
Get a LightNode from an object.
bool getObject(int _identifier, BSplineCurveObject *&_object)
LightSource * lightSource()
Definition: LightObject.cc:328
bool dataType(DataType _type) const
Definition: BaseObject.cc:232
static int NOOBJECT
Definition: BaseObject.hh:118
#define DLLEXPORT
LightSource * lightSource(BaseObjectData *_object)
Get the lightSource in this Object.
#define DATA_LIGHT
Definition: Light.hh:64
Structure to hold options for one LightSource.
Definition: LightNode.hh:91