Référence de la classe castor3d::Light

#include <Light.hpp>

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

Graphe de collaboration de castor3d::Light:

Fonctions membres publiques
C3D_API	Light (castor::String const &name, Scene &scene, SceneNode &node, LightFactory &factory, LightType lightType)
	Constructeur. Plus de détails...
C3D_API void	update (CpuUpdater &updater)
	Mise à jour CPU. Plus de détails...
C3D_API void	fillBuffer (uint32_t index, LightBuffer::LightData &data)
	Enregistre les données de la source lumineuse dans le tampon donné. Plus de détails...
C3D_API DirectionalLightSPtr	getDirectionalLight () const
C3D_API PointLightSPtr	getPointLight () const
C3D_API SpotLightSPtr	getSpotLight () const
LightType	getLightType () const
bool	isEnabled () const
castor::Point3f const &	getColour () const
castor::Point2f const &	getIntensity () const
float	getFarPlane () const
float	getDiffuseIntensity () const
float	getSpecularIntensity () const
castor::BoundingBox const &	getBoundingBox () const
LightCategorySPtr	getCategory () const
bool	isShadowProducer () const
bool	isExpectedShadowProducer () const
ShadowType	getShadowType () const
ShadowMapRPtr	getShadowMap () const
uint32_t	getShadowMapIndex () const
uint32_t	getBufferIndex () const
bool	needsRsmShadowMaps () const
GlobalIlluminationType	getGlobalIlluminationType () const
GlobalIlluminationType	getExpectedGlobalIlluminationType () const
RsmConfig const &	getRsmConfig () const
RsmConfig &	getRsmConfig ()
LpvConfig const &	getLpvConfig () const
LpvConfig &	getLpvConfig ()
uint32_t	getVolumetricSteps () const
float	getVolumetricScatteringFactor () const
castor::Point2f const &	getShadowRawOffsets () const
castor::Point2f const &	getShadowPcfOffsets () const
castor::Point2f const &	getShadowVariance () const
ShadowConfig const &	getShadowConfig () const
void	setColour (float *values)
void	setColour (float r, float g, float b)
void	setColour (castor::Point3f const &value)
void	setColour (castor::RgbColour const &value)
void	setIntensity (float *values)
void	setIntensity (float d, float s)
void	setIntensity (castor::Point2f const &value)
void	setDiffuseIntensity (float value)
void	setSpecularIntensity (float value)
void	setEnabled (bool value)
void	enable ()
void	disable ()
void	setShadowProducer (bool value)
void	setShadowMap (ShadowMapRPtr value, uint32_t index=0u)
void	setGlobalIlluminationType (GlobalIlluminationType value)
void	setShadowType (ShadowType value)
void	setVolumetricSteps (uint32_t value)
void	setVolumetricScatteringFactor (float value)
void	setRawMinOffset (float value)
void	setRawMaxSlopeOffset (float value)
void	setPcfMinOffset (float value)
void	setPcfMaxSlopeOffset (float value)
void	setVsmMaxVariance (float value)
void	setVsmVarianceBias (float value)
void	setBufferIndex (uint32_t value)
Fonctions membres publiques hérités de castor3d::MovableObject
C3D_API	MovableObject (castor::String const &name, Scene &scene, MovableType type, SceneNode &node)
	Constructeur. Plus de détails...
C3D_API	MovableObject (castor::String const &name, Scene &scene, MovableType type)
	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...
virtual C3D_API void	attachTo (SceneNode &node)
	Attache l'object à un noeud. Plus de détails...
C3D_API void	markDirty ()
	Ajout l'objet à la liste des objets à mettre à jour de la scène. Plus de détails...
C3D_API EngineRPtr	getEngine () const
SceneNode *	getParent () const
MovableType	getType () const

Attributs publics
OnLightChanged	onGPUChanged

Attributs protégés
bool	m_enabled { false }
bool	m_shadowCaster { false }
std::atomic_bool	m_currentShadowCaster { false }
bool	m_dirty { true }
ShadowConfig	m_shadows
LightCategorySPtr	m_category
ShadowMapRPtr	m_shadowMap { nullptr }
uint32_t	m_shadowMapIndex { 0u }
std::atomic< GlobalIlluminationType >	m_currentGlobalIllumination { GlobalIlluminationType::eNone }
uint32_t	m_bufferIndex { 0u }
Attributs protégés hérités de castor3d::MovableObject
MovableType	m_type
SceneNode *	m_sceneNode
OnSceneNodeChangedConnection	m_notifyIndex

Documentation des constructeurs et destructeur

Light()

C3D_API castor3d::Light::Light	(	castor::String const &	name,
		Scene &	scene,
		SceneNode &	node,
		LightFactory &	factory,
		LightType	lightType
	)

Constructeur.

Paramètres

[in]	name	Le nom de la lumière.
[in]	scene	La scène parente.
[in]	node	Le scene node parent.
[in]	factory	La fabrique de LightCategory.
[in]	lightType	Le type de lumière.

Documentation des fonctions membres

disable()

void castor3d::Light::disable ( )

inline

Références setEnabled().

Voici le graphe d'appel pour cette fonction :

enable()

void castor3d::Light::enable ( )

inline

Références setEnabled().

Voici le graphe d'appel pour cette fonction :

fillBuffer()

C3D_API void castor3d::Light::fillBuffer	(	uint32_t	index,
		LightBuffer::LightData &	data
	)

Enregistre les données de la source lumineuse dans le tampon donné.

Paramètres

[in]	index	L'index de la source lumineuse dans le buffer.
[out]	data	Reçoit les informations.

getBoundingBox()

castor::BoundingBox const & castor3d::Light::getBoundingBox ( ) const

inline

Références m_category.

getBufferIndex()

uint32_t castor3d::Light::getBufferIndex ( ) const

inline

Références m_bufferIndex.

getCategory()

LightCategorySPtr castor3d::Light::getCategory ( ) const

inline

Références m_category.

getColour()

castor::Point3f const & castor3d::Light::getColour ( ) const

inline

Références m_category.

getDiffuseIntensity()

float castor3d::Light::getDiffuseIntensity ( ) const

inline

Références m_category.

getDirectionalLight()

C3D_API DirectionalLightSPtr castor3d::Light::getDirectionalLight

(

)

const

name Accesseurs.

getExpectedGlobalIlluminationType()

GlobalIlluminationType castor3d::Light::getExpectedGlobalIlluminationType ( ) const

inline

Références castor3d::ShadowConfig::globalIllumination, et m_shadows.

getFarPlane()

float castor3d::Light::getFarPlane ( ) const

inline

Références m_category.

getGlobalIlluminationType()

GlobalIlluminationType castor3d::Light::getGlobalIlluminationType ( ) const

inline

Références m_currentGlobalIllumination.

Référencé par needsRsmShadowMaps().

Voici le graphe des appelants de cette fonction :

getIntensity()

castor::Point2f const & castor3d::Light::getIntensity ( ) const

inline

Références m_category.

getLightType()

LightType castor3d::Light::getLightType ( ) const

inline

Références m_category.

getLpvConfig() [1/2]

LpvConfig & castor3d::Light::getLpvConfig ( )

inline

Références castor3d::ShadowConfig::lpvConfig, et m_shadows.

getLpvConfig() [2/2]

LpvConfig const & castor3d::Light::getLpvConfig ( ) const

inline

Références castor3d::ShadowConfig::lpvConfig, et m_shadows.

getPointLight()

C3D_API PointLightSPtr castor3d::Light::getPointLight

(

)

const

getRsmConfig() [1/2]

RsmConfig & castor3d::Light::getRsmConfig ( )

inline

Références m_shadows, et castor3d::ShadowConfig::rsmConfig.

getRsmConfig() [2/2]

RsmConfig const & castor3d::Light::getRsmConfig ( ) const

inline

Références m_shadows, et castor3d::ShadowConfig::rsmConfig.

getShadowConfig()

ShadowConfig const & castor3d::Light::getShadowConfig ( ) const

inline

Références m_shadows.

getShadowMap()

ShadowMapRPtr castor3d::Light::getShadowMap ( ) const

inline

Références m_shadowMap.

getShadowMapIndex()

uint32_t castor3d::Light::getShadowMapIndex ( ) const

inline

Références m_shadowMapIndex.

getShadowPcfOffsets()

castor::Point2f const & castor3d::Light::getShadowPcfOffsets ( ) const

inline

Références m_shadows, et castor3d::ShadowConfig::pcfOffsets.

getShadowRawOffsets()

castor::Point2f const & castor3d::Light::getShadowRawOffsets ( ) const

inline

Références m_shadows, et castor3d::ShadowConfig::rawOffsets.

getShadowType()

ShadowType castor3d::Light::getShadowType ( ) const

inline

Références castor3d::ShadowConfig::filterType, et m_shadows.

getShadowVariance()

castor::Point2f const & castor3d::Light::getShadowVariance ( ) const

inline

Références m_shadows, et castor3d::ShadowConfig::variance.

getSpecularIntensity()

float castor3d::Light::getSpecularIntensity ( ) const

inline

Références m_category.

getSpotLight()

C3D_API SpotLightSPtr castor3d::Light::getSpotLight

(

)

const

getVolumetricScatteringFactor()

float castor3d::Light::getVolumetricScatteringFactor ( ) const

inline

Références m_shadows, et castor3d::ShadowConfig::volumetricScattering.

getVolumetricSteps()

uint32_t castor3d::Light::getVolumetricSteps ( ) const

inline

Références m_shadows, et castor3d::ShadowConfig::volumetricSteps.

isEnabled()

bool castor3d::Light::isEnabled ( ) const

inline

Références m_enabled.

isExpectedShadowProducer()

bool castor3d::Light::isExpectedShadowProducer ( ) const

inline

Références m_shadowCaster.

isShadowProducer()

bool castor3d::Light::isShadowProducer ( ) const

inline

Références m_currentShadowCaster.

needsRsmShadowMaps()

bool castor3d::Light::needsRsmShadowMaps ( ) const

inline

Références castor3d::eNone, castor3d::eVoxelConeTracing, et getGlobalIlluminationType().

Voici le graphe d'appel pour cette fonction :

setBufferIndex()

void castor3d::Light::setBufferIndex ( uint32_t  value )

inline

Références m_bufferIndex.

setColour() [1/4]

void castor3d::Light::setColour ( castor::Point3f const &  value )

inline

Références m_category.

setColour() [2/4]

void castor3d::Light::setColour ( castor::RgbColour const &  value )

inline

Références m_category.

setColour() [3/4]

void castor3d::Light::setColour ( float *  values )

inline

name Mutateurs.

Références m_category.

setColour() [4/4]

void castor3d::Light::setColour ( float  r, float  g, float  b  )

inline

Références m_category.

setDiffuseIntensity()

void castor3d::Light::setDiffuseIntensity ( float  value )

inline

Références m_category.

setEnabled()

void castor3d::Light::setEnabled ( bool  value )

inline

Références m_enabled.

Référencé par disable(), et enable().

Voici le graphe des appelants de cette fonction :

setGlobalIlluminationType()

void castor3d::Light::setGlobalIlluminationType ( GlobalIlluminationType  value )

inline

Références castor3d::ShadowConfig::globalIllumination, m_shadows, et castor3d::MovableObject::markDirty().

Voici le graphe d'appel pour cette fonction :

setIntensity() [1/3]

void castor3d::Light::setIntensity ( castor::Point2f const &  value )

inline

Références m_category.

setIntensity() [2/3]

void castor3d::Light::setIntensity ( float *  values )

inline

Références m_category.

setIntensity() [3/3]

void castor3d::Light::setIntensity ( float  d, float  s  )

inline

Références m_category.

setPcfMaxSlopeOffset()

void castor3d::Light::setPcfMaxSlopeOffset ( float  value )

inline

Références m_shadows, et castor3d::ShadowConfig::pcfOffsets.

setPcfMinOffset()

void castor3d::Light::setPcfMinOffset ( float  value )

inline

Références m_shadows, et castor3d::ShadowConfig::pcfOffsets.

setRawMaxSlopeOffset()

void castor3d::Light::setRawMaxSlopeOffset ( float  value )

inline

Références m_shadows, et castor3d::ShadowConfig::rawOffsets.

setRawMinOffset()

void castor3d::Light::setRawMinOffset ( float  value )

inline

Références m_shadows, et castor3d::ShadowConfig::rawOffsets.

setShadowMap()

void castor3d::Light::setShadowMap ( ShadowMapRPtr  value, uint32_t  index = 0u  )

inline

Références m_shadowMap, m_shadowMapIndex, et onGPUChanged.

setShadowProducer()

void castor3d::Light::setShadowProducer ( bool  value )

inline

Références m_shadowCaster, et castor3d::MovableObject::markDirty().

Voici le graphe d'appel pour cette fonction :

setShadowType()

void castor3d::Light::setShadowType ( ShadowType  value )

inline

Références castor3d::ShadowConfig::filterType, et m_shadows.

setSpecularIntensity()

void castor3d::Light::setSpecularIntensity ( float  value )

inline

Références m_category.

setVolumetricScatteringFactor()

void castor3d::Light::setVolumetricScatteringFactor ( float  value )

inline

Références m_shadows, et castor3d::ShadowConfig::volumetricScattering.

setVolumetricSteps()

void castor3d::Light::setVolumetricSteps ( uint32_t  value )

inline

Références m_shadows, et castor3d::ShadowConfig::volumetricSteps.

setVsmMaxVariance()

void castor3d::Light::setVsmMaxVariance ( float  value )

inline

Références m_shadows, et castor3d::ShadowConfig::variance.

setVsmVarianceBias()

void castor3d::Light::setVsmVarianceBias ( float  value )

inline

Références m_shadows, et castor3d::ShadowConfig::variance.

update()

C3D_API void castor3d::Light::update

(

CpuUpdater &

updater

)

Mise à jour CPU.

Paramètres

[in,out]

updater

Les données d'update.

Documentation des données membres

m_bufferIndex

uint32_t castor3d::Light::m_bufferIndex { 0u }

protected

Référencé par getBufferIndex(), et setBufferIndex().

m_category

LightCategorySPtr castor3d::Light::m_category

protected

Référencé par getBoundingBox(), getCategory(), getColour(), getDiffuseIntensity(), getFarPlane(), getIntensity(), getLightType(), getSpecularIntensity(), setColour(), setDiffuseIntensity(), setIntensity(), et setSpecularIntensity().

m_currentGlobalIllumination

std::atomic< GlobalIlluminationType > castor3d::Light::m_currentGlobalIllumination { GlobalIlluminationType::eNone }

protected

Référencé par getGlobalIlluminationType().

m_currentShadowCaster

std::atomic_bool castor3d::Light::m_currentShadowCaster { false }

protected

Référencé par isShadowProducer().

m_dirty

bool castor3d::Light::m_dirty { true }

protected

m_enabled

bool castor3d::Light::m_enabled { false }

protected

Référencé par isEnabled(), et setEnabled().

m_shadowCaster

bool castor3d::Light::m_shadowCaster { false }

protected

Référencé par isExpectedShadowProducer(), et setShadowProducer().

m_shadowMap

ShadowMapRPtr castor3d::Light::m_shadowMap { nullptr }

protected

Référencé par getShadowMap(), et setShadowMap().

m_shadowMapIndex

uint32_t castor3d::Light::m_shadowMapIndex { 0u }

protected

Référencé par getShadowMapIndex(), et setShadowMap().

m_shadows

ShadowConfig castor3d::Light::m_shadows

protected

Référencé par getExpectedGlobalIlluminationType(), getLpvConfig(), getRsmConfig(), getShadowConfig(), getShadowPcfOffsets(), getShadowRawOffsets(), getShadowType(), getShadowVariance(), getVolumetricScatteringFactor(), getVolumetricSteps(), setGlobalIlluminationType(), setPcfMaxSlopeOffset(), setPcfMinOffset(), setRawMaxSlopeOffset(), setRawMinOffset(), setShadowType(), setVolumetricScatteringFactor(), setVolumetricSteps(), setVsmMaxVariance(), et setVsmVarianceBias().

onGPUChanged

OnLightChanged castor3d::Light::onGPUChanged

Référencé par setShadowMap().

---

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

• Scene/Light/Light.hpp