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

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

Graphe de collaboration de castor3d::Scene:

Fonctions membres publiques
C3D_API	Scene (castor::String const &name, Engine &engine)
	Constructeur. Plus de détails...
C3D_API	~Scene ()
	Destructeur. Plus de détails...
C3D_API void	initialise ()
	Initialise la scène. Plus de détails...
C3D_API void	cleanup ()
	Vide les maps, laisse les noeuds pères. Plus de détails...
C3D_API void	update (CpuUpdater &updater)
	Met à jour la scène avant le rendu. Plus de détails...
C3D_API void	update (GpuUpdater &updater)
	Met à jour les objets de scène dépendant du device. Plus de détails...
C3D_API void	setBackground (SceneBackgroundSPtr value)
	Définit le fond de la scène. Plus de détails...
C3D_API bool	importExternal (castor::Path const &fileName, SceneImporter &importer)
	Importe une scène à partir d'un fichier. Plus de détails...
C3D_API void	merge (SceneSPtr scene)
	Intègre à cette scène le contenu de celle donnée. Plus de détails...
C3D_API uint32_t	getVertexCount () const
	Récupère le nombre de sommets. Plus de détails...
C3D_API uint32_t	getFaceCount () const
	Récupère le nombre de faces. Plus de détails...
C3D_API SceneFlags	getFlags () const
C3D_API bool	hasShadows () const
C3D_API bool	hasShadows (LightType lightType) const
C3D_API void	createEnvironmentMap (SceneNode &node)
C3D_API bool	hasEnvironmentMap (SceneNode const &node) const
C3D_API EnvironmentMap &	getEnvironmentMap (SceneNode const &node)
C3D_API EnvironmentMap const &	getEnvironmentMap (SceneNode const &node) const
C3D_API AnimatedObjectSPtr	addAnimatedTexture (TextureUnit &texture, Pass &pass)
Accesseurs.
C3D_API MaterialType	getMaterialsType () const
C3D_API bool	needsGlobalIllumination () const
C3D_API bool	needsGlobalIllumination (LightType ltType, GlobalIlluminationType giType) const
C3D_API ashes::SemaphoreCRefArray	getRenderTargetsSemaphores () const
castor::BoundingBox const &	getBoundingBox () const
SceneBackgroundSPtr	getBackground () const
SceneBackground const &	getColourBackground () const
SceneBackground &	getColourBackground ()
std::vector< std::reference_wrapper< EnvironmentMap > > &	getEnvironmentMaps ()
std::vector< std::reference_wrapper< EnvironmentMap > > const &	getEnvironmentMaps () const
castor::RgbColour const &	getBackgroundColour () const
SceneNodeSPtr	getRootNode () const
SceneNodeSPtr	getCameraRootNode () const
SceneNodeSPtr	getObjectRootNode () const
bool	hasChanged () const
castor::RgbColour const &	getAmbientLight () const
Fog const &	getFog () const
Fog &	getFog ()
FrameListener const &	getListener () const
FrameListener &	getListener ()
bool	isInitialised () const
bool	needsSubsurfaceScattering () const
bool	hasOpaqueObjects () const
bool	hasTransparentObjects () const
uint32_t	getDirectionalShadowCascades () const
float	getLpvIndirectAttenuation () const
VoxelSceneData const &	getVoxelConeTracingConfig () const
VoxelSceneData &	getVoxelConeTracingConfig ()
C3D_API void	setDirectionalShadowCascades (uint32_t value)
C3D_API void	setLpvIndirectAttenuation (float value)
C3D_API void	setMaterialsType (MaterialType value)
void	setBackgroundColour (castor::RgbColour const &value)
void	setChanged ()
void	setAmbientLight (castor::RgbColour const &value)

Attributs publics
OnSceneChanged	onChanged
OnSceneUpdate	onUpdate

Attributs publics statiques
static castor::String	CameraRootNode
static castor::String	ObjectRootNode
static castor::String	RootNode

Documentation des constructeurs et destructeur

Scene()

C3D_API castor3d::Scene::Scene	(	castor::String const &	name,
		Engine &	engine
	)

Constructeur.

Paramètres

[in]	name	Le nom de la scène
[in]	engine	Le moteur

~Scene()

C3D_API castor3d::Scene::~Scene

(

)

Destructeur.

Documentation des fonctions membres

addAnimatedTexture()

C3D_API AnimatedObjectSPtr castor3d::Scene::addAnimatedTexture	(	TextureUnit &	texture,
		Pass &	pass
	)

cleanup()

C3D_API void castor3d::Scene::cleanup

(

)

Vide les maps, laisse les noeuds pères.

createEnvironmentMap()

C3D_API void castor3d::Scene::createEnvironmentMap

(

SceneNode &

node

)

Renvoie

Crée une reflection map pour le noeud donné.

Paramètres

[in]

node

Le noeud de scène depuis lequel la reflection map est générée.

getAmbientLight()

castor::RgbColour const& castor3d::Scene::getAmbientLight ( ) const

inline

getBackground()

SceneBackgroundSPtr castor3d::Scene::getBackground ( ) const

inline

getBackgroundColour()

castor::RgbColour const& castor3d::Scene::getBackgroundColour ( ) const

inline

getBoundingBox()

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

inline

getCameraRootNode()

SceneNodeSPtr castor3d::Scene::getCameraRootNode ( ) const

inline

getColourBackground() [1/2]

SceneBackground const& castor3d::Scene::getColourBackground ( ) const

inline

getColourBackground() [2/2]

SceneBackground& castor3d::Scene::getColourBackground ( )

inline

getDirectionalShadowCascades()

uint32_t castor3d::Scene::getDirectionalShadowCascades ( ) const

inline

getEnvironmentMap() [1/2]

C3D_API EnvironmentMap& castor3d::Scene::getEnvironmentMap

(

SceneNode const &

node

)

Remarques

Appelez hasEnvironmentMap avant d'appeler cette fonction (celle-ci retournant une référence sur une EnvironmentMap existante)

Renvoie

Récupère la reflection map pour le noeud donné.

Paramètres

[in]

node

Le noeud de scène.

getEnvironmentMap() [2/2]

C3D_API EnvironmentMap const& castor3d::Scene::getEnvironmentMap

(

SceneNode const &

node

)

const

Remarques

Appelez hasEnvironmentMap avant d'appeler cette fonction (celle-ci retournant une référence sur une EnvironmentMap existante)

Renvoie

Récupère la reflection map pour le noeud donné.

Paramètres

[in]

node

Le noeud de scène.

getEnvironmentMaps() [1/2]

std::vector< std::reference_wrapper< EnvironmentMap > >& castor3d::Scene::getEnvironmentMaps ( )

inline

getEnvironmentMaps() [2/2]

std::vector< std::reference_wrapper< EnvironmentMap > > const& castor3d::Scene::getEnvironmentMaps ( ) const

inline

getFaceCount()

C3D_API uint32_t castor3d::Scene::getFaceCount

(

)

const

Récupère le nombre de faces.

Renvoie

La valeur

getFlags()

C3D_API SceneFlags castor3d::Scene::getFlags

(

)

const

Renvoie

Les indicateurs de la scène.

getFog() [1/2]

Fog const& castor3d::Scene::getFog ( ) const

inline

getFog() [2/2]

Fog& castor3d::Scene::getFog ( )

inline

getListener() [1/2]

FrameListener const& castor3d::Scene::getListener ( ) const

inline

getListener() [2/2]

FrameListener& castor3d::Scene::getListener ( )

inline

getLpvIndirectAttenuation()

float castor3d::Scene::getLpvIndirectAttenuation ( ) const

inline

getMaterialsType()

C3D_API MaterialType castor3d::Scene::getMaterialsType

(

)

const

getObjectRootNode()

SceneNodeSPtr castor3d::Scene::getObjectRootNode ( ) const

inline

getRenderTargetsSemaphores()

C3D_API ashes::SemaphoreCRefArray castor3d::Scene::getRenderTargetsSemaphores

(

)

const

getRootNode()

SceneNodeSPtr castor3d::Scene::getRootNode ( ) const

inline

getVertexCount()

C3D_API uint32_t castor3d::Scene::getVertexCount

(

)

const

Récupère le nombre de sommets.

Renvoie

La valeur

getVoxelConeTracingConfig() [1/2]

VoxelSceneData const& castor3d::Scene::getVoxelConeTracingConfig ( ) const

inline

getVoxelConeTracingConfig() [2/2]

VoxelSceneData& castor3d::Scene::getVoxelConeTracingConfig ( )

inline

hasChanged()

bool castor3d::Scene::hasChanged ( ) const

inline

hasEnvironmentMap()

C3D_API bool castor3d::Scene::hasEnvironmentMap

(

SceneNode const &

node

)

const

Renvoie

Dit s'il y a une reflection map pour le noeud donné.

Paramètres

[in]

node

Le noeud de scène.

hasOpaqueObjects()

bool castor3d::Scene::hasOpaqueObjects ( ) const

inline

hasShadows() [1/2]

C3D_API bool castor3d::Scene::hasShadows

(

)

const

Renvoie

Dit si la scène a au moins une source lumineuse projetant des ombres.

hasShadows() [2/2]

C3D_API bool castor3d::Scene::hasShadows

(

LightType

lightType

)

const

Renvoie

Dit si la scène a au moins une source lumineuse du type donné projetant des ombres.

hasTransparentObjects()

bool castor3d::Scene::hasTransparentObjects ( ) const

inline

importExternal()

C3D_API bool castor3d::Scene::importExternal	(	castor::Path const &	fileName,
		SceneImporter &	importer
	)

Importe une scène à partir d'un fichier.

Paramètres

[in]	fileName	L'adresse du fichier
[in]	importer	L'importeur chargé de la récupération des données

Renvoie

false si un problème quelconque a été rencontré

initialise()

C3D_API void castor3d::Scene::initialise

(

)

Initialise la scène.

isInitialised()

bool castor3d::Scene::isInitialised ( ) const

inline

merge()

C3D_API void castor3d::Scene::merge

(

SceneSPtr

scene

)

Intègre à cette scène le contenu de celle donnée.

Paramètres

[in]

scene

La scène à intégrer

needsGlobalIllumination() [1/2]

C3D_API bool castor3d::Scene::needsGlobalIllumination

(

)

const

needsGlobalIllumination() [2/2]

C3D_API bool castor3d::Scene::needsGlobalIllumination	(	LightType	ltType,
		GlobalIlluminationType	giType
	)		const

needsSubsurfaceScattering()

bool castor3d::Scene::needsSubsurfaceScattering ( ) const

inline

setAmbientLight()

void castor3d::Scene::setAmbientLight ( castor::RgbColour const &  value )

inline

setBackground()

C3D_API void castor3d::Scene::setBackground

(

SceneBackgroundSPtr

value

)

Définit le fond de la scène.

Paramètres

[in]

value

La nouvelle valeur.

setBackgroundColour()

void castor3d::Scene::setBackgroundColour ( castor::RgbColour const &  value )

inline

setChanged()

void castor3d::Scene::setChanged ( )

inline

Références onChanged.

setDirectionalShadowCascades()

C3D_API void castor3d::Scene::setDirectionalShadowCascades

(

uint32_t

value

)

name Mutateurs.

setLpvIndirectAttenuation()

C3D_API void castor3d::Scene::setLpvIndirectAttenuation

(

float

value

)

setMaterialsType()

C3D_API void castor3d::Scene::setMaterialsType

(

MaterialType

value

)

update() [1/2]

C3D_API void castor3d::Scene::update

(

CpuUpdater &

updater

)

Met à jour la scène avant le rendu.

update() [2/2]

C3D_API void castor3d::Scene::update

(

GpuUpdater &

updater

)

Met à jour les objets de scène dépendant du device.

Documentation des données membres

CameraRootNode

castor::String castor3d::Scene::CameraRootNode

static

Le nom du noeud de scène racine des caméras.

ObjectRootNode

castor::String castor3d::Scene::ObjectRootNode

static

Le nom du noeud de scène racine des objets.

onChanged

OnSceneChanged castor3d::Scene::onChanged

mutable

Le signal levé lorsque la scène a changé.

Référencé par setChanged().

onUpdate

OnSceneUpdate castor3d::Scene::onUpdate

mutable

Le signal levé lorsque la scène se met à jour.

RootNode

castor::String castor3d::Scene::RootNode

static

Le nom du noeud de scène racine.

---

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

• Scene/Scene.hpp