Path Tracer
Public Types | Public Member Functions | Public Attributes | List of all members
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, aiMatrix4x4MatrixPropertyMap
 
typedef std::map< KeyType, std::function< void *(void *)> > CallbackPropertyMap
 

Public Member Functions

 ExportProperties ()
 
 ExportProperties (const ExportProperties &other)
 
bool SetPropertyInteger (const char *szName, int iValue)
 
bool SetPropertyBool (const char *szName, bool value)
 
bool SetPropertyFloat (const char *szName, ai_real fValue)
 
bool SetPropertyString (const char *szName, const std::string &sValue)
 
bool SetPropertyMatrix (const char *szName, const aiMatrix4x4 &sValue)
 
bool SetPropertyCallback (const char *szName, const std::function< void *(void *)> &f)
 
int GetPropertyInteger (const char *szName, int iErrorReturn=0xffffffff) const
 
bool GetPropertyBool (const char *szName, bool bErrorReturn=false) const
 
ai_real GetPropertyFloat (const char *szName, ai_real fErrorReturn=10e10f) const
 
const std::string GetPropertyString (const char *szName, const std::string &sErrorReturn="") const
 
const aiMatrix4x4 GetPropertyMatrix (const char *szName, const aiMatrix4x4 &sErrorReturn=aiMatrix4x4()) const
 
std::function< void *(void *)> GetPropertyCallback (const char *szName) const
 
bool HasPropertyInteger (const char *szName) const
 
bool HasPropertyBool (const char *szName) const
 
bool HasPropertyFloat (const char *szName) const
 
bool HasPropertyString (const char *szName) const
 
bool HasPropertyMatrix (const char *szName) const
 
bool HasPropertyCallback (const char *szName) const
 

Public Attributes

IntPropertyMap mIntProperties
 
FloatPropertyMap mFloatProperties
 
StringPropertyMap mStringProperties
 
MatrixPropertyMap mMatrixProperties
 
CallbackPropertyMap mCallbackProperties
 

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
szNameName of the property. All supported properties are defined in the aiConfig.g header (all constants share the prefix AI_CONFIG_XXX).
iErrorReturnValue 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
szNameName 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).
iValueNew 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()

Member Data Documentation

◆ mFloatProperties

FloatPropertyMap Assimp::ExportProperties::mFloatProperties

List of floating-point properties

◆ mIntProperties

IntPropertyMap Assimp::ExportProperties::mIntProperties

List of integer properties

◆ mMatrixProperties

MatrixPropertyMap Assimp::ExportProperties::mMatrixProperties

List of Matrix properties

◆ mStringProperties

StringPropertyMap Assimp::ExportProperties::mStringProperties

List of string properties


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