castor3d::LightImporter Class Reference

#include <LightImporter.hpp>

Inheritance diagram for castor3d::LightImporter:

Collaboration diagram for castor3d::LightImporter:

Public Member Functions
virtual	~LightImporter ()=default
C3D_API	LightImporter (Engine &engine, castor::String const &prefix)
	Constructor.
C3D_API LightUPtr	importData (castor::String const &name, LightCreateInfo const &createInfo, ImporterFile *file, Parameters const &parameters)
	Light import function.
C3D_API bool	importData (Light &light, ImporterFile *file, Parameters const &parameters)
	Light import function.
castor::StringView	getPrefix () const noexcept
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const noexcept
void	setOwner (Engine &owner) noexcept

Static Public Member Functions
static C3D_API bool	importData (Light &light, castor::Path const &pathFile, Parameters const &parameters)
	Light import Function.

Protected Attributes
castor::String	m_prefix
ImporterFile *	m_file {}
Parameters	m_parameters

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

Constructor & Destructor Documentation

~LightImporter()

virtual castor3d::LightImporter::~LightImporter ( )

virtualdefault

LightImporter()

C3D_API castor3d::LightImporter::LightImporter ( Engine & engine, castor::String const & prefix )

explicit

Constructor.

Parameters

[in]	engine	The engine.
[in]	prefix	The prefix used for logging.

Member Function Documentation

getPrefix()

castor::StringView castor3d::LightImporter::getPrefix ( ) const

inlinenoexcept

References m_prefix.

importData() [1/3]

C3D_API LightUPtr castor3d::LightImporter::importData	(	castor::String const &	name,
		LightCreateInfo const &	createInfo,
		ImporterFile *	file,
		Parameters const &	parameters )

Light import function.

Parameters

[in]	name	The light name.
[in]	createInfo	The light creation informations.
[in]	file	The location of the file to import.
[in]	parameters	Import configuration parameters.

Returns

false if any problem occured.

importData() [2/3]

static C3D_API bool castor3d::LightImporter::importData ( Light & light, castor::Path const & pathFile, Parameters const & parameters )

static

Light import Function.

Parameters

[out]	light	Receives the imported data.
[in]	pathFile	The location of the file to import.
[in]	parameters	Import configuration parameters.

Returns

false if any problem occured.

importData() [3/3]

C3D_API bool castor3d::LightImporter::importData	(	Light &	light,
		ImporterFile *	file,
		Parameters const &	parameters )

Light import function.

Parameters

[out]	light	Receives the imported data.
[in]	file	The location of the file to import.
[in]	parameters	Import configuration parameters.

Returns

false if any problem occured.

Member Data Documentation

m_file

ImporterFile* castor3d::LightImporter::m_file {}

protected

m_parameters

Parameters castor3d::LightImporter::m_parameters

protected

m_prefix

castor::String castor3d::LightImporter::m_prefix

protected

Referenced by getPrefix().

---

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

• Castor3D/Scene/Light/LightImporter.hpp