Référence de la classe Castor3D::Engine

Moteur principal. Plus de détails...

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

Graphe de collaboration de Castor3D::Engine:

Fonctions membres publiques
C3D_API	Engine ()
	Constructeur. Plus de détails...
C3D_API	~Engine ()
	Destructeur. Plus de détails...
C3D_API void	Initialise (uint32_t p_wantedFPS=100, bool p_threaded=false)
	Fonction d'initialisation, définit le frame rate voulu. Plus de détails...
C3D_API void	Cleanup ()
	Fonction de nettoyage, détruit tout ce qui a été créé depuis le début. Plus de détails...
C3D_API bool	LoadRenderer (eRENDERER_TYPE p_type)
	Charge un plug-in de rendu, selon le type de rendu. Plus de détails...
C3D_API void	PostEvent (FrameEventSPtr p_pEvent)
	Ajoute un évènement de frame au frame listener par défaut. Plus de détails...
C3D_API bool	IsCleaned ()
	Récupère le statut de nettoyage. Plus de détails...
C3D_API void	SetCleaned ()
	Dit que le moteur est nettoyé Plus de détails...
C3D_API bool	SupportsShaderModel (eSHADER_MODEL p_eShaderModel)
	Vérifie le support du shader model donné Plus de détails...
C3D_API void	RegisterParsers (Castor::String const &p_name, Castor::FileParser::AttributeParsersBySection &&p_parsers)
	Enregistre des analyseurs supplémentaires pour SceneFileParser. Plus de détails...
C3D_API void	RegisterSections (Castor::String const &p_name, Castor::StrUIntMap const &p_sections)
	Enregistre des sections supplémentaires pour SceneFileParser. Plus de détails...
C3D_API void	UnregisterParsers (Castor::String const &p_name)
	Désenregistre des analyseurs pour SceneFileParser. Plus de détails...
C3D_API void	UnregisterSections (Castor::String const &p_name)
	Désenregistre des sections pour SceneFileParser. Plus de détails...
Castor::ImageManager const &	GetImageManager () const
	Récupère la collection d'images. Plus de détails...
Castor::ImageManager &	GetImageManager ()
	Récupère la collection d'images. Plus de détails...
Castor::FontManager const &	GetFontManager () const
	Récupère la collection de polices. Plus de détails...
Castor::FontManager &	GetFontManager ()
	Récupère la collection de polices. Plus de détails...
RenderSystem *	GetRenderSystem () const
	Récupère le RenderSystem. Plus de détails...
BlendStateSPtr	GetDefaultBlendState () const
	Récupère le BlendState par défault (pas de blend) Plus de détails...
SamplerSPtr	GetDefaultSampler () const
	Récupère le Sampler par défault. Plus de détails...
SamplerSPtr	GetLightsSampler () const
	Récupère le Sampler pour les éclairages. Plus de détails...
std::map< Castor::String, Castor::FileParser::AttributeParsersBySection > const &	GetAdditionalParsers () const
	Récupère les analyseurs supplémentaires pour SceneFileParser. Plus de détails...
std::map< Castor::String, Castor::StrUIntMap > const &	GetAdditionalSections () const
	Récupère les sections supplémentaires pour SceneFileParser. Plus de détails...
Version const &	GetVersion () const
bool	HasRenderLoop () const
RenderLoop const &	GetRenderLoop () const
RenderLoop &	GetRenderLoop ()
void	SetPerObjectLighting (bool p_value)
	Définit le besoin d'un éclairage par objet. Plus de détails...
bool	GetPerObjectLighting ()
bool	IsThreaded ()

Fonctions membres publiques statiques
static C3D_API Castor::Path	GetPluginsDirectory ()
	Récupère le chemin des plug-ins. Plus de détails...
static C3D_API Castor::Path	GetEngineDirectory ()
	Donne le répertoire du Castor. Plus de détails...
static C3D_API Castor::Path	GetDataDirectory ()
	Récupère le chemin des données. Plus de détails...

Description détaillée

Moteur principal.

Auteur

Sylvain DOREMUS

Date

09/02/2010

Version

0.1

Remarques

Contient les fenêtres de rendu, les plug-ins, drivers de rendu...

Documentation des constructeurs et destructeur

C3D_API Castor3D::Engine::Engine

(

)

Constructeur.

C3D_API Castor3D::Engine::~Engine

(

)

Destructeur.

Documentation des fonctions membres

C3D_API void Castor3D::Engine::Cleanup

(

)

Fonction de nettoyage, détruit tout ce qui a été créé depuis le début.

Remarques

Détruit aussi les RenderWindows, les seules choses restantes après ça sont le RenderSystem et les plug-ins chargés

std::map< Castor::String, Castor::FileParser::AttributeParsersBySection > const& Castor3D::Engine::GetAdditionalParsers ( ) const

inline

Récupère les analyseurs supplémentaires pour SceneFileParser.

Renvoie

Les analyseurs.

std::map< Castor::String, Castor::StrUIntMap > const& Castor3D::Engine::GetAdditionalSections ( ) const

inline

Récupère les sections supplémentaires pour SceneFileParser.

Renvoie

Les sections.

static C3D_API Castor::Path Castor3D::Engine::GetDataDirectory ( )

static

Récupère le chemin des données.

Renvoie

Le chemin des données

BlendStateSPtr Castor3D::Engine::GetDefaultBlendState ( ) const

inline

Récupère le BlendState par défault (pas de blend)

Renvoie

La valeur

SamplerSPtr Castor3D::Engine::GetDefaultSampler ( ) const

inline

Récupère le Sampler par défault.

Renvoie

Le Sampler

static C3D_API Castor::Path Castor3D::Engine::GetEngineDirectory ( )

static

Donne le répertoire du Castor.

Renvoie

Le répertoire

Castor::FontManager const& Castor3D::Engine::GetFontManager ( ) const

inline

Récupère la collection de polices.

Renvoie

La collection

Castor::FontManager& Castor3D::Engine::GetFontManager ( )

inline

Récupère la collection de polices.

Renvoie

La collection

Castor::ImageManager const& Castor3D::Engine::GetImageManager ( ) const

inline

Récupère la collection d'images.

Renvoie

La collection

Castor::ImageManager& Castor3D::Engine::GetImageManager ( )

inline

Récupère la collection d'images.

Renvoie

La collection

SamplerSPtr Castor3D::Engine::GetLightsSampler ( ) const

inline

Récupère le Sampler pour les éclairages.

Renvoie

Le Sampler.

bool Castor3D::Engine::GetPerObjectLighting ( )

inline

Renvoie

Le besoin d'un éclairage par objet.

static C3D_API Castor::Path Castor3D::Engine::GetPluginsDirectory ( )

static

Récupère le chemin des plug-ins.

Renvoie

Le chemin des plug-ins

RenderLoop const& Castor3D::Engine::GetRenderLoop ( ) const

inline

Renvoie

La boucle de rendu.

RenderLoop& Castor3D::Engine::GetRenderLoop ( )

inline

Renvoie

La boucle de rendu.

RenderSystem* Castor3D::Engine::GetRenderSystem ( ) const

inline

Récupère le RenderSystem.

Renvoie

Le RenderSystem

Version const& Castor3D::Engine::GetVersion ( ) const

inline

Renvoie

La version du moteur.

bool Castor3D::Engine::HasRenderLoop ( ) const

inline

Renvoie

La boucle de rendu.

C3D_API void Castor3D::Engine::Initialise	(	uint32_t	p_wantedFPS = 100,
		bool	p_threaded = false
	)

Fonction d'initialisation, définit le frame rate voulu.

Paramètres

[in]	p_wantedFPS	Le nombre voulu de FPS
[in]	p_threaded	Si false, le rendu ne peut pas être threadé

C3D_API bool Castor3D::Engine::IsCleaned

(

)

Récupère le statut de nettoyage.

Remarques

Thread-safe

Renvoie

true si nettoyé

bool Castor3D::Engine::IsThreaded ( )

inline

Renvoie

Dit si le moteur utilise un boucle de rendu asynchrone.

C3D_API bool Castor3D::Engine::LoadRenderer

(

eRENDERER_TYPE

p_type

)

Charge un plug-in de rendu, selon le type de rendu.

Paramètres

[in]

p_type

Le type de rendu

Renvoie

true si tout s'est bien passé

C3D_API void Castor3D::Engine::PostEvent

(

FrameEventSPtr

p_pEvent

)

Ajoute un évènement de frame au frame listener par défaut.

Paramètres

[in]

p_pEvent

L'évènement

Référencé par Castor3D::ElementCleaner< Elem, typename std::enable_if< is_cleanable< Elem >::value &&!is_instant< Elem >::value >::type >::Cleanup(), et Castor3D::ElementInitialiser< Elem, typename std::enable_if< is_initialisable< Elem >::value &&!is_instant< Elem >::value >::type >::Initialise().

Voici le graphe des appelants de cette fonction :

C3D_API void Castor3D::Engine::RegisterParsers	(	Castor::String const &	p_name,
		Castor::FileParser::AttributeParsersBySection &&	p_parsers
	)

Enregistre des analyseurs supplémentaires pour SceneFileParser.

Paramètres

[in]	p_name	Le nom d'enregistrement.
[in]	p_parsers	Les analyseurs.

C3D_API void Castor3D::Engine::RegisterSections	(	Castor::String const &	p_name,
		Castor::StrUIntMap const &	p_sections
	)

Enregistre des sections supplémentaires pour SceneFileParser.

Paramètres

[in]	p_name	Le nom d'enregistrement.
[in]	p_sections	Les sections.

C3D_API void Castor3D::Engine::SetCleaned

(

)

Dit que le moteur est nettoyé

Remarques

Thread-safe

void Castor3D::Engine::SetPerObjectLighting ( bool  p_value )

inline

Définit le besoin d'un éclairage par objet.

Paramètres

[in]

p_value

La nouvelle valeur.

C3D_API bool Castor3D::Engine::SupportsShaderModel

(

eSHADER_MODEL

p_eShaderModel

)

Vérifie le support du shader model donné

Paramètres

[in]

p_eShaderModel

le shader model

Renvoie

true si le shader model est supporté dans la configuration actuelle

C3D_API void Castor3D::Engine::UnregisterParsers

(

Castor::String const &

p_name

)

Désenregistre des analyseurs pour SceneFileParser.

Paramètres

[in]

p_name

Le nom d'enregistrement.

C3D_API void Castor3D::Engine::UnregisterSections

(

Castor::String const &

p_name

)

Désenregistre des sections pour SceneFileParser.

Paramètres

[in]

p_name

Le nom d'enregistrement.

---

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

• Y:/software/Castor3D/source/Core/Castor3D/Src/Engine.hpp