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	BinaryParser

class	TextLoader

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)
	Rend le fond de la scène. Plus de détails...

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

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

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

C3D_API MeshSPtr	ImportMesh (Castor::Path const &p_fileName, Importer &p_importer, Parameters const &p_parameters)
	Fonction d'import de Mesh. 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 void	AddOverlay (OverlaySPtr p_overlay)
	Ajoute un overlay à ceux déjà présents. 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...

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

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

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 constructeurs et destructeur

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

C3D_API Castor3D::Scene::~Scene ( )

Destructeur.

Documentation des fonctions membres

C3D_API void Castor3D::Scene::AddOverlay ( OverlaySPtr p_overlay )

Ajoute un overlay à ceux déjà présents.

Paramètres

[in] p_overlay L'overlay

Renvoie

C3D_API void Castor3D::Scene::Cleanup ( )

Vide les maps, laisse les noeuds pères.

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

inline

Renvoie: La couleur de la lumière ambiante

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

inline

Récupère la couleur du fond.

Renvoie: La couleur

TextureSPtr Castor3D::Scene::GetBackgroundImage ( ) const

inline

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

Renvoie: La valeur

SceneNodeSPtr Castor3D::Scene::GetCameraRootNode ( ) const

inline

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

Renvoie: La valeur

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

Récupère le nombre de faces.

Renvoie: La valeur

SceneNodeSPtr Castor3D::Scene::GetObjectRootNode ( ) const

inline

Récupère le node racine des objets.

Renvoie: La valeur

SceneNodeSPtr Castor3D::Scene::GetRootNode ( ) const

inline

Récupère le node racine.

Renvoie: La valeur

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

Récupère le nombre de sommets.

Renvoie: La valeur

bool Castor3D::Scene::HasChanged ( ) const

inline

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

Renvoie: La valeur

C3D_API bool Castor3D::Scene::ImportExternal	(	Castor::String 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é

C3D_API MeshSPtr Castor3D::Scene::ImportMesh	(	Castor::Path const &	p_fileName,
		Importer &	p_importer,
		Parameters const &	p_parameters
	)

Fonction d'import de Mesh.

Paramètres

[in]	p_fileName	Le chemin vers le fichier à importer.
[in]	p_importer	L'importeur.
[in]	p_parameters	Paramètres de configuration de l'import.

Renvoie: Le Mesh importé

C3D_API void Castor3D::Scene::Initialise ( )

Initialise la scène.

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

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

Rend le fond de la scène.

Paramètres

[in] p_size Les dimensions de la cible.

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.

Références DECLARE_MANAGER_MEMBER, DECLARE_MANAGER_VIEW_MEMBER, DECLARE_MANAGER_VIEW_MEMBER_EX, Castor3D::eEVENT_TYPE_POST_RENDER, et Castor3D::eEVENT_TYPE_PRE_RENDER.

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

inline

Définit la couleur du fond.

Paramètres

[in] p_clrNew La nouvelle couleur

C3D_API bool Castor3D::Scene::SetBackgroundImage ( Castor::Path const & p_pathFile )

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

Paramètres

[in] p_pathFile Le chemin d'accès à l'image

void Castor3D::Scene::SetChanged ( )

inline

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

C3D_API void Castor3D::Scene::Update ( )

Met à jour la scène avant le rendu.

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

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

Classes

Fonctions membres publiques

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres