castor3d::MaterialImporter Class Reference

#include <MaterialImporter.hpp>

Inheritance diagram for castor3d::MaterialImporter:

Collaboration diagram for castor3d::MaterialImporter:

Public Member Functions
virtual	~MaterialImporter ()=default
C3D_API	MaterialImporter (Engine &engine)
	Constructor.
C3D_API	MaterialImporter (Engine &engine, ImporterFile *file)
	Constructor.
C3D_API bool	import (Material &material, ImporterFile *file, Parameters const &parameters, castor::Map< PassComponentTextureFlag, TextureConfiguration > const &textureRemaps)
	Scene import Function.
C3D_API castor::ImageRPtr	loadImage (castor::String const &name, castor::ImageCreateParams const &params) const
	Loads an image.
C3D_API castor::ImageRPtr	loadImage (castor::Path const &path) const
	Loads an image from a file.
C3D_API castor::ImageRPtr	loadImage (castor::String const &name, castor::String type, castor::ByteArray data) const
	Loads a texture.
C3D_API TextureSourceInfo	loadTexture (castor::Path const &path, TextureConfiguration const &config) const
	Loads a texture.
C3D_API TextureSourceInfo	loadTexture (castor::String name, castor::String type, castor::ByteArray data, TextureConfiguration const &config) const
	Loads a texture.
C3D_API void	loadTexture (castor::Path const &path, TextureConfiguration const &config, PassTextureConfig const &passConfig, Pass &pass) const
	Loads a texture and adds it to the given pass.
C3D_API void	loadTexture (castor::String name, castor::String type, castor::ByteArray data, TextureConfiguration const &config, PassTextureConfig const &passConfig, Pass &pass) const
	Loads a texture and adds it to the given pass.
C3D_API bool	convertToNormalMap (castor::Path &path, castor3d::TextureConfiguration &config) const
	Converts given height image file to a normal+height image.
ImporterFile const *	getImporterFile () const noexcept
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const

Static Public Member Functions
static C3D_API bool	import (Material &material, castor::Path const &pathFile, Parameters const &parameters, castor::Map< PassComponentTextureFlag, TextureConfiguration > const &textureRemaps)
	Scene import Function.

Protected Attributes
ImporterFile *	m_file {}
Parameters	m_parameters
castor::Map< PassComponentTextureFlag, TextureConfiguration >	m_textureRemaps

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructor.

Constructor & Destructor Documentation

~MaterialImporter()

virtual castor3d::MaterialImporter::~MaterialImporter ( )

virtualdefault

MaterialImporter() [1/2]

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

explicit

Constructor.

Parameters

[in]

engine

The engine.

MaterialImporter() [2/2]

C3D_API castor3d::MaterialImporter::MaterialImporter ( Engine & engine, ImporterFile * file )

explicit

Constructor.

Parameters

[in]	engine	The engine.
[in]	file	The file to import.

Member Function Documentation

convertToNormalMap()

C3D_API bool castor3d::MaterialImporter::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.

getImporterFile()

ImporterFile const * castor3d::MaterialImporter::getImporterFile ( ) const

inlinenoexcept

References m_file.

import() [1/2]

static C3D_API bool castor3d::MaterialImporter::import ( Material & material, castor::Path const & pathFile, Parameters const & parameters, castor::Map< PassComponentTextureFlag, TextureConfiguration > const & textureRemaps )

static

Scene import Function.

Parameters

[out]	material	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.

Returns

false if any problem occured.

import() [2/2]

C3D_API bool castor3d::MaterialImporter::import	(	Material &	material,
		ImporterFile *	file,
		Parameters const &	parameters,
		castor::Map< PassComponentTextureFlag, TextureConfiguration > const &	textureRemaps )

Scene import Function.

Parameters

[out]	material	Receives the imported data.
[in]	file	The file to import.
[in]	parameters	Import configuration parameters.
[in]	textureRemaps	The imported textures remapping parameters.

Returns

false if any problem occured.

loadImage() [1/3]

C3D_API castor::ImageRPtr castor3d::MaterialImporter::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::ImageRPtr castor3d::MaterialImporter::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::ImageRPtr castor3d::MaterialImporter::loadImage	(	castor::String const &	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/4]

C3D_API TextureSourceInfo castor3d::MaterialImporter::loadTexture	(	castor::Path const &	path,
		TextureConfiguration const &	config ) const

Loads a texture.

Parameters

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

Returns

The texture unit.

loadTexture() [2/4]

C3D_API void castor3d::MaterialImporter::loadTexture	(	castor::Path const &	path,
		TextureConfiguration const &	config,
		PassTextureConfig const &	passConfig,
		Pass &	pass ) const

Loads a texture and adds it to the given pass.

Parameters

[in]	path	The image file path (can be relative or absolute).
[in]	passConfig	The texture configuration.
[in]	config	The texture unit configuration.
[in,out]	pass	Receives the loaded image.

loadTexture() [3/4]

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

Loads a texture.

Parameters

[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.

loadTexture() [4/4]

C3D_API void castor3d::MaterialImporter::loadTexture	(	castor::String	name,
		castor::String	type,
		castor::ByteArray	data,
		TextureConfiguration const &	config,
		PassTextureConfig const &	passConfig,
		Pass &	pass ) const

Loads a texture and adds it to the given pass.

Parameters

[in]	name	The image name.
[in]	type	The image data type.
[in]	data	The image data.
[in]	config	The texture configuration.
[in]	passConfig	The texture unit configuration.
[in,out]	pass	Receives the loaded image.

Member Data Documentation

m_file

ImporterFile* castor3d::MaterialImporter::m_file {}

protected

Referenced by getImporterFile().

m_parameters

Parameters castor3d::MaterialImporter::m_parameters

protected

m_textureRemaps

castor::Map< PassComponentTextureFlag, TextureConfiguration > castor3d::MaterialImporter::m_textureRemaps

protected

---

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

• Castor3D/Material/MaterialImporter.hpp