castor3d::MeshImporter Class Reference

#include <Importer.hpp>

Inheritance diagram for castor3d::MeshImporter:

Collaboration diagram for castor3d::MeshImporter:

Public Member Functions
virtual	~MeshImporter ()=default
C3D_API	MeshImporter (Engine &engine)
	Constructor. More...
C3D_API bool	import (Mesh &mesh, castor::Path const &pathFile, Parameters const &parameters, bool initialise)
	Mesh import Function. More...
C3D_API bool	import (Scene &scene, castor::Path const &pathFile, Parameters const &parameters, std::map< TextureFlag, TextureConfiguration > const &textureRemaps, bool initialise)
	Scene import Function. More...
C3D_API castor::ImageSPtr	loadImage (castor::String const &name, castor::ImageCreateParams const &params) const
	Loads an image. More...
C3D_API castor::ImageSPtr	loadImage (castor::Path const &path) const
	Loads an image from a file. More...
C3D_API castor::ImageSPtr	loadImage (castor::String name, castor::String type, castor::ByteArray data) const
	Loads a texture. More...
C3D_API TextureSourceInfo	loadTexture (castor3d::SamplerRes sampler, castor::Path const &path, TextureConfiguration const &config) const
	Loads a texture. More...
C3D_API TextureSourceInfo	loadTexture (castor3d::SamplerRes sampler, castor::String name, castor::String type, castor::ByteArray data, TextureConfiguration const &config) const
	Loads a texture. More...
C3D_API bool	convertToNormalMap (castor::Path &path, castor3d::TextureConfiguration &config) const
	Converts given height image file to a normal+height image. More...

Protected Member Functions
virtual C3D_API bool	doImportMesh (Mesh &mesh)=0
	Mesh import Function. More...
virtual C3D_API bool	doImportScene (Scene &scene)=0
	Scene 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...
MeshPtrStrMap	m_meshes
	The loaded meshes. More...
Parameters	m_parameters
	Import configuration parameters. More...
std::map< TextureFlag, TextureConfiguration >	m_textureRemaps
	Import texture remapping parameters. More...

Constructor & Destructor Documentation

~MeshImporter()

virtual castor3d::MeshImporter::~MeshImporter ( )

virtualdefault

MeshImporter()

C3D_API castor3d::MeshImporter::MeshImporter ( Engine &  engine )

explicit

Constructor.

Parameters

[in]

engine

The engine.

Member Function Documentation

convertToNormalMap()

C3D_API bool castor3d::MeshImporter::convertToNormalMap	(	castor::Path &	path,
		castor3d::TextureConfiguration &	config
	)		const

Converts given height image file to a normal+height image.

Parameters

[in,out]	path	The image file path (can be relative or absolute), receives the resulting normal+height image file path.
[in,out]	config	The texture unit configuration.

Returns

false if any error occured.

doImportMesh()

virtual C3D_API bool castor3d::MeshImporter::doImportMesh ( Mesh &  mesh )

protectedpure virtual

Mesh import Function.

Parameters

[out]

mesh

Receives the imported data.

Returns

false if any problem occured.

Implemented in castor3d::CmshImporter.

doImportScene()

virtual C3D_API bool castor3d::MeshImporter::doImportScene ( Scene &  scene )

protectedpure virtual

Scene import Function.

Parameters

[out]

scene

Receives the imported data.

Returns

false if any problem occured.

Implemented in castor3d::CmshImporter.

import() [1/2]

C3D_API bool castor3d::MeshImporter::import	(	Mesh &	mesh,
		castor::Path const &	pathFile,
		Parameters const &	parameters,
		bool	initialise
	)

Mesh import Function.

Parameters

[out]	mesh	Receives the imported data.
[in]	pathFile	The location of the file to import.
[in]	parameters	Import configuration parameters.
[in]	initialise	Tells if the imported mesh must be initialised.

Returns

false if any problem occured.

import() [2/2]

C3D_API bool castor3d::MeshImporter::import	(	Scene &	scene,
		castor::Path const &	pathFile,
		Parameters const &	parameters,
		std::map< TextureFlag, TextureConfiguration > const &	textureRemaps,
		bool	initialise
	)

Scene import Function.

Parameters

[out]	scene	Receives the imported data.
[in]	pathFile	The location of the file to import.
[in]	parameters	Import configuration parameters.
[in]	textureRemaps	The imported textures remapping parameters.
[in]	initialise	Tells if the imported meshes must be initialised.

Returns

false if any problem occured.

loadImage() [1/3]

C3D_API castor::ImageSPtr castor3d::MeshImporter::loadImage

(

castor::Path const &

path

)

const

Loads an image from a file.

Parameters

[in]

path

The image file path (can be relative or absolute).

Returns

The image.

loadImage() [2/3]

C3D_API castor::ImageSPtr castor3d::MeshImporter::loadImage	(	castor::String const &	name,
		castor::ImageCreateParams const &	params
	)		const

Loads an image.

Parameters

[in]	name	The image name.
[in]	params	The image creation parameters.

Returns

The image.

loadImage() [3/3]

C3D_API castor::ImageSPtr castor3d::MeshImporter::loadImage	(	castor::String	name,
		castor::String	type,
		castor::ByteArray	data
	)		const

Loads a texture.

Parameters

[in]	name	The image name.
[in]	type	The image data type.
[in]	data	The image data.

Returns

The texture unit.

loadTexture() [1/2]

C3D_API TextureSourceInfo castor3d::MeshImporter::loadTexture	(	castor3d::SamplerRes	sampler,
		castor::Path const &	path,
		TextureConfiguration const &	config
	)		const

Loads a texture.

Parameters

[in]	sampler	The sampler used by the texture.
[in]	path	The image file path (can be relative or absolute).
[in]	config	The texture unit configuration.

Returns

The texture unit.

loadTexture() [2/2]

C3D_API TextureSourceInfo castor3d::MeshImporter::loadTexture	(	castor3d::SamplerRes	sampler,
		castor::String	name,
		castor::String	type,
		castor::ByteArray	data,
		TextureConfiguration const &	config
	)		const

Loads a texture.

Parameters

[in]	sampler	The sampler used by the texture.
[in]	name	The image name.
[in]	type	The image data type.
[in]	data	The image data.
[in]	config	The texture unit configuration.

Returns

The texture unit.

Member Data Documentation

m_fileName

castor::Path castor3d::MeshImporter::m_fileName

protected

The file name.

m_filePath

castor::Path castor3d::MeshImporter::m_filePath

protected

The file full path.

m_geometries

GeometryPtrStrMap castor3d::MeshImporter::m_geometries

protected

The loaded geometries.

m_meshes

MeshPtrStrMap castor3d::MeshImporter::m_meshes

protected

The loaded meshes.

m_nodes

SceneNodePtrArray castor3d::MeshImporter::m_nodes

protected

The loaded scene nodes.

m_parameters

Parameters castor3d::MeshImporter::m_parameters

protected

Import configuration parameters.

m_textureRemaps

std::map< TextureFlag, TextureConfiguration > castor3d::MeshImporter::m_textureRemaps

protected

Import texture remapping parameters.

---

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

• Model/Mesh/Importer.hpp