Classe de gestion d'un scène. Plus de détails...

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

Graphe de collaboration de Castor3D::Scene:

Classes
class	TextWriter

Types publics
using	OnChangedFunction = std::function< void(Scene const &) >

using	OnChanged = Castor::Signal< OnChangedFunction >

Fonctions membres publiques
C3D_API	Scene (Castor::String const &p_name, Engine &p_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	RenderBackground (Castor::Size const &p_size, Camera const &p_camera)
	Rend l'arrière plan de la scène (skybox ou image). Plus de détails...

C3D_API void	Update ()
	Met à jour la scène avant le rendu. Plus de détails...

C3D_API bool	SetBackground (Castor::Path const &p_folder, Castor::Path const &p_relative)
	Définit l'image de fond pour la scène. Plus de détails...

C3D_API bool	SetForeground (SkyboxUPtr &&p_skybox)
	Définit la skybox de la scène. Plus de détails...

C3D_API bool	ImportExternal (Castor::Path const &p_fileName, Importer &p_importer)
	Importe une scène à partir d'un fichier. Plus de détails...

C3D_API void	Merge (SceneSPtr p_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

void	SetBackgroundColour (Castor::Colour const &p_clrNew)
	Définit la couleur du fond. Plus de détails...

Castor::Colour const &	GetBackgroundColour () const
	Récupère la couleur du fond. Plus de détails...

SceneNodeSPtr	GetRootNode () const
	Récupère le node racine. Plus de détails...

SceneNodeSPtr	GetCameraRootNode () const
	Récupère le node racine des caméras. Plus de détails...

SceneNodeSPtr	GetObjectRootNode () const
	Récupère le node racine des objets. Plus de détails...

TextureLayoutSPtr	GetBackgroundImage () const
	Récupère l'image de fond de la scène. Plus de détails...

bool	HasChanged () const
	Récupère le statut de changement de la scène. Plus de détails...

void	SetChanged ()
	Définit le statut de changement de la scène to `true`. Plus de détails...

Castor::Colour const &	GetAmbientLight () const

void	SetAmbientLight (Castor::Colour const &p_value)
	Définit la couleur de la lumière ambiante. Plus de détails...

bool	HasSkybox () const

Skybox const &	GetSkybox () const

Fog const &	GetFog () const

Fog &	GetFog ()

Shadow const &	GetShadow () const

Shadow &	GetShadow ()

FrameListener const &	GetListener () const

FrameListener &	GetListener ()

Attributs publics
OnChanged	onChanged

Attributs publics statiques
static Castor::String	CameraRootNode

static Castor::String	ObjectRootNode

static Castor::String	RootNode

Description détaillée

Classe de gestion d'un scène.

Auteur: Sylvain DOREMUS

Version: 0.1

Date: 09/02/2010

Remarques: Une scène est une collection de lumières, noeuds et géométries.
Elle a au moins une caméra permettant son rendu

Documentation des définitions de type membres

◆ OnChanged

using Castor3D::Scene::OnChanged = Castor::Signal< OnChangedFunction >

◆ OnChangedFunction

using Castor3D::Scene::OnChangedFunction = std::function< void( Scene const & ) >

Documentation des constructeurs et destructeur

◆ Scene()

C3D_API Castor3D::Scene::Scene	(	Castor::String const &	p_name,
		Engine &	p_engine
	)

Constructeur.

Paramètres

[in]	p_name	Le nom de la scène
[in]	p_engine	Le moteur

◆ ~Scene()

C3D_API Castor3D::Scene::~Scene ( )

Destructeur.

Documentation des fonctions membres

◆ Cleanup()

C3D_API void Castor3D::Scene::Cleanup ( )

Vide les maps, laisse les noeuds pères.

◆ GetAmbientLight()

Castor::Colour const& Castor3D::Scene::GetAmbientLight ( ) const

inline

Renvoie: La couleur de la lumière ambiante

◆ GetBackgroundColour()

Castor::Colour const& Castor3D::Scene::GetBackgroundColour ( ) const

inline

Récupère la couleur du fond.

Renvoie: La couleur

◆ GetBackgroundImage()

TextureLayoutSPtr Castor3D::Scene::GetBackgroundImage ( ) const

inline

Récupère l'image de fond de la scène.

Renvoie: La valeur

◆ GetCameraRootNode()

SceneNodeSPtr Castor3D::Scene::GetCameraRootNode ( ) const

inline

Récupère le node racine des caméras.

Renvoie: La valeur

◆ 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

Renvoie: Les paramètres du brouillard.

◆ GetFog() [2/2]

Fog& Castor3D::Scene::GetFog ( )

inline

Renvoie: Les paramètres du brouillard.

◆ GetListener() [1/2]

FrameListener const& Castor3D::Scene::GetListener ( ) const

inline

Renvoie: Le frame listener de la scène.

◆ GetListener() [2/2]

FrameListener& Castor3D::Scene::GetListener ( )

inline

Renvoie: Le frame listener de la scène.

◆ GetObjectRootNode()

SceneNodeSPtr Castor3D::Scene::GetObjectRootNode ( ) const

inline

Récupère le node racine des objets.

Renvoie: La valeur

◆ GetRootNode()

SceneNodeSPtr Castor3D::Scene::GetRootNode ( ) const

inline

Récupère le node racine.

Renvoie: La valeur

◆ GetShadow() [1/2]

Shadow const& Castor3D::Scene::GetShadow ( ) const

inline

Renvoie: Les paramètres des ombres.

◆ GetShadow() [2/2]

Shadow& Castor3D::Scene::GetShadow ( )

inline

Renvoie: Les paramètres des ombres.

◆ GetSkybox()

Skybox const& Castor3D::Scene::GetSkybox ( ) const

inline

Renvoie: La skybox.

◆ GetVertexCount()

C3D_API uint32_t Castor3D::Scene::GetVertexCount ( ) const

Récupère le nombre de sommets.

Renvoie: La valeur

◆ HasChanged()

bool Castor3D::Scene::HasChanged ( ) const

inline

Récupère le statut de changement de la scène.

Renvoie: La valeur

◆ HasShadows()

C3D_API bool Castor3D::Scene::HasShadows ( ) const

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

◆ HasSkybox()

bool Castor3D::Scene::HasSkybox ( ) const

inline

Renvoie: true si la skybox est définie.

◆ ImportExternal()

C3D_API bool Castor3D::Scene::ImportExternal	(	Castor::Path const &	p_fileName,
		Importer &	p_importer
	)

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

Paramètres

[in]	p_fileName	L'adresse du fichier
[in]	p_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.

◆ Merge()

C3D_API void Castor3D::Scene::Merge ( SceneSPtr p_scene )

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

Paramètres

[in] p_scene La scène à intégrer

◆ RenderBackground()

C3D_API void Castor3D::Scene::RenderBackground	(	Castor::Size const &	p_size,
		Camera const &	p_camera
	)

Rend l'arrière plan de la scène (skybox ou image).

Paramètres

[in]	p_size	Les dimensions de la cible.
[in]	p_camera	La caméra courante.

◆ SetAmbientLight()

void Castor3D::Scene::SetAmbientLight ( Castor::Colour const & p_value )

inline

Définit la couleur de la lumière ambiante.

Paramètres

[in] p_value La nouvelle valeur.

◆ SetBackground()

C3D_API bool Castor3D::Scene::SetBackground	(	Castor::Path const &	p_folder,
		Castor::Path const &	p_relative
	)

Définit l'image de fond pour la scène.

Paramètres

[in]	p_folder	Le dossier contenant l'image.
[in]	p_relative	Le chemin d'accès à l'image, relatif à p_folder.

◆ SetBackgroundColour()

void Castor3D::Scene::SetBackgroundColour ( Castor::Colour const & p_clrNew )

inline

Définit la couleur du fond.

Paramètres

[in] p_clrNew La nouvelle couleur

◆ SetChanged()

void Castor3D::Scene::SetChanged ( )

inline

Définit le statut de changement de la scène to true.

Références onChanged.

◆ SetForeground()

C3D_API bool Castor3D::Scene::SetForeground ( SkyboxUPtr && p_skybox )

Définit la skybox de la scène.

Paramètres

[in] p_skybox La skybox.

◆ Update()

C3D_API void Castor3D::Scene::Update ( )

Met à jour la scène avant le rendu.

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

OnChanged Castor3D::Scene::onChanged

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

Référencé par SetChanged().

◆ 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 :

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

Classes

Types publics

Fonctions membres publiques

Attributs publics

Attributs publics statiques

Description détaillée

Documentation des définitions de type membres

◆ OnChanged

◆ OnChangedFunction

Documentation des constructeurs et destructeur

◆ Scene()

◆ ~Scene()

Documentation des fonctions membres

◆ Cleanup()

◆ GetAmbientLight()

◆ GetBackgroundColour()

◆ GetBackgroundImage()

◆ GetCameraRootNode()

◆ GetFaceCount()

◆ GetFlags()

◆ GetFog() [1/2]

◆ GetFog() [2/2]

◆ GetListener() [1/2]

◆ GetListener() [2/2]

◆ GetObjectRootNode()

◆ GetRootNode()

◆ GetShadow() [1/2]

◆ GetShadow() [2/2]

◆ GetSkybox()

◆ GetVertexCount()

◆ HasChanged()

◆ HasShadows()

◆ HasSkybox()

◆ ImportExternal()

◆ Initialise()

◆ Merge()

◆ RenderBackground()

◆ SetAmbientLight()

◆ SetBackground()

◆ SetBackgroundColour()

◆ SetChanged()

◆ SetForeground()

◆ Update()

Documentation des données membres

◆ CameraRootNode

◆ ObjectRootNode

◆ onChanged

◆ RootNode