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 (castor::String const &p_type)
	Charge un plug-in de rendu, selon le type de rendu. Plus de détails...

C3D_API void	postEvent (FrameEventUPtr &&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 (ShaderModel 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 const &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::ImageCache const &	getImageCache () const
	Récupère la collection d'images. Plus de détails...

castor::ImageCache &	getImageCache ()
	Récupère la collection d'images. Plus de détails...

castor::FontCache const &	getFontCache () const
	Récupère la collection de polices. Plus de détails...

castor::FontCache &	getFontCache ()
	Récupère la collection de polices. Plus de détails...

UserInputListenerSPtr	getUserInputListener ()

void	setUserInputListener (UserInputListenerSPtr p_listener)
	Définit le listener d'entrées utilisateur. Plus de détails...

RenderSystem *	getRenderSystem () const
	Récupère le RenderSystem. 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 ()

RenderSystemFactory const &	getRenderSystemFactory () const

RenderSystemFactory &	getRenderSystemFactory ()

MeshFactory const &	getMeshFactory () const

MeshFactory &	getMeshFactory ()

SubdividerFactory const &	getSubdividerFactory () const

SubdividerFactory &	getSubdividerFactory ()

ImporterFactory const &	getImporterFactory () const

ImporterFactory &	getImporterFactory ()

ParticleFactory &	getParticleFactory ()

castor::CpuInformations const &	getCpuInformations () const

MaterialType	getMaterialsType () const

void	setMaterialsType (MaterialType p_type)
	Définit le type des matériaux. Plus de détails...

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

◆ Engine()

C3D_API castor3d::Engine::Engine ( )

Constructeur.

◆ ~Engine()

C3D_API castor3d::Engine::~Engine ( )

Destructeur.

Documentation des fonctions membres

◆ cleanup()

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

◆ getAdditionalParsers()

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.

◆ getAdditionalSections()

std::map< castor::String, castor::StrUIntMap > const& castor3d::Engine::getAdditionalSections ( ) const

inline

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

Renvoie: Les sections.

◆ getCpuInformations()

castor::CpuInformations const& castor3d::Engine::getCpuInformations ( ) const

inline

Renvoie: Les informations CPU.

◆ getDataDirectory()

static C3D_API castor::Path castor3d::Engine::getDataDirectory ( )

static

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

Renvoie: Le chemin des données

◆ getDefaultSampler()

SamplerSPtr castor3d::Engine::getDefaultSampler ( ) const

inline

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

Renvoie: Le Sampler

◆ getEngineDirectory()

static C3D_API castor::Path castor3d::Engine::getEngineDirectory ( )

static

donne le répertoire du Castor

Renvoie: Le répertoire

◆ getFontCache() [1/2]

castor::FontCache const& castor3d::Engine::getFontCache ( ) const

inline

Récupère la collection de polices.

Renvoie: La collection

◆ getFontCache() [2/2]

castor::FontCache& castor3d::Engine::getFontCache ( )

inline

Récupère la collection de polices.

Renvoie: La collection

◆ getImageCache() [1/2]

castor::ImageCache const& castor3d::Engine::getImageCache ( ) const

inline

Récupère la collection d'images.

Renvoie: La collection

◆ getImageCache() [2/2]

castor::ImageCache& castor3d::Engine::getImageCache ( )

inline

Récupère la collection d'images.

Renvoie: La collection

◆ getImporterFactory() [1/2]

ImporterFactory const& castor3d::Engine::getImporterFactory ( ) const

inline

Renvoie: La fabrique de Importer.

◆ getImporterFactory() [2/2]

ImporterFactory& castor3d::Engine::getImporterFactory ( )

inline

Renvoie: La fabrique de Subdivider.

◆ getLightsSampler()

SamplerSPtr castor3d::Engine::getLightsSampler ( ) const

inline

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

Renvoie: Le Sampler.

◆ getMaterialsType()

MaterialType castor3d::Engine::getMaterialsType ( ) const

inline

Renvoie: Le type des matériaux.

◆ getMeshFactory() [1/2]

MeshFactory const& castor3d::Engine::getMeshFactory ( ) const

inline

Renvoie: La fabrique de MeshGenerator.

◆ getMeshFactory() [2/2]

MeshFactory& castor3d::Engine::getMeshFactory ( )

inline

Renvoie: La fabrique de MeshGenerator.

◆ getParticleFactory()

ParticleFactory& castor3d::Engine::getParticleFactory ( )

inline

Renvoie: La fabrique de CpuParticleSystem.

◆ getPerObjectLighting()

bool castor3d::Engine::getPerObjectLighting ( )

inline

Renvoie: Le besoin d'un éclairage par objet.

◆ getPluginsDirectory()

static C3D_API castor::Path castor3d::Engine::getPluginsDirectory ( )

static

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

Renvoie: Le chemin des plug-ins

◆ getRenderLoop() [1/2]

RenderLoop const& castor3d::Engine::getRenderLoop ( ) const

inline

Renvoie: La boucle de rendu.

◆ getRenderLoop() [2/2]

RenderLoop& castor3d::Engine::getRenderLoop ( )

inline

Renvoie: La boucle de rendu.

◆ getRenderSystem()

RenderSystem* castor3d::Engine::getRenderSystem ( ) const

inline

Récupère le RenderSystem.

Renvoie: Le RenderSystem

◆ getRenderSystemFactory() [1/2]

RenderSystemFactory const& castor3d::Engine::getRenderSystemFactory ( ) const

inline

Renvoie: La fabrique de RenderSystem.

◆ getRenderSystemFactory() [2/2]

RenderSystemFactory& castor3d::Engine::getRenderSystemFactory ( )

inline

Renvoie: La fabrique de RenderSystem.

◆ getSubdividerFactory() [1/2]

SubdividerFactory const& castor3d::Engine::getSubdividerFactory ( ) const

inline

Renvoie: La fabrique de Subdivider.

◆ getSubdividerFactory() [2/2]

SubdividerFactory& castor3d::Engine::getSubdividerFactory ( )

inline

Renvoie: La fabrique de Subdivider.

◆ getUserInputListener()

UserInputListenerSPtr castor3d::Engine::getUserInputListener ( )

inline

Renvoie: Le listener d'entrées utilisateur.

◆ getVersion()

Version const& castor3d::Engine::getVersion ( ) const

inline

Renvoie: La version du moteur.

◆ hasRenderLoop()

bool castor3d::Engine::hasRenderLoop ( ) const

inline

Renvoie: La boucle de rendu.

◆ initialise()

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é

◆ isCleaned()

C3D_API bool castor3d::Engine::isCleaned ( )

Récupère le statut de nettoyage.

Remarques: Thread-safe

Renvoie: true si nettoyé

◆ isThreaded()

bool castor3d::Engine::isThreaded ( )

inline

Renvoie: Dit si le moteur utilise un boucle de rendu asynchrone.

◆ loadRenderer()

C3D_API bool castor3d::Engine::loadRenderer ( castor::String const & 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é

◆ postEvent()

C3D_API void castor3d::Engine::postEvent ( FrameEventUPtr && p_pEvent )

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

Paramètres

[in] p_pEvent L'évènement

◆ registerParsers()

C3D_API void castor3d::Engine::registerParsers	(	castor::String const &	p_name,
		castor::FileParser::AttributeParsersBySection const &	p_parsers
	)

Enregistre des analyseurs supplémentaires pour SceneFileParser.

Paramètres

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

◆ registerSections()

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.

◆ setCleaned()

C3D_API void castor3d::Engine::setCleaned ( )

Dit que le moteur est nettoyé

Remarques: Thread-safe

◆ setMaterialsType()

void castor3d::Engine::setMaterialsType ( MaterialType p_type )

inline

Définit le type des matériaux.

Paramètres

[in] p_type La nouvelle valeur.

◆ setPerObjectLighting()

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.

◆ setUserInputListener()

void castor3d::Engine::setUserInputListener ( UserInputListenerSPtr p_listener )

inline

Définit le listener d'entrées utilisateur.

Paramètres

[in] p_listener La nouvelle valeur.

◆ supportsShaderModel()

C3D_API bool castor3d::Engine::supportsShaderModel ( ShaderModel 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

◆ unregisterParsers()

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.

◆ unregisterSections()

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 :

Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Engine.hpp

Fonctions membres publiques

Fonctions membres publiques statiques

Description détaillée

Documentation des constructeurs et destructeur

◆ Engine()

◆ ~Engine()

Documentation des fonctions membres

◆ cleanup()

◆ getAdditionalParsers()

◆ getAdditionalSections()

◆ getCpuInformations()

◆ getDataDirectory()

◆ getDefaultSampler()

◆ getEngineDirectory()

◆ getFontCache() [1/2]

◆ getFontCache() [2/2]

◆ getImageCache() [1/2]

◆ getImageCache() [2/2]

◆ getImporterFactory() [1/2]

◆ getImporterFactory() [2/2]

◆ getLightsSampler()

◆ getMaterialsType()

◆ getMeshFactory() [1/2]

◆ getMeshFactory() [2/2]

◆ getParticleFactory()

◆ getPerObjectLighting()

◆ getPluginsDirectory()

◆ getRenderLoop() [1/2]

◆ getRenderLoop() [2/2]

◆ getRenderSystem()

◆ getRenderSystemFactory() [1/2]

◆ getRenderSystemFactory() [2/2]

◆ getSubdividerFactory() [1/2]

◆ getSubdividerFactory() [2/2]

◆ getUserInputListener()

◆ getVersion()

◆ hasRenderLoop()

◆ initialise()

◆ isCleaned()

◆ isThreaded()

◆ loadRenderer()

◆ postEvent()

◆ registerParsers()

◆ registerSections()

◆ setCleaned()

◆ setMaterialsType()

◆ setPerObjectLighting()

◆ setUserInputListener()

◆ supportsShaderModel()

◆ unregisterParsers()

◆ unregisterSections()