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
45
46
47 //=============================================================================
48 //
49 // Plugin Functions for Lights
50 //
51 //=============================================================================
52
53 #include <OpenFlipper/common/Types.hh>
54
55
56 #include "PluginFunctionsLight.hh"
57
58 namespace PluginFunctions {
59
60 // ===============================================================================
61 // Get objects
62 // ===============================================================================
63
64 bool getObject( int _identifier , LightObject*& _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< LightObject* >(object);
76 return ( _object != 0 );
77 }
78
79
80 // ===============================================================================
81 // Getting data from objects and casting between them
82 // ===============================================================================
83
84 LightNode* lightNode( BaseObjectData* _object ) {
85
86 if ( _object->dataType(DATA_LIGHT) ) {
87 LightObject* object = dynamic_cast< LightObject* >(_object);
88 return object->lightNode();
89 } else
90 return 0;
91 }
92
93
94 LightObject* lightObject( BaseObjectData* _object ) {
95 if ( ! _object->dataType(DATA_LIGHT) )
96 return 0;
97 return dynamic_cast< LightObject* >( _object );
98 }
99
100 LightSource* lightSource( BaseObjectData* _object ) {
101
102 if ( ! _object->dataType(DATA_LIGHT) )
103 return 0;
104 LightObject* light = dynamic_cast< LightObject* >( _object );
105
106 return light->lightSource();
107 }
108
109 DLLEXPORT
110 LightSource* lightSource( LightObject* _object ) {
111
112 if ( ! _object )
113 return 0;
114
115 return _object->lightSource();
116 }
117
118 }
LightObject::lightSource
LightSource * lightSource()
Definition: LightObject.cc:326
PluginFunctions::lightObject
LightObject * lightObject(BaseObjectData *_object)
Cast an BaseObject to a LightObject if possible.
Definition: PluginFunctionsLight.cc:94
DLLEXPORT
#define DLLEXPORT
Definition: GlobalDefines.hh:95
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:296
LightObject
Definition: LightObject.hh:72
BaseObject::dataType
bool dataType(DataType _type) const
Definition: BaseObject.cc:221
ACG::SceneGraph::LightNode
Definition: LightNode.hh:249
BaseObject::NOOBJECT
static int NOOBJECT
Definition: BaseObject.hh:106
ACG::SceneGraph::LightSource
Structure to hold options for one LightSource.
Definition: LightNode.hh:85
PluginFunctions::lightNode
LightNode * lightNode(BaseObjectData *_object)
Get a LightNode from an object.
Definition: PluginFunctionsLight.cc:84
BaseObjectData
Definition: BaseObjectData.hh:102
Types.hh
PluginFunctions
Definition: PluginFunctions.cc:57
DATA_LIGHT
#define DATA_LIGHT
Definition: Light.hh:58
PluginFunctionsLight.hh
LightObject::lightNode
LightNode * lightNode()
Get the scenegraph Node.
Definition: LightObject.cc:227
PluginFunctions::lightSource
LightSource * lightSource(BaseObjectData *_object)
Get the lightSource in this Object.
Definition: PluginFunctionsLight.cc:100