makVrv::DtLight Class Reference

Class for generic lights This holds per-light data such as range, attenuation factors, colors, etc. More...

Public Member Functions
	DtLight (DtLightManager *lightManager)
	CTOR. More...
virtual	~DtLight ()
	DTOR. More...
DtLight &	operator= (const DtLight &rhs)
	assignment More...
virtual void	setPosition (const Vector3_64 &vPosition)
	Only relevant to Point and Spot Lights. More...
virtual const Vector3_64 &	position (void) const
virtual void	setDirection (const Vector3_64 &vDirection)
	Only relevant to Directional and Spot Lights. More...
virtual const Vector3_64 &	direction (void) const
virtual LightGroup	lightGroup () const
	Which group is this light under (prop, terrain, none) More...
virtual void	setLightGroup (LightGroup group)
	Set the group this light belongs to (props, terrain, none) More...
virtual const AxisAlignedBoundingBox_64 &	worldAABB (void) const
	Get the world AABB. More...
virtual bool	isInitted () const
	initialized? More...
virtual void	setLightSourceTypeId (unsigned int lightSourceTypeId)
	set the light source type id which is used by the light manager to know what type of light source this is. More...
virtual unsigned int	lightSourceTypeId () const
	get the light source type id More...
virtual void	printDetails (void) const
	print details More...
virtual void	setUserValue (float64 val)
	arbitrary value on this light (like user data) More...
virtual float64	userValue (void) const
	arbitrary value on this light (like user data) More...
virtual void	setOn (bool bOn)
	Turn light on or off. More...
virtual bool	isOn (void) const
virtual 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. More...
virtual LightType	lightType (void) const
virtual void	setAmbientColor (const DtColorValue &color)
	Set ambient, diffuse, specular properties. More...
virtual void	setDiffuseColor (const DtColorValue &color)
virtual void	setSpecularColor (const DtColorValue &color)
virtual const DtColorValue &	ambientColor (void) const
	Get ambient, diffuse, specular properties. More...
virtual const DtColorValue &	diffuseColor (void) const
virtual const DtColorValue &	specularColor (void) const
virtual void	setRange (float32 fRange)
	Range and Squared Range. More...
virtual float32	range (void) const
virtual float32	squaredRange (void) const
virtual void	setAttenuation (float32 fConstant, float32 fLinear, float32 fQuadratic)
	Attenuation properties. More...
virtual float32	constantAttenuation (void) const
virtual float32	linearAttenuation (void) const
virtual float32	quadraticAttenuation (void) const
virtual void	getAttenuation (float32 attenuations[3]) const
virtual void	setSpotLightParameters (const DtDegrees &fInnerAngleDegrees, const DtDegrees &fOuterAngleDegrees, float32 fFalloff)
	Spot Light properties. More...
virtual void	setSpotLightAngles (const DtDegrees &fInnerAngleDegrees, const DtDegrees &fOuterAngleDegrees)
virtual void	spotLightAngles (DtDegrees &fInnerAngleDegrees, DtDegrees &fOuterAngleDegrees)
virtual DtDegrees	innerAngle (void) const
virtual DtDegrees	outerAngle (void) const
virtual float32	falloff (void) const
virtual DtUserObjectBindings &	userObjectBindings (void)
	User object bindings. More...
virtual const DtUserObjectBindings &	userObjectBindings (void) const
virtual void	setOctreeNode (void *pUserData)
	octree Data More...
virtual void *	octreeNode () const

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

Protected Member Functions
virtual void	getArbitraryBasisVectors (Vector3_64 &vBasis0, Vector3_64 &vBasis1) const
	Calculate two arbitrary basis vectors for the light direction. More...
virtual void	getArbitraryBasisPoints (float distance, std::array< Vector3_64, 4 > &point) const
	Calculate basis points along arbitrary basis vectors with given distance. More...
virtual float	getAngleFactor () const
	Calculate angle multiplicative factor (see comment in C++) More...
virtual Vector3_64	getSpotCenter () const
	Return the center of the distant side of the spotlight cone. More...
virtual void	UpdateBounds (void)
	update bounds More...

Protected Attributes
LightType	myLightType
DtColorValue	myAmbientColor
DtColorValue	myDiffuseColor
DtColorValue	mySpecularColor
Vector3_64	myVecPosition
	Applicable only to point lights and spot lights. More...
Vector3_64	myVecDirection
	Applicable only to directional lights. More...
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. More...
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. More...
float32	myfFallOff
	Decrease in illumination between a spotlight's inner cone and the outer edge of the outer cone. More...
bool	mybIsOn
bool	mybIsInitted
	init bit to keep track if it's really safe to add to the octtree More...
DtUserObjectBindings	myUserObjectBindings
void *	myOctreeNode
AxisAlignedBoundingBox_64	myWorldAABB
LightGroup	myLightGroup
	For switching on and off lights Is this light node under the DtOsgRenderer::propsRoot or under DtOsgRenderer::terrainRoot. More...
DtLightManager *	myLightManager
unsigned int	myLightSourceTypeId
float64	myUserValue

Static Protected Attributes
static const std::string	theStrReservedBinding

Private Member Functions
	DtLight ()=delete
	not allowed More...
	DtLight (const DtLight &rhs)=delete
	not allowed More...

Friends
class	DtLightScreenSpaceData

Detailed Description

Class for generic lights This holds per-light data such as range, attenuation factors, colors, etc.

Constructor & Destructor Documentation

makVrv::DtLight::DtLight

(

DtLightManager *

lightManager

)

CTOR.

virtual makVrv::DtLight::~DtLight ( )

virtual

DTOR.

makVrv::DtLight::DtLight ( )

privatedelete

not allowed

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

privatedelete

not allowed

Member Function Documentation

DtLight& makVrv::DtLight::operator=

(

const DtLight &

rhs

)

assignment

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

virtual

Turn light on or off.

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

virtual

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

virtual

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.

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

virtual

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

virtual

Set ambient, diffuse, specular properties.

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

virtual

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

virtual

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

virtual

Get ambient, diffuse, specular properties.

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

virtual

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

virtual

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

virtual

Only relevant to Point and Spot Lights.

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

virtual

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

virtual

Only relevant to Directional and Spot Lights.

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

virtual

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

virtual

Range and Squared Range.

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

virtual

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

virtual

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

virtual

Attenuation properties.

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

Spot Light properties.

virtual void makVrv::DtLight::setSpotLightAngles ( const DtDegrees &  fInnerAngleDegrees, const DtDegrees &  fOuterAngleDegrees  )

virtual

virtual void makVrv::DtLight::spotLightAngles ( DtDegrees &  fInnerAngleDegrees, DtDegrees &  fOuterAngleDegrees  )

virtual

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

virtual

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

virtual

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

virtual

virtual DtUserObjectBindings& makVrv::DtLight::userObjectBindings ( void  )

virtual

User object bindings.

virtual const DtUserObjectBindings& makVrv::DtLight::userObjectBindings ( void  ) const

virtual

virtual void makVrv::DtLight::setOctreeNode ( void *  pUserData )

virtual

octree Data

virtual void* makVrv::DtLight::octreeNode ( ) const

virtual

virtual LightGroup makVrv::DtLight::lightGroup ( ) const

virtual

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

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

virtual

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

virtual const AxisAlignedBoundingBox_64& makVrv::DtLight::worldAABB ( void  ) const

virtual

Get the world AABB.

virtual bool makVrv::DtLight::isInitted ( ) const

virtual

initialized?

virtual void makVrv::DtLight::setLightSourceTypeId ( unsigned int  lightSourceTypeId )

virtual

set the light source type id which is used by the light manager to know what type of light source this is.

virtual unsigned int makVrv::DtLight::lightSourceTypeId ( ) const

virtual

get the light source type id

virtual void makVrv::DtLight::printDetails ( void  ) const

virtual

print details

virtual void makVrv::DtLight::setUserValue ( float64  val )

virtual

arbitrary value on this light (like user data)

virtual float64 makVrv::DtLight::userValue ( void  ) const

virtual

arbitrary value on this light (like user data)

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

static

virtual void makVrv::DtLight::getArbitraryBasisVectors ( Vector3_64 &  vBasis0, Vector3_64 &  vBasis1  ) const

protectedvirtual

Calculate two arbitrary basis vectors for the light direction.

virtual void makVrv::DtLight::getArbitraryBasisPoints ( float  distance, std::array< Vector3_64, 4 > &  point  ) const

protectedvirtual

Calculate basis points along arbitrary basis vectors with given distance.

virtual float makVrv::DtLight::getAngleFactor ( ) const

protectedvirtual

Calculate angle multiplicative factor (see comment in C++)

virtual Vector3_64 makVrv::DtLight::getSpotCenter ( ) const

protectedvirtual

Return the center of the distant side of the spotlight cone.

virtual void makVrv::DtLight::UpdateBounds ( void  )

protectedvirtual

update bounds

Friends And Related Function Documentation

friend class DtLightScreenSpaceData

friend

Member Data Documentation

LightType makVrv::DtLight::myLightType

protected

DtColorValue makVrv::DtLight::myAmbientColor

protected

DtColorValue makVrv::DtLight::myDiffuseColor

protected

DtColorValue makVrv::DtLight::mySpecularColor

protected

Vector3_64 makVrv::DtLight::myVecPosition

protected

Applicable only to point lights and spot lights.

Vector3_64 makVrv::DtLight::myVecDirection

protected

Applicable only to directional lights.

float32 makVrv::DtLight::myfRange

protected

float32 makVrv::DtLight::myfSquaredRange

protected

float32 makVrv::DtLight::myfConstantAttenuation

protected

float32 makVrv::DtLight::myfLinearAttenuation

protected

float32 makVrv::DtLight::myfQuadraticAttenuation

protected

DtDegrees makVrv::DtLight::myfInnerAngle

protected

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

DtDegrees makVrv::DtLight::myfOuterAngle

protected

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

protected

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

bool makVrv::DtLight::mybIsOn

protected

bool makVrv::DtLight::mybIsInitted

protected

init bit to keep track if it's really safe to add to the octtree

DtUserObjectBindings makVrv::DtLight::myUserObjectBindings

protected

void* makVrv::DtLight::myOctreeNode

protected

AxisAlignedBoundingBox_64 makVrv::DtLight::myWorldAABB

protected

LightGroup makVrv::DtLight::myLightGroup

protected

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

DtLightManager* makVrv::DtLight::myLightManager

protected

unsigned int makVrv::DtLight::myLightSourceTypeId

protected

float64 makVrv::DtLight::myUserValue

protected

const std::string makVrv::DtLight::theStrReservedBinding

staticprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvGraphicsUtils/DtLight.h