Implémentation d'une source lumineuse. Plus de détails...

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

Graphe de collaboration de Castor3D::Light:

Fonctions membres publiques
	Light (Scene *p_pScene, LightFactory &p_factory, eLIGHT_TYPE p_eLightType)
	Constructeur. Plus de détails...

	Light (LightFactory &p_factory, Scene *p_pScene, SceneNodeSPtr p_pNode, Castor::String const &p_name, eLIGHT_TYPE p_eLightType)
	Constructeur. Plus de détails...

	~Light ()
	Destructeur. Plus de détails...

void	Enable ()
	Active la lumière. Plus de détails...

void	Disable ()
	Désactive la lumière. Plus de détails...

void	Enable (ShaderProgramBase *p_pProgram)
	Active la lumière. Plus de détails...

void	Disable (ShaderProgramBase *p_pProgram)
	Désactive la lumière. Plus de détails...

void	Render ()
	Rend la lumière. Plus de détails...

void	EndRender ()
	Fin du rendu de la lumière. Plus de détails...

void	Render (ShaderProgramBase *p_pProgram)
	Rend la lumière. Plus de détails...

void	EndRender (ShaderProgramBase *p_pProgram)
	Fin du rendu de la lumière. Plus de détails...

virtual void	AttachTo (SceneNode *p_pNode)
	Attache cette lumière au node donné Plus de détails...

eLIGHT_TYPE	GetLightType () const
	Récupère le type de lumière. Plus de détails...

bool	IsEnabled () const
	Récupère le statut d'activation de la 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...

Castor::Point4f const &	GetPositionType () const
	Récupère le type et la position de la lumière. Plus de détails...

LightCategorySPtr	GetLightCategory () const
	Récupère la LightCategory. Plus de détails...

int	GetIndex () const
	Récupère l(indice de la lumière. Plus de détails...

void	SetIndex (int val)
	Définit l'indice de la lumière. Plus de détails...

void	SetAmbient (float *p_ambient)
	Définit la couleur ambiante. Plus de détails...

void	SetAmbient (float r, float g, float b)
	Définit la couleur ambiante. Plus de détails...

void	SetAmbient (Castor::Colour const &p_ambient)
	Définit la couleur ambiante. Plus de détails...

void	SetDiffuse (float *p_diffuse)
	Définit la couleur diffuse. Plus de détails...

void	SetDiffuse (float r, float g, float b)
	Définit la couleur diffuse. Plus de détails...

void	SetDiffuse (Castor::Colour const &p_diffuse)
	Définit la couleur diffuse. Plus de détails...

void	SetSpecular (float *p_specular)
	Définit la couleur spéculaire. Plus de détails...

void	SetSpecular (float r, float g, float b)
	Définit la couleur spéculaire. Plus de détails...

void	SetSpecular (Castor::Colour const &p_specular)
	Définit la couleur spéculaire. Plus de détails...

void	SetEnabled (bool p_enabled)
	Définit le statut d'activation de la lumère. Plus de détails...

Fonctions membres publiques hérités de Castor3D::MovableObject
	MovableObject (Scene *p_pScene, eMOVABLE_TYPE p_eType)
	Constructeur. Plus de détails...

	MovableObject (Scene p_pScene, SceneNode p_sn, Castor::String const &p_name, eMOVABLE_TYPE p_eType)
	Constructeur. Plus de détails...

	MovableObject (MovableObject const &p_object)
	Constructeur par copie. Plus de détails...

	MovableObject (MovableObject &&p_object)
	Constructeur par déplacement. Plus de détails...

MovableObject &	operator= (MovableObject const &p_object)
	Opérateur d'affectation par copie. Plus de détails...

MovableObject &	operator= (MovableObject &&p_object)
	Opérateur d'affectation par déplacement. Plus de détails...

virtual	~MovableObject ()
	Destructeur. Plus de détails...

void	Cleanup ()
	Nettoie l'instance. Plus de détails...

void	Detach ()
	Détache l'objet de son parent. Plus de détails...

void	AttachTo (SceneNode *p_node)
	Attache l'object à un noeud. Plus de détails...

Castor::String const &	GetName () const
	Récupère le nom de l'objet. Plus de détails...

SceneNode *	GetParent () const
	Récupère le noeud parent. Plus de détails...

Scene *	GetScene () const
	Récupère la scène parente. Plus de détails...

eMOVABLE_TYPE	GetType () const
	Récupère le type d'objet. Plus de détails...

void	SetName (Castor::String const &p_strName)
	Définit le nom de l'objet. Plus de détails...

Fonctions membres publiques hérités de Castor3D::Animable
	Animable ()
	Constructeur. Plus de détails...

virtual	~Animable ()
	Destructeur. Plus de détails...

AnimationPtrStrMapIt	AnimationsBegin ()
	Récupère un itérateur sur la première animation. Plus de détails...

AnimationPtrStrMapConstIt	AnimationsBegin () const
	Récupère un itérateur sur la première animation. Plus de détails...

AnimationPtrStrMapIt	AnimationsEnd ()
	Récupère un itérateur sur la fin de la map d'animations. Plus de détails...

AnimationPtrStrMapConstIt	AnimationsEnd () const
	Récupère un itérateur sur la fin de la map d'animations. Plus de détails...

AnimationSPtr	CreateAnimation (Castor::String const &p_strName)
	Crée une animation. Plus de détails...

AnimationSPtr	GetAnimation (Castor::String const &p_strName)
	Récupère une animation. Plus de détails...

Fonctions membres publiques hérités de Castor3D::Renderable< Light, LightRenderer >
virtual	~Renderable ()
	Destructeur. Plus de détails...

virtual void	Render2D ()

renderer_sptr	GetRenderer () const
	Récupère le Renderer. Plus de détails...

virtual Engine *	GetEngine () const
	Récupère l'Engine. Plus de détails...

Attributs protégés
bool	m_enabled
	Dit si la lumière est active ou pas. Plus de détails...

LightCategorySPtr	m_pCategory
	la light category contenant les données de la lumière Plus de détails...

int	m_iIndex
	L'indice de la lumière. Plus de détails...

Attributs protégés hérités de Castor3D::MovableObject
eMOVABLE_TYPE	m_eType
	Le type d'objet déplaçable. Plus de détails...

Castor::String	m_strName
	Le nom de l'objet. Plus de détails...

Castor::String	m_strNodeName
	Le nom du noeud parent. Plus de détails...

SceneNode *	m_pSceneNode
	Le noeud parent. Plus de détails...

Scene *	m_pScene
	La scène parente. Plus de détails...

Attributs protégés hérités de Castor3D::Animable
AnimationPtrStrMap	m_mapAnimations
	Toutes les animations. Plus de détails...

Attributs protégés hérités de Castor3D::Renderable< Light, LightRenderer >
renderer_wptr	m_pRenderer
	Le renderer. Plus de détails...

Engine *	m_pEngine
	Le moteur. Plus de détails...

Membres hérités additionnels
Fonctions membres protégées hérités de Castor3D::Renderable< Light, LightRenderer >
	Renderable (Engine *p_pEngine)
	Constructeur. Plus de détails...

	Renderable (Renderable< Light, LightRenderer > const &p_copy)
	Constructeur par copie. Plus de détails...

	Renderable (Renderable< Light, LightRenderer > &&p_copy)
	Constructeur par déplacement. Plus de détails...

Renderable &	operator= (Renderable< Light, LightRenderer > const &p_copy)
	Opérateur d'affectation par copie. Plus de détails...

Renderable &	operator= (Renderable< Light, LightRenderer > &&p_copy)
	Opérateur d'affectation par déplacement. Plus de détails...

Description détaillée

Implémentation d'une source lumineuse.

Auteur: Sylvain DOREMUS

Version: 0.1

Date: 09/02/2010

Remarques

Documentation des constructeurs et destructeur

Castor3D::Light::Light	(	Scene *	p_pScene,
		LightFactory &	p_factory,
		eLIGHT_TYPE	p_eLightType
	)

Constructeur.

Paramètres

[in]	p_pScene	La scène parente
[in]	p_pFactory	La fabrique de LightCategory
[in]	p_eLightType	Le type de lumière

Castor3D::Light::Light	(	LightFactory &	p_factory,
		Scene *	p_pScene,
		SceneNodeSPtr	p_pNode,
		Castor::String const &	p_name,
		eLIGHT_TYPE	p_eLightType
	)

Constructeur.

Paramètres

[in]	p_pScene	La scène parente
[in]	p_pNode	Le scene node parent
[in]	p_pFactory	La fabrique de LightCategory
[in]	p_eLightType	Le type de lumière

Castor3D::Light::~Light ( )

Destructeur.

Documentation des fonctions membres

virtual void Castor3D::Light::AttachTo ( SceneNode * p_pNode )

virtual

Attache cette lumière au node donné

Paramètres

[in] p_pNode Le nouveau node parent de cette lumière

void Castor3D::Light::Disable ( )

Désactive la lumière.

void Castor3D::Light::Disable ( ShaderProgramBase * p_pProgram )

Désactive la lumière.

Paramètres

[in] p_pProgram Le programme recevant les données de la lumière

void Castor3D::Light::Enable ( )

Active la lumière.

void Castor3D::Light::Enable ( ShaderProgramBase * p_pProgram )

Active la lumière.

Paramètres

[in] p_pProgram Le programme recevant les données de la lumière

void Castor3D::Light::EndRender ( )

virtual

Fin du rendu de la lumière.

Remarques: Implémentation passant par le pipeline fixe

Réimplémentée à partir de Castor3D::Renderable< Light, LightRenderer >.

void Castor3D::Light::EndRender ( ShaderProgramBase * p_pProgram )

Fin du rendu de la lumière.

Remarques: Implémentation passant par les shaders

Castor::Colour const& Castor3D::Light::GetAmbient ( ) const

inline

Récupère la couleur ambiante.

Renvoie: La valeur

Castor::Colour& Castor3D::Light::GetAmbient ( )

inline

Récupère la couleur ambiante.

Renvoie: La valeur

Castor::Colour const& Castor3D::Light::GetDiffuse ( ) const

inline

Récupère la couleur diffuse.

Renvoie: La valeur

Castor::Colour& Castor3D::Light::GetDiffuse ( )

inline

Récupère la couleur diffuse.

Renvoie: La valeur

int Castor3D::Light::GetIndex ( ) const

inline

Récupère l(indice de la lumière.

Renvoie: La valeur

LightCategorySPtr Castor3D::Light::GetLightCategory ( ) const

inline

Récupère la LightCategory.

Renvoie: La valeur

eLIGHT_TYPE Castor3D::Light::GetLightType ( ) const

inline

Récupère le type de lumière.

Renvoie: La valeur

Castor::Point4f const& Castor3D::Light::GetPositionType ( ) const

inline

Récupère le type et la position de la lumière.

Renvoie: La valeur

Castor::Colour const& Castor3D::Light::GetSpecular ( ) const

inline

Récupère la couleur spéculaire.

Renvoie: La valeur

Castor::Colour& Castor3D::Light::GetSpecular ( )

inline

Récupère la couleur spéculaire.

Renvoie: La valeur

bool Castor3D::Light::IsEnabled ( ) const

inline

Récupère le statut d'activation de la lumière.

Renvoie: La valeur

void Castor3D::Light::Render ( )

virtual

Rend la lumière.

Remarques: Implémentation passant par le pipeline fixe

Réimplémentée à partir de Castor3D::Renderable< Light, LightRenderer >.

void Castor3D::Light::Render ( ShaderProgramBase * p_pProgram )

Rend la lumière.

Remarques: Implémentation passant par les shaders

void Castor3D::Light::SetAmbient ( float * p_ambient )

inline

Définit la couleur ambiante.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetAmbient	(	float	r,
		float	g,
		float	b
	)

inline

Définit la couleur ambiante.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetAmbient ( Castor::Colour const & p_ambient )

inline

Définit la couleur ambiante.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetDiffuse ( float * p_diffuse )

inline

Définit la couleur diffuse.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetDiffuse	(	float	r,
		float	g,
		float	b
	)

inline

Définit la couleur diffuse.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetDiffuse ( Castor::Colour const & p_diffuse )

inline

Définit la couleur diffuse.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetEnabled ( bool p_enabled )

inline

Définit le statut d'activation de la lumère.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetIndex ( int val )

inline

Définit l'indice de la lumière.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetSpecular ( float * p_specular )

inline

Définit la couleur spéculaire.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetSpecular	(	float	r,
		float	g,
		float	b
	)

inline

Définit la couleur spéculaire.

Paramètres

[in] La nouvelle valeur

void Castor3D::Light::SetSpecular ( Castor::Colour const & p_specular )

inline

Définit la couleur spéculaire.

Paramètres

[in] La nouvelle valeur

Documentation des données membres

bool Castor3D::Light::m_enabled

protected

Dit si la lumière est active ou pas.

int Castor3D::Light::m_iIndex

protected

L'indice de la lumière.

LightCategorySPtr Castor3D::Light::m_pCategory

protected

la light category contenant les données de la lumière

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

Y:/projets/Castor3D/source/Core/Castor3D/Src/Light.hpp

Fonctions membres publiques

Attributs protégés

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres