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
C3D_API	Light (Castor::String const &p_name, Scene &p_scene, SceneNodeSPtr p_node, LightFactory &p_factory, eLIGHT_TYPE p_lightType)
	Constructeur. Plus de détails...

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

C3D_API void	Bind (Castor::PxBufferBase &p_texture, uint32_t p_index)
	Met la lumière dans la texture donnée. Plus de détails...

virtual C3D_API void	AttachTo (SceneNodeSPtr p_node)
	Attache cette lumière au node donné Plus de détails...

C3D_API DirectionalLightSPtr	GetDirectionalLight () const
	Récupère la DirectionalLight. Plus de détails...

C3D_API PointLightSPtr	GetPointLight () const
	Récupère la PointLight. Plus de détails...

C3D_API SpotLightSPtr	GetSpotLight () const
	Récupère la SpotLight. 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::Point3f const &	GetColour () const

Castor::Point3f const &	GetIntensity () const

float	GetAmbientIntensity () const

float	GetDiffuseIntensity () const

float	GetSpecularIntensity () const

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

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

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

void	SetColour (float *p_values)
	Définit la couleur. Plus de détails...

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

void	SetColour (Castor::Point3f const &p_colour)
	Définit la couleur. Plus de détails...

void	SetColour (Castor::Colour const &p_colour)
	Définit la couleur. Plus de détails...

void	SetIntensity (float *p_values)
	Définit les valeurs d'intensité. Plus de détails...

void	SetIntensity (float a, float d, float s)
	Définit les valeurs d'intensité. Plus de détails...

void	SetIntensity (Castor::Point3f const &p_intensity)
	Définit les valeurs d'intensité. Plus de détails...

void	SetAmbientIntensity (float p_intensity)
	Définit l'intensité ambiante. Plus de détails...

void	SetDiffuseIntensity (float p_intensity)
	Définit l'intensité diffuse. Plus de détails...

void	SetSpecularIntensity (float p_intensity)
	Définit l'intensité 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...

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

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

Fonctions membres publiques hérités de Castor3D::MovableObject
C3D_API	MovableObject (Castor::String const &p_name, Scene &p_scene, eMOVABLE_TYPE p_type, SceneNodeSPtr p_sn)
	Constructeur. Plus de détails...

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

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

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

SceneNodeSPtr	GetParent () const
	Récupère le noeud parent. 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_name)
	Définit le nom de l'objet. Plus de détails...

Fonctions membres publiques hérités de Castor3D::Animable
C3D_API AnimationSPtr	CreateAnimation (Castor::String const &p_name)
	Crée une animation. Plus de détails...

C3D_API void	CleanupAnimations ()
	Vid ela map d'animations. Plus de détails...

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

AnimationPtrStrMap const &	GetAnimations () const

Fonctions membres protégées
void	OnNodeChanged ()

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

	~Animable ()
	Destructeur. 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_type
	Le type d'objet déplaçable. Plus de détails...

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

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

SceneNodeWPtr	m_pSceneNode
	Le noeud parent. Plus de détails...

uint32_t	m_notifyIndex = 0
	L'indice de notifcation des changements du noeud. Plus de détails...

Attributs protégés hérités de Castor3D::Animable
AnimationPtrStrMap	m_animations
	Toutes les animations. 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

C3D_API Castor3D::Light::Light	(	Castor::String const &	p_name,
		Scene &	p_scene,
		SceneNodeSPtr	p_node,
		LightFactory &	p_factory,
		eLIGHT_TYPE	p_lightType
	)

Constructeur.

Paramètres

[in]	p_name	Le nom de la lumière
[in]	p_scene	La scène parente
[in]	p_factory	La fabrique de LightCategory
[in]	p_lightType	Le type de lumière
[in]	p_node	Le scene node parent

C3D_API Castor3D::Light::~Light ( )

Destructeur.

Documentation des fonctions membres

virtual C3D_API void Castor3D::Light::AttachTo ( SceneNodeSPtr p_node )

virtual

Attache cette lumière au node donné

Paramètres

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

Réimplémentée à partir de Castor3D::MovableObject.

C3D_API void Castor3D::Light::Bind	(	Castor::PxBufferBase &	p_texture,
		uint32_t	p_index
	)

Met la lumière dans la texture donnée.

Paramètres

[out]	p_texture	La texture recevant les données de la source lumineuse.
[in]	p_index	L'indice de la source lumineuse.

void Castor3D::Light::Disable ( )

inline

Désactive la lumière.

Références OnNodeChanged(), et SetEnabled().

Voici le graphe d'appel pour cette fonction :

void Castor3D::Light::Enable ( )

inline

Active la lumière.

Références SetEnabled().

Voici le graphe d'appel pour cette fonction :

float Castor3D::Light::GetAmbientIntensity ( ) const

inline

Renvoie: L'intensité ambiante.

Références m_pCategory.

Castor::Point3f const& Castor3D::Light::GetColour ( ) const

inline

Renvoie: La couleur de la lumière.

Références m_pCategory.

float Castor3D::Light::GetDiffuseIntensity ( ) const

inline

Renvoie: L'intensité diffuse.

Références m_pCategory.

C3D_API DirectionalLightSPtr Castor3D::Light::GetDirectionalLight ( ) const

Récupère la DirectionalLight.

Renvoie: La valeur

int Castor3D::Light::GetIndex ( ) const

inline

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

Renvoie: La valeur

Références m_iIndex.

Castor::Point3f const& Castor3D::Light::GetIntensity ( ) const

inline

Renvoie: Les valeurs d'intensité.

Références m_pCategory.

eLIGHT_TYPE Castor3D::Light::GetLightType ( ) const

inline

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

Renvoie: La valeur

Références m_pCategory.

C3D_API PointLightSPtr Castor3D::Light::GetPointLight ( ) const

Récupère la PointLight.

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

Références m_pCategory.

float Castor3D::Light::GetSpecularIntensity ( ) const

inline

Renvoie: L'intensité spéculaire.

Références m_pCategory.

C3D_API SpotLightSPtr Castor3D::Light::GetSpotLight ( ) const

Récupère la SpotLight.

Renvoie: La valeur

bool Castor3D::Light::IsEnabled ( ) const

inline

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

Renvoie: La valeur

Références m_enabled.

void Castor3D::Light::OnNodeChanged ( )

protected

Référencé par Disable().

Voici le graphe des appelants de cette fonction :

void Castor3D::Light::SetAmbientIntensity ( float p_intensity )

inline

Définit l'intensité ambiante.

Paramètres

[in] p_intensity La nouvelle valeur.

Références m_pCategory.

void Castor3D::Light::SetColour ( float * p_values )

inline

Définit la couleur.

Paramètres

[in] p_values La nouvelle valeur.

Références m_pCategory.

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

inline

Définit la couleur.

Paramètres

[in] r,g,b Les composantes RGB.

Références m_pCategory.

void Castor3D::Light::SetColour ( Castor::Point3f const & p_colour )

inline

Définit la couleur.

Paramètres

[in] p_colour La nouvelle valeur.

Références m_pCategory.

void Castor3D::Light::SetColour ( Castor::Colour const & p_colour )

inline

Définit la couleur.

Paramètres

[in] p_colour La nouvelle valeur

Références m_pCategory.

void Castor3D::Light::SetDiffuseIntensity ( float p_intensity )

inline

Définit l'intensité diffuse.

Paramètres

[in] p_intensity La nouvelle valeur.

Références m_pCategory.

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

inline

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

Paramètres

[in] p_enabled La nouvelle valeur

Références m_enabled.

Référencé par Disable(), et Enable().

Voici le graphe des appelants de cette fonction :

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

inline

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

Paramètres

[in] p_value La nouvelle valeur

Références m_iIndex.

void Castor3D::Light::SetIntensity ( float * p_values )

inline

Définit les valeurs d'intensité.

Paramètres

[in] p_values Les nouvelles valeurs.

Références m_pCategory.

void Castor3D::Light::SetIntensity	(	float	a,
		float	d,
		float	s
	)

inline

Définit les valeurs d'intensité.

Paramètres

[in] a,d,s Les nouvelles valeurs.

Références m_pCategory.

void Castor3D::Light::SetIntensity ( Castor::Point3f const & p_intensity )

inline

Définit les valeurs d'intensité.

Paramètres

[in] p_intensity Les nouvelles valeurs.

Références m_pCategory.

void Castor3D::Light::SetSpecularIntensity ( float p_intensity )

inline

Définit l'intensité spéculaire.

Paramètres

[in] p_intensity La nouvelle valeur.

Références m_pCategory.

Documentation des données membres

bool Castor3D::Light::m_enabled

protected

Dit si la lumière est active ou pas.

Référencé par IsEnabled(), et SetEnabled().

int Castor3D::Light::m_iIndex

protected

L'indice de la lumière.

Référencé par GetIndex(), et SetIndex().

LightCategorySPtr Castor3D::Light::m_pCategory

protected

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

Référencé par GetAmbientIntensity(), GetColour(), GetDiffuseIntensity(), GetIntensity(), GetLightType(), GetPositionType(), GetSpecularIntensity(), SetAmbientIntensity(), SetColour(), SetDiffuseIntensity(), SetIntensity(), et SetSpecularIntensity().

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

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

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres