Castor3D::DirectionalLight Class Reference

Class which represents a Directional Light. More...

Inheritance diagram for Castor3D::DirectionalLight:

Collaboration diagram for Castor3D::DirectionalLight:

Classes
class	BinaryParser
	DirectionalLight loader. More...
class	TextLoader
	DirectionalLight loader. More...

Public Member Functions
C3D_API	DirectionalLight ()
	Constructor. More...
C3D_API	~DirectionalLight ()
	Destructor. More...
virtual C3D_API void	Bind (Castor::PxBufferBase &p_texture, uint32_t p_index) const
	Puts the light into the given texture. More...
virtual C3D_API void	SetDirection (Castor::Point3f const &p_direction)
	Sets the light source direction. More...
virtual C3D_API Castor::Point3f	GetDirection () const
	Retrieves the light source direction. More...
Public Member Functions inherited from Castor3D::LightCategory
C3D_API	LightCategory (eLIGHT_TYPE p_lightType)
	The constructor, used by clone function. More...
virtual C3D_API	~LightCategory ()
	Destructor. More...
void	SetColour (Castor::Point3f const &p_colour)
	Sets the light's colour. More...
void	SetIntensity (Castor::Point3f const &p_intensity)
	Sets the light's intensity values. More...
void	SetAmbientIntensity (float p_intensity)
	Sets the light's diffuse intensity. More...
void	SetDiffuseIntensity (float p_intensity)
	Sets the light's diffuse intensity. More...
void	SetSpecularIntensity (float p_intensity)
	Sets the light's specular intensity. More...
eLIGHT_TYPE	GetLightType () const
	Retrieves the light type. More...
float	GetAmbientIntensity () const
	Retrieves the ambient colour. More...
float	GetDiffuseIntensity () const
	Retrieves the diffuse colour. More...
float	GetSpecularIntensity () const
	Retrieves the specular colour. More...
Castor::Point3f const &	GetIntensity () const
Castor::Point3f &	GetIntensity ()
Castor::Point3f const &	GetColour () const
Castor::Point3f &	GetColour ()
Light *	GetLight () const
	Retrieves the parent light. More...
void	SetLight (Light *val)
	Sets the parent light. More...

Static Public Member Functions
static C3D_API LightCategorySPtr	Create ()
	Creation function, used by the Factory. More...

Friends
class	Scene

Additional Inherited Members
Protected Member Functions inherited from Castor3D::LightCategory
Castor::Point4f const &	GetPositionType () const
	Retrieves the light position and type. More...
virtual void	SetPositionType (Castor::Point4f const &p_position)
	Sets the light's type and position. More...
virtual void	SetPositionType (Castor::Point4d const &p_position)
	Sets the light's type and position. More...
void	DoBindComponent (Castor::Point3f const &p_component, int p_index, int &p_offset, Castor::PxBufferBase &p_data) const
void	DoBindComponent (Castor::Point4f const &p_component, int p_index, int &p_offset, Castor::PxBufferBase &p_data) const
void	DoBindComponent (Castor::Coords4f const &p_component, int p_index, int &p_offset, Castor::PxBufferBase &p_data) const

Detailed Description

Class which represents a Directional Light.

Author

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarks

A directional light is a light which enlights from an infinite point in a given direction

Constructor & Destructor Documentation

DirectionalLight()

C3D_API Castor3D::DirectionalLight::DirectionalLight

(

)

Constructor.

Remarks

Not to be used by the user, use Scene::CreateLight function instead

~DirectionalLight()

C3D_API Castor3D::DirectionalLight::~DirectionalLight

(

)

Destructor.

Member Function Documentation

Bind()

virtual C3D_API void Castor3D::DirectionalLight::Bind ( Castor::PxBufferBase &  p_texture, uint32_t  p_index  ) const

virtual

Puts the light into the given texture.

Implements Castor3D::LightCategory.

Create()

static C3D_API LightCategorySPtr Castor3D::DirectionalLight::Create ( )

static

Creation function, used by the Factory.

Returns

The light

GetDirection()

virtual C3D_API Castor::Point3f Castor3D::DirectionalLight::GetDirection ( ) const

virtual

Retrieves the light source direction.

Returns

The value

SetDirection()

virtual C3D_API void Castor3D::DirectionalLight::SetDirection ( Castor::Point3f const &  p_direction )

virtual

Sets the light source direction.

Parameters

[in]

p_direction

The new value

Friends And Related Function Documentation

Scene

friend class Scene

friend

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/DirectionalLight.hpp