Class for generic lights. More...

Public Member Functions
	DtLight (void)
	CTOR.
	~DtLight ()
	DTOR.
void	setPosition (const Vector3_64 &vPosition)
	Only relevant to Point and Spot Lights.
const Vector3_64 &	position (void) const
void	setDirection (const Vector3_64 &vDirection)
	Only relevant to Directional and Spot Lights.
const Vector3_64 &	direction (void) const
LightGroup	lightGroup () const
	Which group is this light under (prop, terrain, none)
void	setLightGroup (LightGroup group)
	Set the group this light belongs to (props, terrain, none)
const AxisAlignedBoundingBox_64 &	getWorldAABB (void) const
DtLight &	operator= (const DtLight &rhs)

void	setOn (bool bOn)
	Turn light on or off.
bool	isOn (void) const
	Turn light on or off.

void	setLightType (LightType lightType)
	Turn light on or off This is separate so as to enable pooling of lights so that a previous light of type x in the pool can be picked up and used as a light of a different type y, or the same type for that matter.
LightType	lightType (void) const
	Turn light on or off This is separate so as to enable pooling of lights so that a previous light of type x in the pool can be picked up and used as a light of a different type y, or the same type for that matter.

void	setAmbientColor (const DtColorValue &color)
	Set ambient, diffuse, specular properties.
void	setDiffuseColor (const DtColorValue &color)
	Set ambient, diffuse, specular properties.
void	setSpecularColor (const DtColorValue &color)
	Set ambient, diffuse, specular properties.

const DtColorValue &	ambientColor (void) const
	Get ambient, diffuse, specular properties.
const DtColorValue &	diffuseColor (void) const
	Get ambient, diffuse, specular properties.
const DtColorValue &	specularColor (void) const
	Get ambient, diffuse, specular properties.

void	setRange (float32 fRange)
	Range and Squared Range.
float32	range (void) const
	Range and Squared Range.
float32	squaredRange (void) const
	Range and Squared Range.

void	setAttenuation (float32 fConstant, float32 fLinear, float32 fQuadratic)
	Attenuation properties.
float32	constantAttenuation (void) const
	Attenuation properties.
float32	linearAttenuation (void) const
	Attenuation properties.
float32	quadraticAttenuation (void) const
	Attenuation properties.
void	getAttenuation (float32 attenuations[3]) const
	Attenuation properties.

void	setSpotLightParameters (DtDegrees fInnerAngleDegrees, DtDegrees fOuterAngleDegrees, float32 fFalloff)
	Spot Light properties.
void	setSpotLightAngles (DtDegrees fInnerAngleDegrees, DtDegrees fOuterAngleDegrees)
	Spot Light properties.
void	getSpotLightAngles (DtDegrees &fInnerAngleDegrees, DtDegrees &fOuterAngleDegrees)
	Spot Light properties.
DtDegrees	innerAngle (void) const
	Spot Light properties.
DtDegrees	outerAngle (void) const
	Spot Light properties.
float32	falloff (void) const
	Spot Light properties.

DtUserObjectBindings &	getUserObjectBindings (void)
	User object bindings.
const DtUserObjectBindings &	getUserObjectBindings (void) const
	User object bindings.

void	setUserData (void *pUserData)
	User Data.
void *	userData () const
	User Data.

Static Public Member Functions
static const std::string &	getReservedBindingKey (void)

Public Attributes
float64	myTempValue

Private Member Functions
void	UpdateBounds (void)

Private Attributes
LightType	myLightType
DtColorValue	myAmbientColor
DtColorValue	myDiffuseColor
DtColorValue	mySpecularColor
Vector3_64	myVecPosition
	Applicable only to point lights and spot lights.
Vector3_64	myVecDirection
	Applicable only to directional lights.
float32	myfRange
float32	myfSquaredRange
float32	myfConstantAttenuation
float32	myfLinearAttenuation
float32	myfQuadraticAttenuation
DtDegrees	myfInnerAngle
	Angle of a spotlight's inner cone - that is, the fully illuminated spotlight cone.
DtDegrees	myfOuterAngle
	Angle defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.
float32	myfFallOff
	Decrease in illumination between a spotlight's inner cone and the outer edge of the outer cone.
bool	mybIsOn
DtUserObjectBindings	myUserObjectBindings
void *	myUserData
AxisAlignedBoundingBox_64	myWorldAABB
bool	mySignalsEnabled
bool	myUpdateSignalEnabled
LightGroup	myLightGroup
	For switching on and off lights Is this light node under the DtOsgRenderer::propsRoot or under DtOsgRenderer::terrainRoot.

Static Private Attributes
static const std::string	mystrReservedBinding
LightSignal	signal_LightUpdated
	Light signals.
LightSignal	signal_LightBoundsUpdated
	Light signals.
LightSignal	signal_LightDestroyed
	Light signals.
void	enableSignals (bool enable)
	Light signals.
bool	signalsEnabled (void) const
	Light signals.
void	enableUpdateSignals (bool enable)
	Light signals.

Detailed Description

Class for generic lights.

Constructor & Destructor Documentation

makVrv::DtLight::DtLight ( void )

CTOR.

makVrv::DtLight::~DtLight ( )

DTOR.

Member Function Documentation

void makVrv::DtLight::setOn ( bool bOn )

Turn light on or off.

bool makVrv::DtLight::isOn ( void ) const

inline

Turn light on or off.

void makVrv::DtLight::setLightType ( LightType lightType )

Turn light on or off This is separate so as to enable pooling of lights so that a previous light of type x in the pool can be picked up and used as a light of a different type y, or the same type for that matter.

LightType makVrv::DtLight::lightType ( void ) const

Turn light on or off This is separate so as to enable pooling of lights so that a previous light of type x in the pool can be picked up and used as a light of a different type y, or the same type for that matter.

void makVrv::DtLight::setAmbientColor ( const DtColorValue & color )

Set ambient, diffuse, specular properties.

void makVrv::DtLight::setDiffuseColor ( const DtColorValue & color )

Set ambient, diffuse, specular properties.

void makVrv::DtLight::setSpecularColor ( const DtColorValue & color )

Set ambient, diffuse, specular properties.

const DtColorValue& makVrv::DtLight::ambientColor ( void ) const

Get ambient, diffuse, specular properties.

const DtColorValue& makVrv::DtLight::diffuseColor ( void ) const

Get ambient, diffuse, specular properties.

const DtColorValue& makVrv::DtLight::specularColor ( void ) const

Get ambient, diffuse, specular properties.

void makVrv::DtLight::setPosition ( const Vector3_64 & vPosition )

Only relevant to Point and Spot Lights.

const Vector3_64& makVrv::DtLight::position ( void ) const

void makVrv::DtLight::setDirection ( const Vector3_64 & vDirection )

Only relevant to Directional and Spot Lights.

const Vector3_64& makVrv::DtLight::direction ( void ) const

void makVrv::DtLight::setRange ( float32 fRange )

Range and Squared Range.

float32 makVrv::DtLight::range ( void ) const

Range and Squared Range.

float32 makVrv::DtLight::squaredRange ( void ) const

Range and Squared Range.

void makVrv::DtLight::setAttenuation	(	float32	fConstant,
		float32	fLinear,
		float32	fQuadratic
	)

Attenuation properties.

float32 makVrv::DtLight::constantAttenuation ( void ) const

Attenuation properties.

float32 makVrv::DtLight::linearAttenuation ( void ) const

Attenuation properties.

float32 makVrv::DtLight::quadraticAttenuation ( void ) const

Attenuation properties.

void makVrv::DtLight::getAttenuation ( float32 attenuations[3] ) const

Attenuation properties.

void makVrv::DtLight::setSpotLightParameters	(	DtDegrees	fInnerAngleDegrees,
		DtDegrees	fOuterAngleDegrees,
		float32	fFalloff
	)

Spot Light properties.

void makVrv::DtLight::setSpotLightAngles	(	DtDegrees	fInnerAngleDegrees,
		DtDegrees	fOuterAngleDegrees
	)

Spot Light properties.

void makVrv::DtLight::getSpotLightAngles	(	DtDegrees &	fInnerAngleDegrees,
		DtDegrees &	fOuterAngleDegrees
	)

Spot Light properties.

DtDegrees makVrv::DtLight::innerAngle ( void ) const

Spot Light properties.

DtDegrees makVrv::DtLight::outerAngle ( void ) const

Spot Light properties.

float32 makVrv::DtLight::falloff ( void ) const

Spot Light properties.

DtUserObjectBindings& makVrv::DtLight::getUserObjectBindings ( void )

User object bindings.

const DtUserObjectBindings& makVrv::DtLight::getUserObjectBindings ( void ) const

User object bindings.

void makVrv::DtLight::setUserData ( void * pUserData )

inline

User Data.

void* makVrv::DtLight::userData ( ) const

inline

User Data.

void makVrv::DtLight::enableSignals ( bool enable )

Light signals.

bool makVrv::DtLight::signalsEnabled ( void ) const

Light signals.

void makVrv::DtLight::enableUpdateSignals ( bool enable )

Light signals.

LightGroup makVrv::DtLight::lightGroup ( ) const

Which group is this light under (prop, terrain, none)

void makVrv::DtLight::setLightGroup ( LightGroup group )

Set the group this light belongs to (props, terrain, none)

const AxisAlignedBoundingBox_64& makVrv::DtLight::getWorldAABB ( void ) const

static const std::string& makVrv::DtLight::getReservedBindingKey ( void )

inlinestatic

DtLight& makVrv::DtLight::operator= ( const DtLight & rhs )

void makVrv::DtLight::UpdateBounds ( void )

private

Member Data Documentation

LightSignal makVrv::DtLight::signal_LightUpdated

Light signals.

LightSignal makVrv::DtLight::signal_LightBoundsUpdated

Light signals.

LightSignal makVrv::DtLight::signal_LightDestroyed

Light signals.

float64 makVrv::DtLight::myTempValue

LightType makVrv::DtLight::myLightType

private

DtColorValue makVrv::DtLight::myAmbientColor

private

DtColorValue makVrv::DtLight::myDiffuseColor

private

DtColorValue makVrv::DtLight::mySpecularColor

private

Vector3_64 makVrv::DtLight::myVecPosition

private

Applicable only to point lights and spot lights.

Vector3_64 makVrv::DtLight::myVecDirection

private

Applicable only to directional lights.

float32 makVrv::DtLight::myfRange

private

float32 makVrv::DtLight::myfSquaredRange

private

float32 makVrv::DtLight::myfConstantAttenuation

private

float32 makVrv::DtLight::myfLinearAttenuation

private

float32 makVrv::DtLight::myfQuadraticAttenuation

private

DtDegrees makVrv::DtLight::myfInnerAngle

private

Angle of a spotlight's inner cone - that is, the fully illuminated spotlight cone.

DtDegrees makVrv::DtLight::myfOuterAngle

private

Angle defining the outer edge of the spotlight's outer cone. Points outside this cone are not lit by the spotlight. This value must be between 0 and pi.

float32 makVrv::DtLight::myfFallOff

private

Decrease in illumination between a spotlight's inner cone and the outer edge of the outer cone.

bool makVrv::DtLight::mybIsOn

private

DtUserObjectBindings makVrv::DtLight::myUserObjectBindings

private

void* makVrv::DtLight::myUserData

private

AxisAlignedBoundingBox_64 makVrv::DtLight::myWorldAABB

private

const std::string makVrv::DtLight::mystrReservedBinding

staticprivate

bool makVrv::DtLight::mySignalsEnabled

private

bool makVrv::DtLight::myUpdateSignalEnabled

private

LightGroup makVrv::DtLight::myLightGroup

private

For switching on and off lights Is this light node under the DtOsgRenderer::propsRoot or under DtOsgRenderer::terrainRoot.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvGraphicsUtils/DtLight.h

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation