Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
LightObject.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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49
50 //=============================================================================
51 //
52 // Types
53 //
54 //=============================================================================
55
62 #ifndef LIGHTOBJECT_HH
63 #define LIGHTOBJECT_HH
64
65
66
67 //== INCLUDES =================================================================
68
69 #include <OpenFlipper/common/BaseObjectData.hh>
70 #include <OpenFlipper/common/GlobalDefines.hh>
71
72 #include "LightTypes.hh"
73
74 //== TYPEDEFS =================================================================
75
76 // //== CLASS DEFINITION =========================================================
77
78 class DLLEXPORT LightObject : public BaseObjectData {
79
80 friend class TypeLightPlugin;
81 friend class LightWidget;
82
83 public:
85 LightObject();
86
91 LightObject(const LightObject& _object);
92
94 virtual ~LightObject();
95
97 virtual void cleanup();
98
102 BaseObject* copy();
103
104
105 protected:
107 virtual void init(LightNode* _light = 0, LightNode* _lightVis = 0);
108
109 //===========================================================================
112 //===========================================================================
113 public:
114
116 void setName( QString _name );
117
120 //===========================================================================
123 //===========================================================================
124 public:
125
126 LightSource* lightSource();
127
128
130 bool defaultLight() const { return defaultLightSource_; }
131
133 void defaultLight( const bool _default ) { defaultLightSource_ = _default; }
134
135 private:
136 LightSource lightSource_;
137
140 bool defaultLightSource_;
141
144 //===========================================================================
151 //===========================================================================
152
153 protected:
158 virtual void update(UpdateType _type = UPDATE_ALL);
159
162 //===========================================================================
165 //===========================================================================
166
167 public:
169 LightNode* lightNode();
170
172 LightNode* lightNodeVis();
173
174 virtual bool hasNode(BaseNode* _node);
175
176 private:
178 LightNode* lightNode_;
179
181 LightNode* lightNodeVis_;
182
185 //===========================================================================
188 //===========================================================================
189 public:
191 QString getObjectinfo();
192
196 //===========================================================================
199 //===========================================================================
200 public:
202 bool picked( uint _node_idx );
203
205 void enablePicking( bool _enable );
206
208 bool pickingEnabled();
209
212 public:
213
215 virtual void visible(bool _visible);
216
218 virtual bool visible();
219
221 virtual void show();
222
224 virtual void hide();
225
226
227 };
228
229 //=============================================================================
230 #endif // LIGHTOBJECT_HH defined
231 //=============================================================================
LightObject::lightSource_
LightSource lightSource_
Definition: LightObject.hh:136
ACG::SceneGraph::BaseNode
Definition: BaseNode.hh:135
BaseObject::getObjectinfo
virtual QString getObjectinfo()
Get all Info for the Object as a string.
Definition: BaseObject.cc:255
BaseObjectData
Definition: BaseObjectData.hh:105
UpdateType
Update type class.
Definition: UpdateType.hh:70
UPDATE_ALL
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
GlobalDefines.hh
BaseObjectData::setName
virtual void setName(QString _name)
path to the file from which the object is loaded ( defaults to "." )
Definition: BaseObjectData.cc:357
BaseObjectData::pickingEnabled
virtual bool pickingEnabled()
Definition: BaseObjectData.cc:320
BaseObjectData::show
virtual void show()
Sets the whole Scenegraph subtree of this node to visible.
Definition: BaseObjectData.cc:194
LightObject::defaultLight
bool defaultLight() const
Is light default light source?
Definition: LightObject.hh:130
LightObject
Definition: LightObject.hh:78
BaseObjectData::hide
virtual void hide()
Sets the whole Scenegraph subtree of this node to invisible.
Definition: BaseObjectData.cc:203
BaseObjectData::cleanup
virtual void cleanup()
Definition: BaseObjectData.cc:108
LightObject::lightNodeVis_
LightNode * lightNodeVis_
Light rendering node (only for rendering purposes)
Definition: LightObject.hh:181
BaseObjectData::hasNode
virtual bool hasNode(BaseNode *_node)
Check if the given node is owned by this object.
Definition: BaseObjectData.cc:235
BaseObjectData::enablePicking
virtual void enablePicking(bool _enable)
Definition: BaseObjectData.cc:317
BaseObject
Definition: BaseObject.hh:94
BaseObjectData::update
virtual void update(UpdateType _type=UPDATE_ALL)
This function is called to update the object.
Definition: BaseObjectData.cc:331
LightObject::lightNode_
LightNode * lightNode_
Light status node.
Definition: LightObject.hh:178
LightObject::defaultLight
void defaultLight(const bool _default)
Set light object to be default light.
Definition: LightObject.hh:133
ACG::SceneGraph::LightNode
Definition: LightNode.hh:255
TypeLightPlugin
Definition: TypeLight.hh:68
LightTypes.hh
DLLEXPORT
#define DLLEXPORT
Definition: GlobalDefines.hh:107
ACG::SceneGraph::LightSource
Structure to hold options for one LightSource.
Definition: LightNode.hh:91
LightWidget
Definition: LightWidget.hh:62
BaseObject::copy
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:780
LightObject::defaultLightSource_
bool defaultLightSource_
Definition: LightObject.hh:140
BaseObjectData::visible
virtual bool visible()
return visiblity
Definition: BaseObjectData.cc:212
BaseObjectData.hh
BaseObjectData::picked
virtual bool picked(uint _node_idx)
detect if the node has been picked
Definition: BaseObjectData.cc:313