openscenegraph
Light
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_LIGHT
15#define OSG_LIGHT 1
16
17#include <osg/StateAttribute>
18#include <osg/Vec3>
19#include <osg/Vec4>
20
21#ifndef GL_LIGHT0
22 #define GL_LIGHT0 0x4000
23 #define GL_LIGHT1 0x4001
24 #define GL_LIGHT2 0x4002
25 #define GL_LIGHT3 0x4003
26 #define GL_LIGHT4 0x4004
27 #define GL_LIGHT5 0x4005
28 #define GL_LIGHT6 0x4006
29 #define GL_LIGHT7 0x4007
30#endif
31
32#ifndef GL_LIGHTING
33 #define GL_LIGHTING 0x0B50
34#endif
35
36namespace osg {
37
40{
41 public :
42
44
45 Light(unsigned int lightnum);
46
48 Light(const Light& light,const CopyOp& copyop=CopyOp::SHALLOW_COPY):
49 StateAttribute(light,copyop),
50 _lightnum(light._lightnum),
51 _ambient(light._ambient),
52 _diffuse(light._diffuse),
53 _specular(light._specular),
54 _position(light._position),
55 _direction(light._direction),
56 _constant_attenuation(light._constant_attenuation),
57 _linear_attenuation(light._linear_attenuation),
58 _quadratic_attenuation(light._quadratic_attenuation),
59 _spot_exponent(light._spot_exponent),
60 _spot_cutoff(light._spot_cutoff) {}
61
62 virtual osg::Object* cloneType() const { return new Light(_lightnum); }
63 virtual osg::Object* clone(const osg::CopyOp& copyop) const { return new Light(*this,copyop); }
64 virtual bool isSameKindAs(const osg::Object* obj) const { return dynamic_cast<const Light *>(obj)!=NULL; }
65 virtual const char* libraryName() const { return "osg"; }
66 virtual const char* className() const { return "Light"; }
67 virtual Type getType() const { return LIGHT; }
68
70 virtual int compare(const StateAttribute& sa) const
71 {
72 // check the types are equal and then create the rhs variable
73 // used by the COMPARE_StateAttribute_Parameter macros below.
75
76 // compare each parameter in turn against the rhs.
83 COMPARE_StateAttribute_Parameter(_constant_attenuation)
84 COMPARE_StateAttribute_Parameter(_linear_attenuation)
85 COMPARE_StateAttribute_Parameter(_quadratic_attenuation)
88
89 return 0; // passed all the above comparison macros, must be equal.
90 }
91
92 virtual unsigned int getMember() const { return _lightnum; }
93
94 virtual bool getModeUsage(StateAttribute::ModeUsage& usage) const
95 {
96 usage.usesMode(GL_LIGHT0+_lightnum);
97 return true;
98 }
99
100
101
103 void setLightNum(int num);
104
106 int getLightNum() const { return _lightnum; }
107
109 inline void setAmbient( const Vec4& ambient ) { _ambient = ambient; }
110
112 inline const Vec4& getAmbient() const { return _ambient; }
113
115 inline void setDiffuse( const Vec4& diffuse ) { _diffuse = diffuse; }
116
118 inline const Vec4& getDiffuse() const { return _diffuse; }
119
121 inline void setSpecular( const Vec4& specular ) { _specular = specular; }
122
124 inline const Vec4& getSpecular() const { return _specular; }
125
127 inline void setPosition( const Vec4& position ) { _position = position; }
128
130 inline const Vec4& getPosition() const { return _position; }
131
133 inline void setDirection( const Vec3& direction ) { _direction = direction; }
134
136 inline const Vec3& getDirection() const { return _direction; }
137
139 inline void setConstantAttenuation( float constant_attenuation ) { _constant_attenuation = constant_attenuation; }
140
142 inline float getConstantAttenuation() const { return _constant_attenuation; }
143
145 inline void setLinearAttenuation ( float linear_attenuation ) { _linear_attenuation = linear_attenuation; }
146
148 inline float getLinearAttenuation () const { return _linear_attenuation; }
149
151 inline void setQuadraticAttenuation ( float quadratic_attenuation ) { _quadratic_attenuation = quadratic_attenuation; }
152
154 inline float getQuadraticAttenuation() const { return _quadratic_attenuation; }
155
157 inline void setSpotExponent( float spot_exponent ) { _spot_exponent = spot_exponent; }
158
160 inline float getSpotExponent() const { return _spot_exponent; }
161
163 inline void setSpotCutoff( float spot_cutoff ) { _spot_cutoff = spot_cutoff; }
164
166 inline float getSpotCutoff() const { return _spot_cutoff; }
167
172
174 virtual void apply(State& state) const;
175
176 protected :
177
178 virtual ~Light();
179
181 void init();
182
183 int _lightnum; // OpenGL light number
184
185 Vec4 _ambient; // r, g, b, w
186 Vec4 _diffuse; // r, g, b, w
187 Vec4 _specular; // r, g, b, w
188 Vec4 _position; // x, y, z, w
189 Vec3 _direction; // x, y, z
190 float _constant_attenuation; // constant
191 float _linear_attenuation; // linear
192 float _quadratic_attenuation; // quadratic
193 float _spot_exponent; // exponent
194 float _spot_cutoff; // spread
195};
196
197}
198
199#endif
#define GL_LIGHT0
Definition Light:22
#define COMPARE_StateAttribute_Parameter(parameter)
Definition StateAttribute:69
#define COMPARE_StateAttribute_Types(TYPE, rhs_attribute)
Definition StateAttribute:57
Definition CopyOp:41
Definition Light:40
virtual ~Light()
void setAmbient(const Vec4 &ambient)
Definition Light:109
const Vec4 & getAmbient() const
Definition Light:112
Vec4 _position
Definition Light:188
float getSpotExponent() const
Definition Light:160
float _spot_cutoff
Definition Light:194
void setLinearAttenuation(float linear_attenuation)
Definition Light:145
void setSpotCutoff(float spot_cutoff)
Definition Light:163
float _linear_attenuation
Definition Light:191
virtual int compare(const StateAttribute &sa) const
Definition Light:70
virtual osg::Object * cloneType() const
Definition Light:62
Vec3 _direction
Definition Light:189
const Vec4 & getDiffuse() const
Definition Light:118
float _quadratic_attenuation
Definition Light:192
const Vec3 & getDirection() const
Definition Light:136
virtual const char * className() const
Definition Light:66
float getSpotCutoff() const
Definition Light:166
void setSpotExponent(float spot_exponent)
Definition Light:157
float getQuadraticAttenuation() const
Definition Light:154
void init()
float _constant_attenuation
Definition Light:190
void setDirection(const Vec3 &direction)
Definition Light:133
int _lightnum
Definition Light:183
float getConstantAttenuation() const
Definition Light:142
virtual Type getType() const
Definition Light:67
Light(unsigned int lightnum)
void setQuadraticAttenuation(float quadratic_attenuation)
Definition Light:151
Vec4 _ambient
Definition Light:185
virtual void apply(State &state) const
virtual bool getModeUsage(StateAttribute::ModeUsage &usage) const
Definition Light:94
int getLightNum() const
Definition Light:106
virtual unsigned int getMember() const
Definition Light:92
virtual const char * libraryName() const
Definition Light:65
virtual osg::Object * clone(const osg::CopyOp &copyop) const
Definition Light:63
virtual bool isSameKindAs(const osg::Object *obj) const
Definition Light:64
void setLightNum(int num)
void captureLightState()
float _spot_exponent
Definition Light:193
void setSpecular(const Vec4 &specular)
Definition Light:121
const Vec4 & getPosition() const
Definition Light:130
const Vec4 & getSpecular() const
Definition Light:124
float getLinearAttenuation() const
Definition Light:148
Light(const Light &light, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
Definition Light:48
void setPosition(const Vec4 &position)
Definition Light:127
Vec4 _specular
Definition Light:187
void setDiffuse(const Vec4 &diffuse)
Definition Light:115
Vec4 _diffuse
Definition Light:186
void setConstantAttenuation(float constant_attenuation)
Definition Light:139
Definition Object:61
Definition StateAttribute:77
Type
Definition StateAttribute:124
Definition State:80
Definition Vec3f:29
Definition Vec4f:28
author: Julien Valentin 2017 (mp3butcher@hotmail.com)
Definition AlphaFunc:19
#define NULL
Definition osg/Export:55
#define OSG_EXPORT
Definition osg/Export:39
Definition StateAttribute:308
virtual void usesMode(GLMode mode)=0