osg::LightSource Class Reference

Inheritance diagram for osg::LightSource:


Public Types
	RELATIVE_RF
	ABSOLUTE_RF
enum	ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF }
Public Member Functions
	LightSource ()
	LightSource (const LightSource &ls, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	META_Node (osg, LightSource)
void	setReferenceFrame (ReferenceFrame rf)
ReferenceFrame	getReferenceFrame () const
void	setLight (Light *light)
Light *	getLight ()
const Light *	getLight () const
void	setStateSetModes (StateSet &, StateAttribute::GLModeValue) const
void	setLocalStateSetModes (StateAttribute::GLModeValue value=StateAttribute::ON)
virtual BoundingSphere	computeBound () const
Protected Member Functions
virtual	~LightSource ()
Protected Attributes
StateAttribute::GLModeValue	_value
ref_ptr< Light >	_light
ReferenceFrame	_referenceFrame

Detailed Description

Leaf Node for defining a light in the scene.

Member Enumeration Documentation

enum osg::LightSource::ReferenceFrame

Enumerator:

RELATIVE_RF
ABSOLUTE_RF

Constructor & Destructor Documentation

osg::LightSource::LightSource ( )

osg::LightSource::LightSource	(	const LightSource &	ls,
		const CopyOp &	copyop = `CopyOp::SHALLOW_COPY`
	)			`[inline]`

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::LightSource::~LightSource ( ) [protected, virtual]

Member Function Documentation

virtual BoundingSphere osg::LightSource::computeBound ( ) const [virtual]

Compute the bounding sphere around Node's geometry or children. This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Group.

const Light* osg::LightSource::getLight ( ) const [inline]

Get the const attached light.

Light* osg::LightSource::getLight ( ) [inline]

Get the attached light.

ReferenceFrame osg::LightSource::getReferenceFrame ( ) const [inline]

osg::LightSource::META_Node	(	osg	,
		LightSource
	)

void osg::LightSource::setLight ( Light * light )

Set the attached light.

void osg::LightSource::setLocalStateSetModes ( StateAttribute::GLModeValue value = StateAttribute::ON )

Set up the local StateSet.

void osg::LightSource::setReferenceFrame ( ReferenceFrame rf )

Set the light sources's ReferenceFrame, either to be relative to its parent reference frame, or relative to an absolute coordinate frame. RELATIVE_RF is the default. Note: setting the ReferenceFrame to be ABSOLUTE_RF will also set the CullingActive flag on the light source, and hence all of its parents, to false, thereby disabling culling of it and all its parents. This is necessary to prevent inappropriate culling, but may impact cull times if the absolute light source is deep in the scene graph. It is therefore recommended to only use absolute light source at the top of the scene.