Developer Documentation

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 //=============================================================================
45 //
46 // Types
47 //
48 //=============================================================================
49
56 #ifndef LIGHTOBJECT_HH
57 #define LIGHTOBJECT_HH
58
59
60
61 //== INCLUDES =================================================================
62
63 #include <OpenFlipper/common/BaseObjectData.hh>
64 #include <OpenFlipper/common/ObjectTypeDLLDefines.hh>
65
66 #include "LightTypes.hh"
67
68 //== TYPEDEFS =================================================================
69
70 // //== CLASS DEFINITION =========================================================
71
72 class OBJECTTYPEDLLEXPORT LightObject : public BaseObjectData {
73
74 friend class TypeLightPlugin;
75 friend class LightWidget;
76
77 public:
79 LightObject();
80
85 LightObject(const LightObject& _object);
86
88 virtual ~LightObject();
89
91 virtual void cleanup();
92
96 BaseObject* copy();
97
98
99 protected:
101 virtual void init(LightNode* _light = 0, LightNode* _lightVis = 0);
102
103 //===========================================================================
106 //===========================================================================
107 public:
108
110 void setName( QString _name );
111
114 //===========================================================================
117 //===========================================================================
118 public:
119
120 LightSource* lightSource();
121
122
124 bool defaultLight() const { return defaultLightSource_; }
125
127 void defaultLight( const bool _default ) { defaultLightSource_ = _default; }
128
129 private:
130 LightSource lightSource_;
131
134 bool defaultLightSource_;
135
138 //===========================================================================
145 //===========================================================================
146
147 protected:
152 virtual void update(UpdateType _type = UPDATE_ALL);
153
156 //===========================================================================
159 //===========================================================================
160
161 public:
163 LightNode* lightNode();
164
166 LightNode* lightNodeVis();
167
168 virtual bool hasNode(BaseNode* _node);
169
170 private:
172 LightNode* lightNode_;
173
175 LightNode* lightNodeVis_;
176
179 //===========================================================================
182 //===========================================================================
183 public:
185 QString getObjectinfo();
186
190 //===========================================================================
193 //===========================================================================
194 public:
196 bool picked( uint _node_idx );
197
199 void enablePicking( bool _enable );
200
202 bool pickingEnabled();
203
206 public:
207
209 virtual void visible(bool _visible);
210
212 virtual bool visible();
213
215 virtual void show();
216
218 virtual void hide();
219
220
221 };
222
223 //=============================================================================
224 #endif // LIGHTOBJECT_HH defined
225 //=============================================================================
LightObject::defaultLight
void defaultLight(const bool _default)
Set light object to be default light.
Definition: LightObject.hh:127
BaseObjectData::show
virtual void show()
Sets the whole Scenegraph subtree of this node to visible.
Definition: BaseObjectData.cc:188
UpdateType
Update type class.
Definition: UpdateType.hh:60
BaseObject::getObjectinfo
virtual QString getObjectinfo()
Get all Info for the Object as a string.
Definition: BaseObject.cc:244
UPDATE_ALL
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
LightObject::defaultLight
bool defaultLight() const
Is light default light source?
Definition: LightObject.hh:124
BaseObjectData::update
virtual void update(UpdateType _type=UPDATE_ALL)
This function is called to update the object.
Definition: BaseObjectData.cc:329
ObjectTypeDLLDefines.hh
BaseObjectData::hasNode
virtual bool hasNode(BaseNode *_node)
Check if the given node is owned by this object.
Definition: BaseObjectData.cc:229
LightObject
Definition: LightObject.hh:72
ACG::SceneGraph::LightNode
Definition: LightNode.hh:249
BaseObjectData::cleanup
virtual void cleanup()
Definition: BaseObjectData.cc:102
BaseObjectData.hh
BaseObjectData::pickingEnabled
virtual bool pickingEnabled()
Definition: BaseObjectData.cc:318
TypeLightPlugin
Definition: TypeLight.hh:62
LightTypes.hh
BaseObjectData::setName
virtual void setName(QString _name)
path to the file from which the object is loaded ( defaults to "." )
Definition: BaseObjectData.cc:355
ACG::SceneGraph::LightSource
Structure to hold options for one LightSource.
Definition: LightNode.hh:85
BaseObjectData::enablePicking
virtual void enablePicking(bool _enable)
Definition: BaseObjectData.cc:315
LightObject::defaultLightSource_
bool defaultLightSource_
Definition: LightObject.hh:134
LightObject::lightSource_
LightSource lightSource_
Definition: LightObject.hh:130
LightWidget
Definition: LightWidget.hh:51
ACG::SceneGraph::BaseNode
Definition: BaseNode.hh:104
BaseObject
Definition: BaseObject.hh:82
BaseObject::copy
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:769
BaseObjectData::picked
virtual bool picked(uint _node_idx)
detect if the node has been picked
Definition: BaseObjectData.cc:311
BaseObjectData::visible
virtual bool visible()
return visiblity
Definition: BaseObjectData.cc:206
BaseObjectData
Definition: BaseObjectData.hh:102
BaseObjectData::hide
virtual void hide()
Sets the whole Scenegraph subtree of this node to invisible.
Definition: BaseObjectData.cc:197
LightObject::lightNode_
LightNode * lightNode_
Light status node.
Definition: LightObject.hh:172
LightObject::lightNodeVis_
LightNode * lightNodeVis_
Light rendering node (only for rendering purposes)
Definition: LightObject.hh:175