Castor3D 0.16.0
Multiplatform 3D engine
Fonctions membres publiques | Liste de tous les membres
Référence de la classe castor3d::SceneFileParser

#include <SceneFileParser.hpp>

Graphe d'héritage de castor3d::SceneFileParser:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::SceneFileParser:
Collaboration graph
[légende]

Fonctions membres publiques

C3D_API SceneFileParser (Engine &engine, ProgressBar *progress=nullptr)
 Constructeur.
 
C3D_API castor::FileParserContextUPtr initialiseParser (castor::Path const &path)
 
RenderWindowDesc getRenderWindow ()
 
ScenePtrStrMap::iterator scenesBegin ()
 
ScenePtrStrMap::const_iterator scenesBegin () const
 
ScenePtrStrMap::const_iterator scenesEnd () const
 
- Fonctions membres publiques hérités de castor::OwnedBy< Engine >
Engine * getOwner () const
 L'objet propriétaire.
 
- Fonctions membres publiques hérités de castor::DataHolderT< RootContext >
 DataHolderT () noexcept=default
 
 DataHolderT (RootContext d) noexcept
 
RootContext & getData ()
 
RootContext const & getData () const
 
void setData (RootContext data)
 
- Fonctions membres publiques hérités de castor::FileParser
CU_API FileParser (SectionId rootSectionId, void *rootBlockContext=nullptr)
 Constructeur.
 
CU_API FileParser (LoggerInstance &logger, SectionId rootSectionId, void *rootBlockContext=nullptr)
 Constructeur.
 
virtual CU_API ~FileParser () noexcept=default
 Destructeur.
 
CU_API void registerParsers (String const &name, AdditionalParsers const &parsers)
 Enregistre des analyseurs supplémentaires.
 
CU_API void processFile (String const &appName, Path path, PreprocessedFile &preprocessed)
 Fonction de traitement.
 
CU_API void processFile (Path const &path, PreprocessedFile &preprocessed)
 Fonction de traitement.
 
CU_API void processFile (Path const &path, String const &content, PreprocessedFile &preprocessed)
 Fonction de traitement.
 
CU_API PreprocessedFile processFile (String const &appName, Path const &path)
 Fonction de traitement.
 
CU_API PreprocessedFile processFile (Path const &path)
 Fonction de traitement.
 
CU_API PreprocessedFile processFile (Path const &path, String const &content)
 Fonction de traitement.
 
CU_API bool parseFile (String const &appName, Path const &path)
 Fonction de traitement.
 
CU_API bool parseFile (Path const &path)
 Fonction de traitement.
 
CU_API bool parseFile (Path const &path, String const &content)
 Fonction de traitement.
 
CU_API void parseError (String const &functionName, uint64_t lineIndex, String const &error)
 Log une erreur dans le fichier de log.
 
CU_API void parseWarning (String const &functionName, uint64_t lineIndex, String const &warning)
 Log un avertissement dans le fichier de log.
 
CU_API void addParser (SectionId oldSection, SectionId newSection, String const &name, ParserFunction const &function, ParserParameterArray const &params=ParserParameterArray())
 Ajoute une fonction d'analyse à la liste.
 
CU_API void addParser (SectionId section, String const &name, ParserFunction const &function, ParserParameterArray const &params=ParserParameterArray())
 Ajoute une fonction d'analyse à la liste.
 
bool isIgnored () const
 Dit si les lignes suivantes doivent être ignorées.
 
void ignore ()
 Incrémente le niveau d'ignorés.
 
LoggerInstancegetLogger () const
 
SectionId getRootSectionId () const
 
void * getRootBlockContext () const
 
void validate (PreprocessedFile &preprocessed)
 
String getSectionName (SectionId section) const
 
void cleanupParser (PreprocessedFile &preprocessed)
 
auto const & getAdditionalParsers () const
 

Membres hérités additionnels

- Fonctions membres protégées hérités de castor::OwnedBy< Engine >
 OwnedBy (Engine &owner)
 Constructeur.
 
- Fonctions membres protégées hérités de castor::FileParser
virtual CU_API bool doDiscardParser (PreprocessedFile &preprocessed, StringView line)
 Fonction appelée si aucun analyseur n'est trouvé pour traiter la ligne.
 
- Fonctions membres protégées hérités de castor::NonMovable
 NonMovable ()=default
 Constructeur.
 
 ~NonMovable () noexcept=default
 Destructeur.
 
- Attributs protégés hérités de castor::FileParser
LoggerInstancem_logger
 
AttributeParsers m_parsers
 
bool m_ignored { false }
 
StrStrMap m_defines
 

Documentation des constructeurs et destructeur

◆ SceneFileParser()

C3D_API castor3d::SceneFileParser::SceneFileParser ( Engine & engine,
ProgressBar * progress = nullptr )
explicit

Constructeur.

Paramètres
[in]engineLe moteur.
[in,out]progressBarre de progression optionnelle.

Documentation des fonctions membres

◆ getRenderWindow()

RenderWindowDesc castor3d::SceneFileParser::getRenderWindow ( )
inline
Renvoie
La fenêtre de rendu définie par la scène.

Références castor::DataHolderT< RootContext >::getData().

Voici le graphe d'appel pour cette fonction :

◆ initialiseParser()

C3D_API castor::FileParserContextUPtr castor3d::SceneFileParser::initialiseParser ( castor::Path const & path)

◆ scenesBegin() [1/2]

ScenePtrStrMap::iterator castor3d::SceneFileParser::scenesBegin ( )
inline

Références castor::DataHolderT< RootContext >::getData().

Voici le graphe d'appel pour cette fonction :

◆ scenesBegin() [2/2]

ScenePtrStrMap::const_iterator castor3d::SceneFileParser::scenesBegin ( ) const
inline

Références castor::DataHolderT< RootContext >::getData().

Voici le graphe d'appel pour cette fonction :

◆ scenesEnd()

ScenePtrStrMap::const_iterator castor3d::SceneFileParser::scenesEnd ( ) const
inline

Références castor::DataHolderT< RootContext >::getData().

Voici le graphe d'appel pour cette fonction :

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