Assimp::ExportProperties Class Reference

Public Types
typedef unsigned int	KeyType
typedef std::map< KeyType, int >	IntPropertyMap
typedef std::map< KeyType, ai_real >	FloatPropertyMap
typedef std::map< KeyType, std::string >	StringPropertyMap
typedef std::map< KeyType, aiMatrix4x4 >	MatrixPropertyMap

Public Member Functions
	ExportProperties ()
	Standard constructor. More...
	ExportProperties (const ExportProperties &other)
	Copy constructor. More...
bool	SetPropertyInteger (const char *szName, int iValue)
	Set an integer configuration property. More...
bool	SetPropertyBool (const char *szName, bool value)
	Set a boolean configuration property. More...
bool	SetPropertyFloat (const char *szName, ai_real fValue)
	Set a floating-point configuration property. More...
bool	SetPropertyString (const char *szName, const std::string &sValue)
	Set a string configuration property. More...
bool	SetPropertyMatrix (const char *szName, const aiMatrix4x4 &sValue)
	Set a matrix configuration property. More...
int	GetPropertyInteger (const char *szName, int iErrorReturn=0xffffffff) const
	Get a configuration property. More...
bool	GetPropertyBool (const char *szName, bool bErrorReturn=false) const
	Get a boolean configuration property. More...
ai_real	GetPropertyFloat (const char *szName, ai_real fErrorReturn=10e10f) const
	Get a floating-point configuration property. More...
const std::string	GetPropertyString (const char *szName, const std::string &sErrorReturn="") const
	Get a string configuration property. More...
const aiMatrix4x4	GetPropertyMatrix (const char *szName, const aiMatrix4x4 &sErrorReturn=aiMatrix4x4()) const
	Get a matrix configuration property. More...
bool	HasPropertyInteger (const char *szName) const
	Determine a integer configuration property has been set. More...
bool	HasPropertyBool (const char *szName) const
	Determine a boolean configuration property has been set. More...
bool	HasPropertyFloat (const char *szName) const
	Determine a boolean configuration property has been set. More...
bool	HasPropertyString (const char *szName) const
	Determine a String configuration property has been set. More...
bool	HasPropertyMatrix (const char *szName) const
	Determine a Matrix configuration property has been set. More...

Protected Attributes
IntPropertyMap	mIntProperties
	List of integer properties.
FloatPropertyMap	mFloatProperties
	List of floating-point properties.
StringPropertyMap	mStringProperties
	List of string properties.
MatrixPropertyMap	mMatrixProperties
	List of Matrix properties.

Constructor & Destructor Documentation

ExportProperties() [1/2]

Assimp::ExportProperties::ExportProperties

(

)

Standard constructor.

See also

ExportProperties()

ExportProperties() [2/2]

Assimp::ExportProperties::ExportProperties

(

const ExportProperties &

other

)

Copy constructor.

This copies the configuration properties of another ExportProperties.

See also

ExportProperties(const ExportProperties& other)

Member Function Documentation

GetPropertyBool()

bool Assimp::ExportProperties::GetPropertyBool ( const char *  szName, bool  bErrorReturn = false  ) const

inline

Get a boolean configuration property.

Boolean properties are stored on the integer stack internally so it's possible to set them via SetPropertyBool and query them with GetPropertyBool and vice versa.

See also

GetPropertyInteger()

GetPropertyFloat()

ai_real Assimp::ExportProperties::GetPropertyFloat	(	const char *	szName,
		ai_real	fErrorReturn = 10e10f
	)		const

Get a floating-point configuration property.

See also

GetPropertyInteger()

GetPropertyInteger()

int Assimp::ExportProperties::GetPropertyInteger	(	const char *	szName,
		int	iErrorReturn = 0xffffffff
	)		const

Get a configuration property.

Parameters

szName	Name of the property. All supported properties are defined in the aiConfig.g header (all constants share the prefix AI_CONFIG_XXX).
iErrorReturn	Value that is returned if the property is not found.

Returns

Current value of the property

Note

Property of different types (float, int, string ..) are kept on different lists, so calling SetPropertyInteger() for a floating-point property has no effect - the loader will call GetPropertyFloat() to read the property, but it won't be there.

GetPropertyMatrix()

const aiMatrix4x4 Assimp::ExportProperties::GetPropertyMatrix	(	const char *	szName,
		const aiMatrix4x4 &	sErrorReturn = aiMatrix4x4()
	)		const

Get a matrix configuration property.

The return value remains valid until the property is modified.

See also

GetPropertyInteger()

GetPropertyString()

const std::string Assimp::ExportProperties::GetPropertyString	(	const char *	szName,
		const std::string &	sErrorReturn = ""
	)		const

Get a string configuration property.

The return value remains valid until the property is modified.

See also

GetPropertyInteger()

HasPropertyBool()

bool Assimp::ExportProperties::HasPropertyBool

(

const char *

szName

)

const

Determine a boolean configuration property has been set.

See also

HasPropertyBool()

HasPropertyFloat()

bool Assimp::ExportProperties::HasPropertyFloat

(

const char *

szName

)

const

Determine a boolean configuration property has been set.

See also

HasPropertyFloat()

HasPropertyInteger()

bool Assimp::ExportProperties::HasPropertyInteger

(

const char *

szName

)

const

Determine a integer configuration property has been set.

See also

HasPropertyInteger()

HasPropertyMatrix()

bool Assimp::ExportProperties::HasPropertyMatrix

(

const char *

szName

)

const

Determine a Matrix configuration property has been set.

See also

HasPropertyMatrix()

HasPropertyString()

bool Assimp::ExportProperties::HasPropertyString

(

const char *

szName

)

const

Determine a String configuration property has been set.

See also

HasPropertyString()

SetPropertyBool()

bool Assimp::ExportProperties::SetPropertyBool ( const char *  szName, bool  value  )

inline

Set a boolean configuration property.

Boolean properties are stored on the integer stack internally so it's possible to set them via SetPropertyBool and query them with GetPropertyBool and vice versa.

See also

SetPropertyInteger()

SetPropertyFloat()

bool Assimp::ExportProperties::SetPropertyFloat	(	const char *	szName,
		ai_real	fValue
	)

Set a floating-point configuration property.

See also

SetPropertyInteger()

SetPropertyInteger()

bool Assimp::ExportProperties::SetPropertyInteger	(	const char *	szName,
		int	iValue
	)

Set an integer configuration property.

Parameters

szName	Name of the property. All supported properties are defined in the aiConfig.g header (all constants share the prefix AI_CONFIG_XXX and are simple strings).
iValue	New value of the property

Returns

true if the property was set before. The new value replaces the previous value in this case.

Note

Property of different types (float, int, string ..) are kept on different stacks, so calling SetPropertyInteger() for a floating-point property has no effect - the loader will call GetPropertyFloat() to read the property, but it won't be there.

SetPropertyMatrix()

bool Assimp::ExportProperties::SetPropertyMatrix	(	const char *	szName,
		const aiMatrix4x4 &	sValue
	)

Set a matrix configuration property.

See also

SetPropertyInteger()

SetPropertyString()

bool Assimp::ExportProperties::SetPropertyString	(	const char *	szName,
		const std::string &	sValue
	)

Set a string configuration property.

See also

SetPropertyInteger()

---

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

• GraphicsII_2020C/include/assimp/Exporter.hpp