Description

Classes for the management of scenes, for example loading and saving of scenes from and to the file system. Global registration for Nodes and States .

Namespaces

   
namespace MinSG::SceneManagement::Consts
namespace MinSG::SceneManagement::ExporterTools
namespace MinSG::SceneManagement::ImporterTools
namespace MinSG::SceneManagement::ReaderDAE
namespace MinSG::SceneManagement::ReaderMinSG

Classes

   
struct MinSG::SceneManagement::ExporterContext
class MinSG::SceneManagement::ImportContext
class MinSG::SceneManagement::MeshImportHandler
class MinSG::SceneManagement::SceneManager
class MinSG::SceneManagement::TreeRegistry
class MinSG::SceneManagement::WriterDAE
struct MinSG::SceneManagement::WriterMinSG

Typedefs

   
   
typedef Util::GenericAttributeMap DescriptionMap
   
typedef Util::GenericAttributeList DescriptionArray
   
typedef uint32_t importOption_t
   
typedef Util::WrapperAttribute < std::vector< float > > floatVecWrapper_t
   
typedef Util::WrapperAttribute < std::vector< uint32_t > > uint32VecWrapper_t

Variables

   
   
const importOption_t IMPORT_OPTION_NONE
   
const importOption_t IMPORT_OPTION_REUSE_EXISTING_STATES
   
const importOption_t IMPORT_OPTION_DAE_INVERT_TRANSPARENCY
   
const importOption_t IMPORT_OPTION_USE_TEXTURE_REGISTRY
   
const importOption_t IMPORT_OPTION_USE_MESH_REGISTRY
   
const importOption_t IMPORT_OPTION_USE_MESH_HASHING_REGISTRY

Functions

   
   
void initExtBehaviourExporter()
   
void initExtNodeExporter()
   
void initExtStateExporter()
   
void initExtAdditionalDataImporter()
   
void initExtBehaviourImporter()
   
void initExtNodeImporter()
   
void initExtStateImporter()
   
void initCoreNodeExporter()
   
void initCoreStateExporter()
   
void saveMinSGFile( SceneManager & sm, const Util::FileName & fileName, const std::deque< Node * > & nodes)
   
void saveMinSGStream( SceneManager & sm, std::ostream & out, const std::deque< Node * > & nodes)
   
void saveMeshesInSubtreeAsPLY( Node * rootNode, const std::string & dirName, bool saveRegisteredNodes)
   
void saveMeshesInSubtreeAsMMF( Node * rootNode, const std::string & dirName, bool saveRegisteredNodes)
   
void initCoreNodeImporter()
   
void initCoreStateImporter()
   
std::vector< Util::Reference < Node > > loadMinSGFile( SceneManager & sm, const Util::FileName & fileName, const importOption_t importOptions)
   
std::vector< Util::Reference < Node > > loadMinSGFile( ImportContext & importContext, const Util::FileName & fileName)
   
std::vector< Util::Reference < Node > > loadMinSGStream( ImportContext & importContext, std::istream & in)
   
GroupNode * loadCOLLADA( SceneManager & sm, const Util::FileName & fileName, const importOption_t importOptions)
   
GroupNode * loadCOLLADA( ImportContext & importContext, const Util::FileName & fileName)
   
ImportContext createImportContext( SceneManager & sm, const importOption_t importOptions)

Documentation

typedef
MinSG::SceneManagement::DescriptionMap

public
 
 
typedef Util::GenericAttributeMap DescriptionMap

Defined in MinSG/SceneManagement/Exporter/ExporterContext.h:34

typedef
MinSG::SceneManagement::DescriptionArray

public
 
 
typedef Util::GenericAttributeList DescriptionArray

Defined in MinSG/SceneManagement/Importer/ImporterTools.h:30

typedef
MinSG::SceneManagement::importOption_t

public
 
 
typedef uint32_t importOption_t

Defined in MinSG/SceneManagement/ImportFunctions.h:27

typedef
MinSG::SceneManagement::floatVecWrapper_t

public
 
 
typedef Util::WrapperAttribute < std::vector< float > > floatVecWrapper_t

Defined in MinSG/SceneManagement/SceneDescription.h:29

typedef
MinSG::SceneManagement::uint32VecWrapper_t

public
 
 
typedef Util::WrapperAttribute < std::vector< uint32_t > > uint32VecWrapper_t

Defined in MinSG/SceneManagement/SceneDescription.h:30

variable
MinSG::SceneManagement::IMPORT_OPTION_NONE

public static
 
 
const importOption_t IMPORT_OPTION_NONE

Defined in MinSG/SceneManagement/ImportFunctions.h:28

variable
MinSG::SceneManagement::IMPORT_OPTION_REUSE_EXISTING_STATES

public static
 
 
const importOption_t IMPORT_OPTION_REUSE_EXISTING_STATES

Defined in MinSG/SceneManagement/ImportFunctions.h:29

variable
MinSG::SceneManagement::IMPORT_OPTION_DAE_INVERT_TRANSPARENCY

public static
 
 
const importOption_t IMPORT_OPTION_DAE_INVERT_TRANSPARENCY

Defined in MinSG/SceneManagement/ImportFunctions.h:30

variable
MinSG::SceneManagement::IMPORT_OPTION_USE_TEXTURE_REGISTRY

public static
 
 
const importOption_t IMPORT_OPTION_USE_TEXTURE_REGISTRY

Defined in MinSG/SceneManagement/ImportFunctions.h:31

variable
MinSG::SceneManagement::IMPORT_OPTION_USE_MESH_REGISTRY

public static
 
 
const importOption_t IMPORT_OPTION_USE_MESH_REGISTRY

Defined in MinSG/SceneManagement/ImportFunctions.h:32

variable
MinSG::SceneManagement::IMPORT_OPTION_USE_MESH_HASHING_REGISTRY

public static
 
 
const importOption_t IMPORT_OPTION_USE_MESH_HASHING_REGISTRY

Defined in MinSG/SceneManagement/ImportFunctions.h:33

function
MinSG::SceneManagement::initExtBehaviourExporter

public
   
   
void initExtBehaviourExporter( )

Defined in MinSG/Ext/SceneManagement/Exporter/ExtBehaviourExporter.h:17

function
MinSG::SceneManagement::initExtNodeExporter

public
   
   
void initExtNodeExporter( )

Defined in MinSG/Ext/SceneManagement/Exporter/ExtNodeExporter.h:17

function
MinSG::SceneManagement::initExtStateExporter

public
   
   
void initExtStateExporter( )

Defined in MinSG/Ext/SceneManagement/Exporter/ExtStateExporter.h:17

function
MinSG::SceneManagement::initExtAdditionalDataImporter

public
   
   
void initExtAdditionalDataImporter( )

Defined in MinSG/Ext/SceneManagement/Importer/ExtAdditionalDataImporter.h:17

function
MinSG::SceneManagement::initExtBehaviourImporter

public
   
   
void initExtBehaviourImporter( )

Defined in MinSG/Ext/SceneManagement/Importer/ExtBehaviourImporter.h:17

function
MinSG::SceneManagement::initExtNodeImporter

public
   
   
void initExtNodeImporter( )

Defined in MinSG/Ext/SceneManagement/Importer/ExtNodeImporter.h:17

function
MinSG::SceneManagement::initExtStateImporter

public
   
   
void initExtStateImporter( )

Defined in MinSG/Ext/SceneManagement/Importer/ExtStateImporter.h:17

function
MinSG::SceneManagement::initCoreNodeExporter

public
   
   
void initCoreNodeExporter( )

Defined in MinSG/SceneManagement/Exporter/CoreNodeExporter.h:17

function
MinSG::SceneManagement::initCoreStateExporter

public
   
   
void initCoreStateExporter( )

Defined in MinSG/SceneManagement/Exporter/CoreStateExporter.h:17

function
MinSG::SceneManagement::saveMinSGFile

public
     
     
void saveMinSGFile( SceneManager & sm,
  const Util::FileName & fileName,
  const std::deque< Node * > & nodes
)    

Save MinSG nodes to a file. Throws an exception on failure.

Parameters

fileName
Path that the new MinSG XML file will be saved to
nodes
Array of nodes that will be saved

Defined in MinSG/SceneManagement/ExportFunctions.h:27

function
MinSG::SceneManagement::saveMinSGStream

public
     
     
void saveMinSGStream( SceneManager & sm,
  std::ostream & out,
  const std::deque< Node * > & nodes
)    

Save MinSG nodes to a stream. Throws an exception on failure.

Parameters

out
Output stream to which the MinSG XML data will be written
nodes
Array of nodes that will be saved

Defined in MinSG/SceneManagement/ExportFunctions.h:32

function
MinSG::SceneManagement::saveMeshesInSubtreeAsPLY

public
     
     
void saveMeshesInSubtreeAsPLY( Node * rootNode,
  const std::string & dirName,
  bool saveRegisteredNodes
)    

Traverses the scene graph belowrootNodeand saves all meshes that are found in GeometryNodes and that are not saved yet into PLY files in a separate directory.

Parameters

rootNode
Root of scene graph that will be traversed.
dirName
Name of directory that is used to store the meshes.
saveRegisteredNodes
If true, even already saved meshes are exported.

Defined in MinSG/SceneManagement/ExportFunctions.h:43

function
MinSG::SceneManagement::saveMeshesInSubtreeAsMMF

public
     
     
void saveMeshesInSubtreeAsMMF( Node * rootNode,
  const std::string & dirName,
  bool saveRegisteredNodes
)    

Traverses the scene graph belowrootNodeand saves all meshes that are found in GeometryNodes and that are not saved yet into MMF files in a separate directory.

Parameters

rootNode
Root of scene graph that will be traversed.
dirName
Name of directory that is used to store the meshes.
saveRegisteredNodes
If true, even already saved meshes are exported.

Defined in MinSG/SceneManagement/ExportFunctions.h:53

function
MinSG::SceneManagement::initCoreNodeImporter

public
   
   
void initCoreNodeImporter( )

Defined in MinSG/SceneManagement/Importer/CoreNodeImporter.h:17

function
MinSG::SceneManagement::initCoreStateImporter

public
   
   
void initCoreStateImporter( )

Defined in MinSG/SceneManagement/Importer/CoreStateImporter.h:17

function
MinSG::SceneManagement::loadMinSGFile

public
     
     
std::vector< Util::Reference < Node > > loadMinSGFile( SceneManager & sm,
  const Util::FileName & fileName,
  const importOption_t importOptions
)    

Load MinSG nodes from a file.

Parameters

fileName
Path to a MinSG XML file
importOptions
Options controlling the import procedure

Returns

Array of MinSG nodes. In case of an error, an empty array will be returned.

Defined in MinSG/SceneManagement/ImportFunctions.h:43

function
MinSG::SceneManagement::loadMinSGFile

public
     
     
std::vector< Util::Reference < Node > > loadMinSGFile( ImportContext & importContext,
  const Util::FileName & fileName
)    

Load MinSG nodes from a file.

Parameters

importContext
Context that is used for the import procedure
fileName
Path to a MinSG XML file

Returns

Array of MinSG nodes. In case of an error, an empty array will be returned.

Defined in MinSG/SceneManagement/ImportFunctions.h:52

function
MinSG::SceneManagement::loadMinSGStream

public
     
     
std::vector< Util::Reference < Node > > loadMinSGStream( ImportContext & importContext,
  std::istream & in
)    

Load MinSG nodes from a stream.

Parameters

importContext
Context that is used for the import procedure
in
Input stream providing MinSG XML data

Returns

Array of MinSG nodes. In case of an error, an empty array will be returned.

Defined in MinSG/SceneManagement/ImportFunctions.h:61

function
MinSG::SceneManagement::loadCOLLADA

public
     
     
GroupNode * loadCOLLADA( SceneManager & sm,
  const Util::FileName & fileName,
  const importOption_t importOptions
)    

Defined in MinSG/SceneManagement/ImportFunctions.h:63

function
MinSG::SceneManagement::loadCOLLADA

public
     
     
GroupNode * loadCOLLADA( ImportContext & importContext,
  const Util::FileName & fileName
)    

Defined in MinSG/SceneManagement/ImportFunctions.h:64

function
MinSG::SceneManagement::createImportContext

public
     
     
ImportContext createImportContext( SceneManager & sm,
  const importOption_t importOptions
)    

Defined in MinSG/SceneManagement/ImportFunctions.h:66