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	TextWriter
	Loader de SpotLight. Plus de détails...

Fonctions membres publiques
C3D_API	~SpotLight ()
	Destructeur. Plus de détails...

C3D_API void	Update (Castor::Point3r const &p_target, Viewport &p_viewport, int32_t p_index=-1) override
	Met le viewport de la source à jour. Plus de détails...

C3D_API std::unique_ptr< LightCategory::TextWriter >	CreateTextWriter (Castor::String const &p_tabs) override
	Crée un TextLoader spécifique à la LightCategory. Plus de détails...

C3D_API void	SetAttenuation (Castor::Point3f const &p_ptAttenuation)
	Définit les composantes d'atténuation. Plus de détails...

C3D_API void	SetExponent (float p_exponent)

C3D_API void	SetCutOff (Castor::Angle const &p_cutOff)

Castor::Point3f const &	GetDirection () const

Castor::Matrix4x4f const &	GetLightSpaceTransform () const

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...

Castor::Angle const &	GetCutOff () const
	Récupère l'angle du cône. Plus de détails...

Fonctions membres publiques hérités de Castor3D::LightCategory
virtual C3D_API	~LightCategory ()
	Destructeur. Plus de détails...

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

void	SetColour (Castor::Point3f const &p_colour)
	Définit la couleur. 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é diffuse. 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...

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

float	GetAmbientIntensity () const
	Récupère la couleur ambiante. Plus de détails...

float	GetDiffuseIntensity () const
	Récupère la couleur diffuse. Plus de détails...

float	GetSpecularIntensity () const
	Récupère la couleur spéculaire. Plus de détails...

Castor::Point3f const &	GetIntensity () const

Castor::Point3f &	GetIntensity ()

Castor::Point3f const &	GetColour () const

Castor::Point3f &	GetColour ()

Light const &	GetLight () const
	Récupère la lumière parente. Plus de détails...

Light &	GetLight ()
	Récupère la lumière parente. Plus de détails...

Fonctions membres publiques statiques
static C3D_API LightCategoryUPtr	Create (Light &p_light)
	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
C3D_API	LightCategory (LightType p_lightType, Light &p_light)
	Constructeur. Plus de détails...

void	DoBindComponent (Castor::Point3f const &p_component, uint32_t p_index, uint32_t &p_offset, Castor::PxBufferBase &p_data) const

void	DoBindComponent (Castor::Point4f const &p_component, uint32_t p_index, uint32_t &p_offset, Castor::PxBufferBase &p_data) const

void	DoBindComponent (Castor::ConstCoords4f const &p_component, uint32_t p_index, uint32_t &p_offset, Castor::PxBufferBase &p_data) const

void	DoBindComponent (Castor::Coords4f const &p_component, uint32_t p_index, uint32_t &p_offset, Castor::PxBufferBase &p_data) const

void	DoBindComponent (Castor::Matrix4x4f const &p_component, uint32_t p_index, uint32_t &p_offset, Castor::PxBufferBase &p_data) const

void	DoBindComponent (int32_t const &p_component, uint32_t p_index, uint32_t &p_offset, Castor::PxBufferBase &p_data) const

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

◆ ~SpotLight()

C3D_API Castor3D::SpotLight::~SpotLight ( )

Destructeur.

Documentation des fonctions membres

◆ Create()

static C3D_API LightCategoryUPtr Castor3D::SpotLight::Create ( Light & p_light )

static

Fonction de création utilisée par Factory.

Renvoie: Une source lumineuse.

◆ CreateTextWriter()

C3D_API std::unique_ptr< LightCategory::TextWriter > Castor3D::SpotLight::CreateTextWriter ( Castor::String const & p_tabs )

inlineoverridevirtual

Crée un TextLoader spécifique à la LightCategory.

Paramètres

[in] p_tabs Le niveau d'intentation actuel.

Renvoie: Le TextLoader.

Implémente Castor3D::LightCategory.

Références C3D_API, SetAttenuation(), SetCutOff(), et SetExponent().

Voici le graphe d'appel pour cette fonction :

◆ GetAttenuation() [1/2]

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

inline

Récupère les composantes d'attenuation.

Renvoie: Les composantes d'attenuation

◆ GetAttenuation() [2/2]

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

inline

Récupère les composantes d'attenuation.

Renvoie: Les composantes d'attenuation

◆ GetCutOff()

Castor::Angle const& Castor3D::SpotLight::GetCutOff ( ) const

inline

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

Renvoie: L'angle du cône

Références C3D_API.

◆ GetDirection()

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

inline

Renvoie: La direction de la source lumineuse.

◆ GetExponent()

float Castor3D::SpotLight::GetExponent ( ) const

inline

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

Renvoie: La valeur de l'exposant

◆ GetLightSpaceTransform()

Castor::Matrix4x4f const& Castor3D::SpotLight::GetLightSpaceTransform ( ) const

inline

Renvoie: La matrice de transformation de la lumière.

◆ SetAttenuation()

C3D_API 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

Référencé par CreateTextWriter().

Voici le graphe des appelants de cette fonction :

◆ SetCutOff()

C3D_API void Castor3D::SpotLight::SetCutOff ( Castor::Angle const & p_cutOff )

Référencé par CreateTextWriter().

Voici le graphe des appelants de cette fonction :

◆ SetExponent()

C3D_API void Castor3D::SpotLight::SetExponent ( float p_exponent )

Référencé par CreateTextWriter().

Voici le graphe des appelants de cette fonction :

◆ Update()

C3D_API void Castor3D::SpotLight::Update	(	Castor::Point3r const &	p_target,
		Viewport &	p_viewport,
		int32_t	p_index = `-1`
	)

overridevirtual

Met le viewport de la source à jour.

Paramètres

[in]	p_target	La position de la cible, utilisée pour la map d'ombres des source directionnelles.
[in,out]	p_viewport	Le viewport à mettre à jour.
[in]	p_index	L'indice de la shadow map de la lumière, -1 si elle n'en a pas.

Implémente Castor3D::LightCategory.

Documentation des fonctions amies et associées

◆ Scene

friend class Scene

friend

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Scene/Light/SpotLight.hpp

Classes

Fonctions membres publiques

Fonctions membres publiques statiques

Amis

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ ~SpotLight()

Documentation des fonctions membres

◆ Create()

◆ CreateTextWriter()

◆ GetAttenuation() [1/2]

◆ GetAttenuation() [2/2]

◆ GetCutOff()

◆ GetDirection()

◆ GetExponent()

◆ GetLightSpaceTransform()

◆ SetAttenuation()

◆ SetCutOff()

◆ SetExponent()

◆ Update()

Documentation des fonctions amies et associées

◆ Scene