Castor3D::Importer Class Reference

Base class for external file import. More...

Inheritance diagram for Castor3D::Importer:

Collaboration diagram for Castor3D::Importer:

Public Member Functions
C3D_API	Importer (Engine &p_engine)
	Constructor. More...
C3D_API SceneSPtr	ImportScene (Castor::Path const &p_pathFile, Parameters const &p_parameters)
	Scene import Function. More...
C3D_API MeshSPtr	ImportMesh (Scene &p_scene, Castor::Path const &p_pathFile, Parameters const &p_parameters)
	Mesh import Function. More...
C3D_API TextureUnitSPtr	LoadTexture (Castor::Path const &p_path, Pass &p_pass, eTEXTURE_CHANNEL p_channel)
	Loads a texture and adds it to the given pass. More...

Protected Member Functions
virtual C3D_API SceneSPtr	DoImportScene ()=0
	Scene import Function. More...
virtual C3D_API MeshSPtr	DoImportMesh (Scene &p_scene)=0
	Mesh import Function. More...

Protected Attributes
Castor::Path	m_fileName
	The file name. More...
Castor::Path	m_filePath
	The file full path. More...
SceneNodePtrArray	m_nodes
	The loaded scene nodes. More...
GeometryPtrStrMap	m_geometries
	The loaded geometries. More...
Parameters	m_parameters
	Import configuration parameters. More...

Detailed Description

Base class for external file import.

Author

Sylvain DOREMUS

Version

0.1

Date

25/08/2010

Constructor & Destructor Documentation

Importer()

C3D_API Castor3D::Importer::Importer

(

Engine &

p_engine

)

Constructor.

Parameters

[in]

p_engine

The core engine

Member Function Documentation

DoImportMesh()

virtual C3D_API MeshSPtr Castor3D::Importer::DoImportMesh ( Scene &  p_scene )

protectedpure virtual

Mesh import Function.

Parameters

[in]

p_scene

The scene into which the Mesh is loaded.

Returns

The imported Mesh

DoImportScene()

virtual C3D_API SceneSPtr Castor3D::Importer::DoImportScene ( )

protectedpure virtual

Scene import Function.

Returns

The imported Scene

ImportMesh()

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

Mesh import Function.

Parameters

[in]	p_scene	The scene into which the Mesh is loaded.
[in]	p_pathFile	The location of the file to import
[in]	p_parameters	Import configuration parameters

Returns

The imported Mesh

ImportScene()

C3D_API SceneSPtr Castor3D::Importer::ImportScene	(	Castor::Path const &	p_pathFile,
		Parameters const &	p_parameters
	)

Scene import Function.

Parameters

[in]	p_pathFile	The location of the file to import
[in]	p_parameters	Import configuration parameters

Returns

The imported Scene

LoadTexture()

C3D_API TextureUnitSPtr Castor3D::Importer::LoadTexture	(	Castor::Path const &	p_path,
		Pass &	p_pass,
		eTEXTURE_CHANNEL	p_channel
	)

Loads a texture and adds it to the given pass.

Parameters

[in]	p_path	The image file path (can be relative or absolute).
[in]	p_pass	The pass.
[in]	p_channel	The channel affected.

Returns

false if any error occured.

Member Data Documentation

m_fileName

Castor::Path Castor3D::Importer::m_fileName

protected

The file name.

m_filePath

Castor::Path Castor3D::Importer::m_filePath

protected

The file full path.

m_geometries

GeometryPtrStrMap Castor3D::Importer::m_geometries

protected

The loaded geometries.

m_nodes

SceneNodePtrArray Castor3D::Importer::m_nodes

protected

The loaded scene nodes.

m_parameters

Parameters Castor3D::Importer::m_parameters

protected

Import configuration parameters.

---

The documentation for this class was generated from the following file:

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