class SG_EXPORT osg::Light: public Object

Light state class which encapsulates OpenGL glLight() functionality

Inheritance:

Public Methods

Light()

static Light* instance()

return a static instance of an osg::Light, to be used as prototype for loading lights

virtual Object* clone() const

return a shallow copy of a node, with Object* return type

virtual bool isSameKindAs(Object* obj)

virtual const char* className() const

return the name of the node's class type

void on( void )

Turn the light on.

void off( void )

Turn the light off.

static void enable( void )

Enable OpenGL's Lighting mode.

static void disable( void )

Disable OpenGL's Lighting mode.

void apply( void )

Apply the light's state to the OpenGL state machine.

void setAmbient( const Vec4& ambient )

Set the ambient component of the light.

const Vec4& getAmbient() const

Get the ambient component of the light.

void setDiffuse( const Vec4& diffuse )

Set the diffuse component of the light.

const Vec4& getDiffuse() const

Get the diffuse component of the light.

void setSpecular( const Vec4& specular )

Set the specular component of the light.

const Vec4& getSpecular() const

Get the specular component of the light.

void setPosition( const Vec4& position )

Set the position of the light.

const Vec4& getPosition() const

Get the position of the light.

void setDirection( const Vec3& direction )

Set the direction of the light.

const Vec3& getDirection() const

Get the direction of the light.

void setConstantAttenuation( float constant_attenuation )

Set the constant attenuation of the light.

float setConstantAttenuation() const

Get the constant attenuation of the light.

void setLinearAttenuation( float linear_attenuation )

Set the linear attenuation of the light.

float getLinearAttenuation() const

Get the linear attenuation of the light.

void setQuadraticAttenuation( float quadratic_attenuation )

Set the quadratic attenuation of the light.

float getQuadraticAttenuation() const

Get the quadratic attenuation of the light.

void setSpotExponent( float spot_exponent )

Set the spot exponent of the light.

float getSpotExponent() const

Get the spot exponent of the light.

void setSpotCutoff( float spot_cutoff )

Set the spot cutoff of the light.

float getSpotCutoff()

Get the spot cutoff of the light.

void captureLightState()

Capture the lighting settings of the current OpenGL state and store them in this object

Protected Fields

int _lightnum

bool _on

Vec4 _ambient

Vec4 _diffuse

Vec4 _specular

Vec4 _position

Vec3 _direction

float _constant_attenuation

float _linear_attenuation

float _quadratic_attenuation

float _spot_exponent

float _spot_cutoff

static int _currentLightNum

Protected Methods

virtual ~Light( void )

void init( void )

Initialize the light's settings with some decent defaults.

Inherited from Object:

Public Methods

virtual Object* readClone(Input& fr)

virtual bool write(Output& fw)

Protected Methods

virtual bool readLocalData(Input&)

virtual bool writeLocalData(Output&)

Inherited from Referenced:

Public Methods

Referenced& operator = (Referenced&)

void ref()

void unref()

int referenceCount()

Protected Fields

int _refCount

Light()

static Light* instance()

return a static instance of an osg::Light, to be used as prototype for loading lights

virtual Object* clone() const

return a shallow copy of a node, with Object* return type

virtual bool isSameKindAs(Object* obj)

virtual const char* className() const

return the name of the node's class type

void on( void )

Turn the light on. Calling this method doesn't directly affect OpenGL's lighting mode.

void off( void )

Turn the light off. Calling this method doesn't directly affect OpenGL's lighting mode.

static void enable( void )

Enable OpenGL's Lighting mode.

static void disable( void )

Disable OpenGL's Lighting mode.

void apply( void )

Apply the light's state to the OpenGL state machine.

void setAmbient( const Vec4& ambient )

Set the ambient component of the light.

const Vec4& getAmbient() const

Get the ambient component of the light.

void setDiffuse( const Vec4& diffuse )

Set the diffuse component of the light.

const Vec4& getDiffuse() const

Get the diffuse component of the light.

void setSpecular( const Vec4& specular )

Set the specular component of the light.

const Vec4& getSpecular() const

Get the specular component of the light.

void setPosition( const Vec4& position )

Set the position of the light.

const Vec4& getPosition() const

Get the position of the light.

void setDirection( const Vec3& direction )

Set the direction of the light.

const Vec3& getDirection() const

Get the direction of the light.

void setConstantAttenuation( float constant_attenuation )

Set the constant attenuation of the light.

float setConstantAttenuation() const

Get the constant attenuation of the light.

void setLinearAttenuation( float linear_attenuation )

Set the linear attenuation of the light.

float getLinearAttenuation() const

Get the linear attenuation of the light.

void setQuadraticAttenuation( float quadratic_attenuation )

Set the quadratic attenuation of the light.

float getQuadraticAttenuation() const

Get the quadratic attenuation of the light.

void setSpotExponent( float spot_exponent )

Set the spot exponent of the light.

float getSpotExponent() const

Get the spot exponent of the light.

void setSpotCutoff( float spot_cutoff )

Set the spot cutoff of the light.

float getSpotCutoff()

Get the spot cutoff of the light.

void captureLightState()

Capture the lighting settings of the current OpenGL state and store them in this object

virtual ~Light( void )

void init( void )

Initialize the light's settings with some decent defaults.

int _lightnum

bool _on

Vec4 _ambient

Vec4 _diffuse

Vec4 _specular

Vec4 _position

Vec3 _direction

float _constant_attenuation

float _linear_attenuation

float _quadratic_attenuation

float _spot_exponent

float _spot_cutoff

static int _currentLightNum

Alphabetic index HTML hierarchy of classes or Java