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

#include <LightingModelFactory.hpp>

Classes
struct	Entry

Types publics
using	Obj = shader::LightingModel
using	Key = castor::String
using	Id = LightingModelID
using	PtrType = shader::LightingModelUPtr
using	Creator = shader::LightingModelCreator
using	ObjPtr = PtrType
using	ObjCont = std::vector< Entry >

Fonctions membres publiques
C3D_API LightingModelID	registerType (Key const &key, BackgroundModelID backgroundModelId, Creator create)
	Enregistre un type d'objet.
C3D_API void	unregisterType (Key const &key, BackgroundModelID backgroundModelId)
	Désenregistre un type d'objet.
C3D_API void	unregisterType (LightingModelID lightingModelId, BackgroundModelID backgroundModelId)
	Désenregistre un type d'objet.
C3D_API Id	getNameId (Key const &key) const
C3D_API Key	getIdName (Id const &id) const
C3D_API std::vector< LightingModelID >	getLightingModelsID () const
C3D_API std::vector< LightingModelID >	getLightingModelsID (BackgroundModelID backgroundModelId) const
template<typename ... Parameters>
ObjPtr	create (LightingModelID lightingModelId, BackgroundModelID backgroundModelId, Parameters &&... params) const
	Crée un objet à partir d'un ID.

Fonctions membres publiques statiques
static C3D_API castor::String	normaliseName (castor::String name)
	Remplace les anciens nommages par ceux enregistrés.

Documentation des définitions de type membres

Creator

using castor3d::LightingModelFactory::Creator = shader::LightingModelCreator

Id

using castor3d::LightingModelFactory::Id = LightingModelID

Key

using castor3d::LightingModelFactory::Key = castor::String

Obj

using castor3d::LightingModelFactory::Obj = shader::LightingModel

ObjCont

using castor3d::LightingModelFactory::ObjCont = std::vector< Entry >

ObjPtr

using castor3d::LightingModelFactory::ObjPtr = PtrType

PtrType

using castor3d::LightingModelFactory::PtrType = shader::LightingModelUPtr

Documentation des fonctions membres

create()

template<typename ... Parameters>

ObjPtr castor3d::LightingModelFactory::create ( LightingModelID  lightingModelId, BackgroundModelID  backgroundModelId, Parameters &&...  params  ) const

inline

Crée un objet à partir d'un ID.

Paramètres

[in]	lightingModelId	L'ID du modèle d'éclairage.
[in]	backgroundModelId	L'ID du modèle de fond.
[in]	params	Les paramètres de création.

Renvoie

L'objet créé.

getIdName()

C3D_API Key castor3d::LightingModelFactory::getIdName

(

Id const &

id

)

const

Paramètres

[in]

id

L'ID du type d'objet.

Renvoie

Le type d'objet.

getLightingModelsID() [1/2]

C3D_API std::vector< LightingModelID > castor3d::LightingModelFactory::getLightingModelsID

(

)

const

Renvoie

Les ID uniques des modèles d'éclairage.

getLightingModelsID() [2/2]

C3D_API std::vector< LightingModelID > castor3d::LightingModelFactory::getLightingModelsID

(

BackgroundModelID

backgroundModelId

)

const

Paramètres

[in]

backgroundModelId

L'ID du modèle de fond.

Renvoie

Les modèles d'éclairage du mod_le de fond donné.

getNameId()

C3D_API Id castor3d::LightingModelFactory::getNameId

(

Key const &

key

)

const

Paramètres

[in]

key

Le type d'objet.

Renvoie

L'ID du type d'objet.

normaliseName()

static C3D_API castor::String castor3d::LightingModelFactory::normaliseName ( castor::String  name )

static

Remplace les anciens nommages par ceux enregistrés.

registerType()

C3D_API LightingModelID castor3d::LightingModelFactory::registerType	(	Key const &	key,
		BackgroundModelID	backgroundModelId,
		Creator	create
	)

Enregistre un type d'objet.

Paramètres

[in]	key	Le type d'objet.
[in]	backgroundModelId	L'ID du modèle de fond.
[in]	create	La fonction de création d'objet.

unregisterType() [1/2]

C3D_API void castor3d::LightingModelFactory::unregisterType	(	Key const &	key,
		BackgroundModelID	backgroundModelId
	)

Désenregistre un type d'objet.

Paramètres

[in]	key	Le type d'objet.
[in]	backgroundModelId	L'ID du modèle de fond.

unregisterType() [2/2]

C3D_API void castor3d::LightingModelFactory::unregisterType	(	LightingModelID	lightingModelId,
		BackgroundModelID	backgroundModelId
	)

Désenregistre un type d'objet.

Paramètres

[in]	lightingModelId	L'ID du modèle d'éclairage.
[in]	backgroundModelId	L'ID du modèle de fond.

---

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

• Shader/LightingModelFactory.hpp