KFbxIOSettings
#include<kfbxiosettings.h>

Inheritance diagram for KFbxIOSettings:

Inheritance graph
[legend]

List of all members.

Detailed Description

KFbxIOSettingsClass used as container for IO settings.

All settings are organised in a propertie hierarchie. A node of settings may contain a bunch of information related to an operation (ex: import / export) it may also contain informations related to a user dialog offering user options

Definition at line193of filekfbxiosettings.h.


Public Member Functions

virtual ~KFbxIOSettings()
 Destructor.
void FreeIOSettings()
 Release memory.
virtual void Clear()
 Empty the settings hierarchies.
KFbxProperty AddPropertyGroup(char const *pName,KFbxDataTypeconst&pDataType=KFbxDataType(), char const *pLabel="")
 Add a property group under the root prop.
KFbxProperty AddPropertyGroup(KFbxPropertyconst&pParentProperty, char const *pName,KFbxDataTypeconst&pDataType=KFbxDataType(), char const *pLabel="", bool pVisible=true, bool pSavable=true, bool pEnabled=true)
 Add a property group under another parent prop.
KFbxProperty AddProperty(KFbxPropertyconst&pParentProperty, char const *pName,KFbxDataTypeconst&pDataType=KFbxDataType(), char const *pLabel="", void const *pValue=NULL, EFbxType pValueType=eUNIDENTIFIED, bool pVisible=true, bool pSavable=true, bool pEnabled=true)
 Add a property under another parent prop with a value to set.
KFbxProperty AddPropertyMinMax(KFbxPropertyconst&pParentProperty, char const *pName,KFbxDataTypeconst&pDataType=KFbxDataType(), char const *pLabel="", void const *pValue=NULL, double const *pMinValue=NULL, double const *pMaxValue=NULL, EFbxType pValueType=eUNIDENTIFIED, bool pVisible=true, bool pSavable=true, bool pEnabled=true)
 Add a property under another parent prop with a value to set and a min max values.
KFbxProperty GetProperty(char const *pName)
 get a prop by description ex: "Export|Animation|Bake"
KFbxProperty GetProperty(KFbxPropertyconst&pParentProperty, char const *pName)
 get prop by description from a parent property
bool GetBoolProp(char const *pName, bool pDefValue)
 get/set a bool prop by prop path
double GetDoubleProp(char const *pName, double pDefValue)
 get/set a double prop by prop path
int GetIntProp(char const *pName, int pDefValue)
 get/set a int prop by prop path
KTime GetKTimeProp(char const *pName,KTimepDefValue)
 get/set aKTimeprop by prop path
KString GetEnumProp(char const *pName,KStringpDefValue)
 get/set an enum prop by prop path
KString GetStringProp(char const *pName,KStringpDefValue)
 get/set a string prop by prop path
virtual bool ReadXMLFile(KString&path)
 Load the settings hierarchie from an XML file.
virtual bool WriteXMLFile(KString&path)
 Write the settings hierarchie to an XML file.
bool WriteXmlPropToRegistry(KString&regKeyName,KString&regValueName,KString&propPath,KString&regPath)
 Write a property branch to the registry - can be used to save a "Preset".
bool ReadXmlPropFromRegistry(KString&regKeyName,KString&regValueName,KString&regPath)
 Read a property branch from the registry - can be used to read a "Preset".
bool ReadXmlPropFromMyDocument(KString&subDir,KString&filename)
 Read an XML file from MyDocument dir.
bool WriteXmlPropToMyDocument(KString&subDir,KString&filename,KString&propPath)
 Write property branch to an XML file in MyDocument dir.
virtualKFbxObjectClone(KFbxObject*pContainer,KFbxObject::ECloneTypepType) const
 Creates a clone of this object.

Static Public Member Functions

static void AllocateIOSettings(KFbxSdkManager&pManager)
 Global allocator.
staticKFbxIOSettingsIOSettingsRef()
 Ref accessor.

Constructor&Destructor Documentation

virtual ~KFbxIOSettings( ) [virtual]

Destructor.

Member Function Documentation

static void AllocateIOSettings(KFbxSdkManagerpManager ) [static]

Global allocator.

void FreeIOSettings( ) 

Release memory.

staticKFbxIOSettings&IOSettingsRef( ) [static]

Ref accessor.

virtual void Clear( ) [virtual]

Empty the settings hierarchies.

KFbxPropertyAddPropertyGroup(char const * pName,
KFbxDataTypeconst& pDataType=KFbxDataType(),
char const * pLabel="" 
)

Add a property group under the root prop.

KFbxPropertyAddPropertyGroup(KFbxPropertyconst& pParentProperty,
char const * pName,
KFbxDataTypeconst& pDataType=KFbxDataType(),
char const * pLabel="",
bool pVisible=true,
bool pSavable=true,
bool pEnabled=true 
)

Add a property group under another parent prop.

KFbxPropertyAddProperty(KFbxPropertyconst& pParentProperty,
char const * pName,
KFbxDataTypeconst& pDataType=KFbxDataType(),
char const * pLabel="",
void const * pValue=NULL,
EFbxType pValueType=eUNIDENTIFIED,
bool pVisible=true,
bool pSavable=true,
bool pEnabled=true 
)

Add a property under another parent prop with a value to set.

KFbxPropertyAddPropertyMinMax(KFbxPropertyconst& pParentProperty,
char const * pName,
KFbxDataTypeconst& pDataType=KFbxDataType(),
char const * pLabel="",
void const * pValue=NULL,
double const * pMinValue=NULL,
double const * pMaxValue=NULL,
EFbxType pValueType=eUNIDENTIFIED,
bool pVisible=true,
bool pSavable=true,
bool pEnabled=true 
)

Add a property under another parent prop with a value to set and a min max values.

KFbxPropertyGetProperty(char const * pName ) 

get a prop by description ex: "Export|Animation|Bake"

KFbxPropertyGetProperty(KFbxPropertyconst& pParentProperty,
char const * pName 
)

get prop by description from a parent property

bool GetBoolProp(char const * pName,
bool pDefValue 
)

get/set a bool prop by prop path

double GetDoubleProp(char const * pName,
double pDefValue 
)

get/set a double prop by prop path

int GetIntProp(char const * pName,
int pDefValue 
)

get/set a int prop by prop path

KTimeGetKTimeProp(char const * pName,
KTime pDefValue 
)

get/set aKTimeprop by prop path

KStringGetEnumProp(char const * pName,
KString pDefValue 
)

get/set an enum prop by prop path

KStringGetStringProp(char const * pName,
KString pDefValue 
)

get/set a string prop by prop path

virtual bool ReadXMLFile(KStringpath ) [virtual]

Load the settings hierarchie from an XML file.

virtual bool WriteXMLFile(KStringpath ) [virtual]

Write the settings hierarchie to an XML file.

bool WriteXmlPropToRegistry(KStringregKeyName,
KStringregValueName,
KStringpropPath,
KStringregPath 
)

Write a property branch to the registry - can be used to save a "Preset".

bool ReadXmlPropFromRegistry(KStringregKeyName,
KStringregValueName,
KStringregPath 
)

Read a property branch from the registry - can be used to read a "Preset".

bool ReadXmlPropFromMyDocument(KStringsubDir,
KStringfilename 
)

Read an XML file from MyDocument dir.

bool WriteXmlPropToMyDocument(KStringsubDir,
KStringfilename,
KStringpropPath 
)

Write property branch to an XML file in MyDocument dir.

virtualKFbxObject* Clone(KFbxObjectpContainer,
KFbxObject::ECloneType pCloneType 
)const[virtual]

Creates a clone of this object.

Parameters:
pContainer The object, typically a document or scene, that will contain the new clone. Can be NULL.
pCloneType The type of clone to create
Returns:
The new clone, or NULL if the specified clone type is not supported.

Reimplemented fromKFbxObject.