Developer Documentation

PluginFunctionsLight.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 //=============================================================================
48 //
49 // Standard Functions
50 //
51 //=============================================================================
52
58 //
59 #ifndef PLUGINFUNCTIONSLIGHT_HH
60 #define PLUGINFUNCTIONSLIGHT_HH
61
62 #include <OpenFlipper/common/Types.hh>
63 #include "Light.hh"
64
65
67 namespace PluginFunctions {
68
72 OBJECTTYPEDLLEXPORT
73 bool getObject( int _identifier , LightObject*& _object );
74
80 OBJECTTYPEDLLEXPORT
81 LightNode* lightNode( BaseObjectData* _object );
82
88 OBJECTTYPEDLLEXPORT
89 LightObject* lightObject( BaseObjectData* _object );
90
96 OBJECTTYPEDLLEXPORT
97 LightSource* lightSource( BaseObjectData* _object );
98
104 OBJECTTYPEDLLEXPORT
105 LightSource* lightSource( LightObject* _object );
106
107 }
108
109 #endif // PLUGINFUNCTIONSLIGHT_HH
PluginFunctions::lightObject
LightObject * lightObject(BaseObjectData *_object)
Cast an BaseObject to a LightObject if possible.
Definition: PluginFunctionsLight.cc:94
PluginFunctions::getObject
bool getObject(const int _identifier, BaseObject *&_object)
Get the object which has the given identifier.
Definition: PluginFunctions.cc:296
Light.hh
LightObject
Definition: LightObject.hh:72
ACG::SceneGraph::LightNode
Definition: LightNode.hh:249
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
PluginFunctions::lightSource
LightSource * lightSource(BaseObjectData *_object)
Get the lightSource in this Object.
Definition: PluginFunctionsLight.cc:100