Référence de la classe Castor3D::SpotLight

Classe de représentation d'une PointLight. Plus de détails...

Graphe d'héritage de Castor3D::SpotLight:

Graphe de collaboration de Castor3D::SpotLight:

Classes
class	BinaryParser
class	TextLoader
	Loader de SpotLight. Plus de détails...

Fonctions membres publiques
	SpotLight ()
	Constructeur. Plus de détails...
	~SpotLight ()
	Destructeur. Plus de détails...
virtual void	Render (LightRendererSPtr p_pRenderer)
	Fonction de rendu sans shader. Plus de détails...
virtual void	Render (LightRendererSPtr p_pRenderer, ShaderProgramBase *p_pProgram)
	Fonction de rendu avec shader. Plus de détails...
virtual void	SetPosition (Castor::Point3r const &p_position)
	Définit la position de la source. Plus de détails...
virtual Castor::Point3f	GetPosition () const
	Récupère la position de la source. Plus de détails...
void	SetAttenuation (Castor::Point3f const &p_ptAttenuation)
	Définit les composantes d'atténuation. Plus de détails...
void	SetExponent (float p_exponent)
void	SetCutOff (float p_cutOff)
Castor::Point3f const &	GetAttenuation () const
	Récupère les composantes d'attenuation. Plus de détails...
Castor::Point3f &	GetAttenuation ()
	Récupère les composantes d'attenuation. Plus de détails...
float	GetExponent () const
	Récupère la valeur de l'exposant. Plus de détails...
float	GetCutOff () const
	Récupère l'angle du cône. Plus de détails...
Fonctions membres publiques hérités de Castor3D::LightCategory
	LightCategory (eLIGHT_TYPE p_eLightType)
	Le constructeur utilisé par la fonction de clonage. Plus de détails...
virtual	~LightCategory ()
	Destructeur. Plus de détails...
void	SetAmbient (Castor::Colour const &p_ambient)
	Définit la couleur ambiante. Plus de détails...
void	SetDiffuse (Castor::Colour const &p_diffuse)
	Définit la couleur diffuse. Plus de détails...
void	SetSpecular (Castor::Colour const &p_specular)
	Définit la couleur spéculaire. Plus de détails...
eLIGHT_TYPE	GetLightType () const
	Récupère le type de lumière. Plus de détails...
Castor::Colour const &	GetAmbient () const
	Récupère la couleur ambiante. Plus de détails...
Castor::Colour const &	GetDiffuse () const
	Récupère la couleur diffuse. Plus de détails...
Castor::Colour const &	GetSpecular () const
	Récupère la couleur spéculaire. Plus de détails...
Castor::Colour &	GetAmbient ()
	Récupère la couleur ambiante. Plus de détails...
Castor::Colour &	GetDiffuse ()
	Récupère la couleur diffuse. Plus de détails...
Castor::Colour &	GetSpecular ()
	Récupère la couleur spéculaire. Plus de détails...
Light *	GetLight () const
	Récupère la lumière parente. Plus de détails...
void	SetLight (Light *val)
	Définit la lumière parente. Plus de détails...

Fonctions membres publiques statiques
static LightCategorySPtr	Create ()
	Fonction de création utilisée par Factory. Plus de détails...

Amis
class	Scene

Membres hérités additionnels
Fonctions membres protégées hérités de Castor3D::LightCategory
Castor::Point4f const &	GetPositionType () const
	Récupère le type et la position de la lumière. Plus de détails...
virtual void	SetPositionType (Castor::Point4f const &p_ptPosition)
	Définit le type de la lumière et sa position. Plus de détails...
virtual void	SetPositionType (Castor::Point4d const &p_ptPosition)
	Définit le type de la lumière et sa position. Plus de détails...

Description détaillée

Classe de représentation d'une PointLight.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

Une spot light est une source de lumière à un point donné qui illumine dans une direction donnée en suivant une forme cônique

Documentation des constructeurs et destructeur

Castor3D::SpotLight::SpotLight

(

)

Constructeur.

Remarques

A ne pas utiliser par l'utilisateur, utiliser Scene::CreateLight à la place

Castor3D::SpotLight::~SpotLight

(

)

Destructeur.

Documentation des fonctions membres

static LightCategorySPtr Castor3D::SpotLight::Create ( )

static

Fonction de création utilisée par Factory.

Renvoie

Une source lumineuse

Castor::Point3f const& Castor3D::SpotLight::GetAttenuation ( ) const

inline

Récupère les composantes d'attenuation.

Renvoie

Les composantes d'attenuation

Castor::Point3f& Castor3D::SpotLight::GetAttenuation ( )

inline

Récupère les composantes d'attenuation.

Renvoie

Les composantes d'attenuation

float Castor3D::SpotLight::GetCutOff ( ) const

inline

Récupère l'angle du cône.

Renvoie

L'angle du cône

float Castor3D::SpotLight::GetExponent ( ) const

inline

Récupère la valeur de l'exposant.

Renvoie

La valeur de l'exposant

virtual Castor::Point3f Castor3D::SpotLight::GetPosition ( ) const

virtual

Récupère la position de la source.

Renvoie

La valeur

virtual void Castor3D::SpotLight::Render ( LightRendererSPtr  p_pRenderer )

virtual

Fonction de rendu sans shader.

Paramètres

[in]

p_pRenderer

Le renderer

Implémente Castor3D::LightCategory.

virtual void Castor3D::SpotLight::Render ( LightRendererSPtr  p_pRenderer, ShaderProgramBase *  p_pProgram  )

virtual

Fonction de rendu avec shader.

Paramètres

[in]	p_pRenderer	Le renderer
[in]	p_pProgram	Le shader qui va recevoir les informations de la lumière

Implémente Castor3D::LightCategory.

void Castor3D::SpotLight::SetAttenuation

(

Castor::Point3f const &

p_ptAttenuation

)

Définit les composantes d'atténuation.

Paramètres

[in]

p_ptAttenuation

Les composantes d'attenuation

void Castor3D::SpotLight::SetCutOff

(

float

p_cutOff

)

void Castor3D::SpotLight::SetExponent

(

float

p_exponent

)

virtual void Castor3D::SpotLight::SetPosition ( Castor::Point3r const &  p_position )

virtual

Définit la position de la source.

Paramètres

[in]

p_position

La nouvelle valeur

Documentation des fonctions amies et associées

friend class Scene

friend

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Y:/projets/Castor3D/source/Core/Castor3D/Src/SpotLight.hpp