Vrml_SpotLight Class Reference

specifies a spot light node of VRML nodes specifying properties of lights. This node defines a spotlight light source. A spotlight is placed at a fixed location in 3D-space and illuminates in a cone along a particular direction. The intensity of the illumination drops off exponentially as a ray of light diverges from this direction toward the edges of cone. The rate of drop-off and agle of the cone are controlled by the dropOfRate and cutOffAngle Color is written as an RGB triple. Light intensity must be in the range 0.0 to 1.0, inclusive. More...

#include <Vrml_SpotLight.hxx>

Public Member Functions
	Vrml_SpotLight ()
	Vrml_SpotLight (const Standard_Boolean aOnOff, const Standard_Real aIntensity, const Quantity_Color &aColor, const gp_Vec &aLocation, const gp_Vec &aDirection, const Standard_Real aDropOffRate, const Standard_Real aCutOffAngle)
void	SetOnOff (const Standard_Boolean anOnOff)
Standard_Boolean	OnOff () const
void	SetIntensity (const Standard_Real aIntensity)
Standard_Real	Intensity () const
void	SetColor (const Quantity_Color &aColor)
Quantity_Color	Color () const
void	SetLocation (const gp_Vec &aLocation)
gp_Vec	Location () const
void	SetDirection (const gp_Vec &aDirection)
gp_Vec	Direction () const
void	SetDropOffRate (const Standard_Real aDropOffRate)
Standard_Real	DropOffRate () const
void	SetCutOffAngle (const Standard_Real aCutOffAngle)
Standard_Real	CutOffAngle () const
Standard_OStream &	Print (Standard_OStream &anOStream) const

Detailed Description

specifies a spot light node of VRML nodes specifying properties of lights. This node defines a spotlight light source. A spotlight is placed at a fixed location in 3D-space and illuminates in a cone along a particular direction. The intensity of the illumination drops off exponentially as a ray of light diverges from this direction toward the edges of cone. The rate of drop-off and agle of the cone are controlled by the dropOfRate and cutOffAngle Color is written as an RGB triple. Light intensity must be in the range 0.0 to 1.0, inclusive.

Constructor & Destructor Documentation

Vrml_SpotLight() [1/2]

Vrml_SpotLight::Vrml_SpotLight

(

)

Vrml_SpotLight() [2/2]

Vrml_SpotLight::Vrml_SpotLight	(	const Standard_Boolean	aOnOff,
		const Standard_Real	aIntensity,
		const Quantity_Color &	aColor,
		const gp_Vec &	aLocation,
		const gp_Vec &	aDirection,
		const Standard_Real	aDropOffRate,
		const Standard_Real	aCutOffAngle
	)

Member Function Documentation

Color()

Quantity_Color Vrml_SpotLight::Color

(

)

const

CutOffAngle()

Standard_Real Vrml_SpotLight::CutOffAngle

(

)

const

Direction()

gp_Vec Vrml_SpotLight::Direction

(

)

const

DropOffRate()

Standard_Real Vrml_SpotLight::DropOffRate

(

)

const

Intensity()

Standard_Real Vrml_SpotLight::Intensity

(

)

const

Location()

gp_Vec Vrml_SpotLight::Location

(

)

const

OnOff()

Standard_Boolean Vrml_SpotLight::OnOff

(

)

const

Print()

Standard_OStream& Vrml_SpotLight::Print

(

Standard_OStream &

anOStream

)

const

SetColor()

void Vrml_SpotLight::SetColor

(

const Quantity_Color &

aColor

)

SetCutOffAngle()

void Vrml_SpotLight::SetCutOffAngle

(

const Standard_Real

aCutOffAngle

)

SetDirection()

void Vrml_SpotLight::SetDirection

(

const gp_Vec &

aDirection

)

SetDropOffRate()

void Vrml_SpotLight::SetDropOffRate

(

const Standard_Real

aDropOffRate

)

SetIntensity()

void Vrml_SpotLight::SetIntensity

(

const Standard_Real

aIntensity

)

SetLocation()

void Vrml_SpotLight::SetLocation

(

const gp_Vec &

aLocation

)

SetOnOff()

void Vrml_SpotLight::SetOnOff

(

const Standard_Boolean

anOnOff

)

---

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

• Vrml_SpotLight.hxx