Light state class which encapsulates OpenGL glLight() functionality. More...

Inheritance diagram for osg::Light:

Public Member Functions
	Light ()

	Light (unsigned int lightnum)

	Light (const Light &light, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

virtual osg::Object *	cloneType () const
	Clone the type of an attribute, with Object* return type. More...

virtual osg::Object *	clone (const osg::CopyOp &copyop) const
	Clone an attribute, with Object* return type. More...

virtual bool	isSameKindAs (const osg::Object *obj) const
	Return true if this and obj are of the same kind of object. More...

virtual const char *	libraryName () const
	Return the name of the attribute's library. More...

virtual const char *	className () const
	Return the name of the attribute's class type. More...

virtual Type	getType () const
	Return the Type identifier of the attribute's class type. More...

virtual int	compare (const StateAttribute &sa) const
	Return -1 if this < rhs, 0 if this==rhs, 1 if this>rhs. More...

virtual unsigned int	getMember () const
	Return the member identifier within the attribute's class type. More...

virtual bool	getModeUsage (StateAttribute::ModeUsage &usage) const
	Return the modes associated with this StateAttribute. More...

void	setLightNum (int num)
	Set which OpenGL light to operate on. More...

int	getLightNum () const
	Get which OpenGL light this osg::Light operates on. More...

void	setAmbient (const Vec4 &ambient)
	Set the ambient component of the light. More...

const Vec4 &	getAmbient () const
	Get the ambient component of the light. More...

void	setDiffuse (const Vec4 &diffuse)
	Set the diffuse component of the light. More...

const Vec4 &	getDiffuse () const
	Get the diffuse component of the light. More...

void	setSpecular (const Vec4 &specular)
	Set the specular component of the light. More...

const Vec4 &	getSpecular () const
	Get the specular component of the light. More...

void	setPosition (const Vec4 &position)
	Set the position of the light. More...

const Vec4 &	getPosition () const
	Get the position of the light. More...

void	setDirection (const Vec3 &direction)
	Set the direction of the light. More...

const Vec3 &	getDirection () const
	Get the direction of the light. More...

void	setConstantAttenuation (float constant_attenuation)
	Set the constant attenuation of the light. More...

float	getConstantAttenuation () const
	Get the constant attenuation of the light. More...

void	setLinearAttenuation (float linear_attenuation)
	Set the linear attenuation of the light. More...

float	getLinearAttenuation () const
	Get the linear attenuation of the light. More...

void	setQuadraticAttenuation (float quadratic_attenuation)
	Set the quadratic attenuation of the light. More...

float	getQuadraticAttenuation () const
	Get the quadratic attenuation of the light. More...

void	setSpotExponent (float spot_exponent)
	Set the spot exponent of the light. More...

float	getSpotExponent () const
	Get the spot exponent of the light. More...

void	setSpotCutoff (float spot_cutoff)
	Set the spot cutoff of the light. More...

float	getSpotCutoff () const
	Get the spot cutoff of the light. More...

void	captureLightState ()
	Capture the lighting settings of the current OpenGL state and store them in this object. More...

virtual void	apply (State &state) const
	Apply the light's state to the OpenGL state machine. More...

Public Member Functions inherited from osg::StateAttribute
	StateAttribute ()

	StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Texture *	asTexture ()
	Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...

virtual const Texture *	asTexture () const
	Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...

TypeMemberPair	getTypeMemberPair () const
	Return the TypeMemberPair that uniquely identifies this type member. More...

virtual bool	isTextureAttribute () const
	Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit. More...

bool	operator< (const StateAttribute &rhs) const

bool	operator== (const StateAttribute &rhs) const

bool	operator!= (const StateAttribute &rhs) const

const ParentList &	getParents () const
	Get the parent list of this StateAttribute. More...

StateSet *	getParent (unsigned int i)

const StateSet *	getParent (unsigned int i) const
	Get a single const parent of this StateAttribute. More...

unsigned int	getNumParents () const
	Get the number of parents of this StateAttribute. More...

void	setShaderComponent (ShaderComponent *sc)

ShaderComponent *	getShaderComponent ()

const ShaderComponent *	getShaderComponent () const

virtual bool	checkValidityOfAssociatedModes (osg::State &) const
	Check the modes associated with this StateAttribute are supported by current OpenGL drivers, and if not set the associated mode in osg::State to be black listed/invalid. More...

void	setUpdateCallback (StateAttributeCallback *uc)
	Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. More...

StateAttributeCallback *	getUpdateCallback ()
	Get the non const UpdateCallback. More...

const StateAttributeCallback *	getUpdateCallback () const
	Get the const UpdateCallback. More...

void	setEventCallback (StateAttributeCallback *ec)
	Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. More...

StateAttributeCallback *	getEventCallback ()
	Get the non const EventCallback. More...

const StateAttributeCallback *	getEventCallback () const
	Get the const EventCallback. More...

virtual void	compileGLObjects (State &) const
	Default to nothing to compile - all state is applied immediately. More...

virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (State *=0) const
	Release OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objects for all graphics context if State object pointer NULL. More...

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template More...

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Protected Member Functions
virtual	~Light ()

void	init ()
	Initialize the light's settings with some decent defaults. More...

Protected Member Functions inherited from osg::StateAttribute
virtual	~StateAttribute ()

void	addParent (osg::StateSet *object)

void	removeParent (osg::StateSet *object)

Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...

Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()

void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

Protected Attributes
int	_lightnum

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

Protected Attributes inherited from osg::StateAttribute
ParentList	_parents

ref_ptr< ShaderComponent >	_shaderComponent

ref_ptr< StateAttributeCallback >	_updateCallback

ref_ptr< StateAttributeCallback >	_eventCallback

Protected Attributes inherited from osg::Object
std::string	_name

DataVariance	_dataVariance

osg::UserDataContainer *	_userDataContainer

Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet

OpenThreads::Atomic	_refCount

Additional Inherited Members
Public Types inherited from osg::StateAttribute
enum	Values { OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4, INHERIT = 0x8 }
	list values which can be used to set either GLModeValues or OverrideValues. More...

enum	Type { TEXTURE, POLYGONMODE, POLYGONOFFSET, MATERIAL, ALPHAFUNC, ANTIALIAS, COLORTABLE, CULLFACE, FOG, FRONTFACE, LIGHT, POINT, LINEWIDTH, LINESTIPPLE, POLYGONSTIPPLE, SHADEMODEL, TEXENV, TEXENVFILTER, TEXGEN, TEXMAT, LIGHTMODEL, BLENDFUNC, BLENDEQUATION, LOGICOP, STENCIL, COLORMASK, DEPTH, VIEWPORT, SCISSOR, BLENDCOLOR, MULTISAMPLE, CLIPPLANE, COLORMATRIX, VERTEXPROGRAM, FRAGMENTPROGRAM, POINTSPRITE, PROGRAM, CLAMPCOLOR, HINT, SAMPLEMASKI, PRIMITIVERESTARTINDEX, CLIPCONTROL, VALIDATOR, VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM, OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER, UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING, ATOMICCOUNTERBUFFERBINDING, PATCH_PARAMETER, FRAME_BUFFER_OBJECT, VERTEX_ATTRIB_DIVISOR, SHADERSTORAGEBUFFERBINDING, CAPABILITY = 100 }
	Type identifier to differentiate between different state types. More...

typedef GLenum	GLMode
	GLMode is the value used in glEnable/glDisable(mode) More...

typedef unsigned int	GLModeValue
	GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF). More...

typedef unsigned int	OverrideValue
	Override is used to specify the override behavior of StateAttributes from parent to children. More...

typedef std::pair< Type, unsigned int >	TypeMemberPair
	Simple pairing between an attribute type and the member within that attribute type group. More...

typedef std::vector< StateSet * >	ParentList
	A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute. More...

typedef osg::StateAttributeCallback	Callback

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Detailed Description

Light state class which encapsulates OpenGL glLight() functionality.

Constructor & Destructor Documentation

osg::Light::Light ( )

osg::Light::Light ( unsigned int lightnum )

osg::Light::Light	(	const Light &	light,
		const CopyOp &	copyop = `CopyOp::SHALLOW_COPY`
	)

inline

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Light::~Light ( )

protectedvirtual

Member Function Documentation

virtual void osg::Light::apply ( State & state ) const

virtual

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

Reimplemented from osg::StateAttribute.

void osg::Light::captureLightState ( )

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

virtual const char* osg::Light::className ( ) const

inlinevirtual

Return the name of the attribute's class type.

Reimplemented from osg::StateAttribute.

virtual osg::Object* osg::Light::clone ( const osg::CopyOp & ) const

inlinevirtual

Clone an attribute, with Object* return type.

Must be defined by derived classes.

Implements osg::StateAttribute.

virtual osg::Object* osg::Light::cloneType ( ) const

inlinevirtual

Clone the type of an attribute, with Object* return type.

Must be defined by derived classes.

Implements osg::StateAttribute.

virtual int osg::Light::compare ( const StateAttribute & sa ) const

inlinevirtual

Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

const Vec4& osg::Light::getAmbient ( ) const

inline

Get the ambient component of the light.

float osg::Light::getConstantAttenuation ( ) const

inline

Get the constant attenuation of the light.

const Vec4& osg::Light::getDiffuse ( ) const

inline

Get the diffuse component of the light.

const Vec3& osg::Light::getDirection ( ) const

inline

Get the direction of the light.

int osg::Light::getLightNum ( ) const

inline

Get which OpenGL light this osg::Light operates on.

float osg::Light::getLinearAttenuation ( ) const

inline

Get the linear attenuation of the light.

virtual unsigned int osg::Light::getMember ( ) const

inlinevirtual

Return the member identifier within the attribute's class type.

Used for light number/clip plane number etc.

Reimplemented from osg::StateAttribute.

virtual bool osg::Light::getModeUsage ( StateAttribute::ModeUsage & ) const

inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

const Vec4& osg::Light::getPosition ( ) const

inline

Get the position of the light.

float osg::Light::getQuadraticAttenuation ( ) const

inline

Get the quadratic attenuation of the light.

const Vec4& osg::Light::getSpecular ( ) const

inline

Get the specular component of the light.

float osg::Light::getSpotCutoff ( ) const

inline

Get the spot cutoff of the light.

float osg::Light::getSpotExponent ( ) const

inline

Get the spot exponent of the light.

virtual Type osg::Light::getType ( ) const

inlinevirtual

Return the Type identifier of the attribute's class type.

Implements osg::StateAttribute.

void osg::Light::init ( )

protected

Initialize the light's settings with some decent defaults.

virtual bool osg::Light::isSameKindAs ( const osg::Object * obj ) const

inlinevirtual

Return true if this and obj are of the same kind of object.

Reimplemented from osg::StateAttribute.

virtual const char* osg::Light::libraryName ( ) const

inlinevirtual

Return the name of the attribute's library.

Reimplemented from osg::StateAttribute.

void osg::Light::setAmbient ( const Vec4 & ambient )

inline

Set the ambient component of the light.

void osg::Light::setConstantAttenuation ( float constant_attenuation )

inline

Set the constant attenuation of the light.

void osg::Light::setDiffuse ( const Vec4 & diffuse )

inline

Set the diffuse component of the light.

void osg::Light::setDirection ( const Vec3 & direction )

inline

Set the direction of the light.

void osg::Light::setLightNum ( int num )

Set which OpenGL light to operate on.

void osg::Light::setLinearAttenuation ( float linear_attenuation )

inline

Set the linear attenuation of the light.

void osg::Light::setPosition ( const Vec4 & position )

inline

Set the position of the light.

void osg::Light::setQuadraticAttenuation ( float quadratic_attenuation )

inline

Set the quadratic attenuation of the light.

void osg::Light::setSpecular ( const Vec4 & specular )

inline

Set the specular component of the light.

void osg::Light::setSpotCutoff ( float spot_cutoff )

inline

Set the spot cutoff of the light.

void osg::Light::setSpotExponent ( float spot_exponent )

inline

Set the spot exponent of the light.

Member Data Documentation

Vec4 osg::Light::_ambient

protected

float osg::Light::_constant_attenuation

protected

Vec4 osg::Light::_diffuse

protected

Vec3 osg::Light::_direction

protected

int osg::Light::_lightnum

protected

float osg::Light::_linear_attenuation

protected

Vec4 osg::Light::_position

protected

float osg::Light::_quadratic_attenuation

protected

Vec4 osg::Light::_specular

protected

float osg::Light::_spot_cutoff

protected

float osg::Light::_spot_exponent

protected

The documentation for this class was generated from the following file:

osg/Light

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation