KFbxIOSettings Class Reference

#include <kfbxiosettings.h>

Inheritance diagram for KFbxIOSettings:

[legend]

List of all members.

---

Detailed Description

KFbxIOSettings Class used as container for IO settings.

All settings are organized in a property hierarchy. 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 line 189 of file kfbxiosettings.h.

Public Member Functions
void	FreeIOSettings ()
	Release memory.
virtual void	Clear ()
	Empty the settings hierarchies.
KFbxProperty	AddPropertyGroup (char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="")
	Add a property group under the root prop.
KFbxProperty	AddPropertyGroup (KFbxProperty const &pParentProperty, char const *pName, KFbxDataType const &pDataType=KFbxDataType(), char const *pLabel="", bool pVisible=true, bool pSavable=true, bool pEnabled=true)
	Add a property group under another parent prop.
KFbxProperty	AddProperty (KFbxProperty const &pParentProperty, char const *pName, KFbxDataType const &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 (KFbxProperty const &pParentProperty, char const *pName, KFbxDataType const &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 (KFbxProperty const &pParentProperty, char const *pName)
	get prop by description from a parent property
bool	GetBoolProp (char const *pName, bool pDefValue)
	get a bool prop by prop path
void	SetBoolProp (char const *pName, bool pValue)
	set a bool prop by prop path
double	GetDoubleProp (char const *pName, double pDefValue)
	get a double prop by prop path
void	SetDoubleProp (char const *pName, double pValue)
	set a double prop by prop path
int	GetIntProp (char const *pName, int pDefValue)
	get a int prop by prop path
void	SetIntProp (char const *pName, int pValue)
	set a int prop by prop path
KTime	GetKTimeProp (char const *pName, KTime pDefValue)
	get a KTime prop by prop path
void	SetKTimeProp (char const *pName, KTime pValue)
	set a KTime prop by prop path
KString	GetEnumProp (char const *pName, KString pDefValue)
	get an enum prop by prop path
int	GetEnumProp (char const *pName, int pDefValue)
	get an enum prop by prop path
int	GetEnumIndex (char const *pName, KString pValue)
	get an enum prop by prop path
void	SetEnumProp (char const *pName, KString pValue)
	set an enum prop by prop path
void	SetEnumProp (char const *pName, int pValue)
	set an enum prop by prop path
bool	SetFlag (char const *pName, FbxPropertyFlags::eFbxPropertyFlags propFlag, bool pValue)
	set a specific flag value on a specific property.
KString	GetStringProp (char const *pName, KString pDefValue)
	get a string prop by prop path
void	SetStringProp (char const *pName, KString pValue)
	set a string prop by prop path
virtual bool	ReadXMLFile (KString &path)
	Load the settings hierarchy from an XML file.
virtual bool	WriteXMLFile (KString &path)
	Write the settings hierarchy 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.
virtual KFbxObject *	Clone (KFbxObject *pContainer, KFbxObject::ECloneType pType) const
	Creates a clone of this object.
Static Public Member Functions
static void	AllocateIOSettings (KFbxSdkManager &pManager)
	Global allocator.
static KFbxIOSettings &	IOSettingsRef ()
	Ref accessor.

---

Member Function Documentation

static void AllocateIOSettings

(

KFbxSdkManager &

pManager

)

[static]

Global allocator.

Parameters:

pManager

void FreeIOSettings

(

)

Release memory.

static KFbxIOSettings& IOSettingsRef

(

)

[static]

Ref accessor.

virtual void Clear

(

)

[virtual]

Empty the settings hierarchies.

KFbxProperty AddPropertyGroup	(	char const *	pName,
		KFbxDataType const &	pDataType = KFbxDataType(),
		char const *	pLabel = ""
	)

Add a property group under the root prop.

Parameters:

	pName
	pDataType
	pLabel

KFbxProperty AddPropertyGroup	(	KFbxProperty const &	pParentProperty,
		char const *	pName,
		KFbxDataType const &	pDataType = KFbxDataType(),
		char const *	pLabel = "",
		bool	pVisible = true,
		bool	pSavable = true,
		bool	pEnabled = true
	)

Add a property group under another parent prop.

Parameters:

	pParentProperty
	pName
	pDataType
	pLabel
	pVisible
	pSavable
	pEnabled

KFbxProperty AddProperty	(	KFbxProperty const &	pParentProperty,
		char const *	pName,
		KFbxDataType const &	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.

Parameters:

	pParentProperty
	pName
	pDataType
	pLabel
	pValue
	pValueType
	pVisible
	pSavable
	pEnabled

KFbxProperty AddPropertyMinMax	(	KFbxProperty const &	pParentProperty,
		char const *	pName,
		KFbxDataType const &	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.

Parameters:

	pParentProperty
	pName
	pDataType
	pLabel
	pValue
	pMinValue
	pMaxValue
	pValueType
	pVisible
	pSavable
	pEnabled

KFbxProperty GetProperty

(

char const *

pName

)

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

Parameters:

pName

KFbxProperty GetProperty	(	KFbxProperty const &	pParentProperty,
		char const *	pName
	)

get prop by description from a parent property

Parameters:

	pParentProperty
	pName

bool GetBoolProp	(	char const *	pName,
		bool	pDefValue
	)

get a bool prop by prop path

Parameters:

	pName
	pDefValue

void SetBoolProp	(	char const *	pName,
		bool	pValue
	)

set a bool prop by prop path

Parameters:

	pName
	pValue

double GetDoubleProp	(	char const *	pName,
		double	pDefValue
	)

get a double prop by prop path

Parameters:

	pName
	pDefValue

void SetDoubleProp	(	char const *	pName,
		double	pValue
	)

set a double prop by prop path

Parameters:

	pName
	pValue

int GetIntProp	(	char const *	pName,
		int	pDefValue
	)

get a int prop by prop path

Parameters:

	pName
	pDefValue

void SetIntProp	(	char const *	pName,
		int	pValue
	)

set a int prop by prop path

Parameters:

	pName
	pValue

KTime GetKTimeProp	(	char const *	pName,
		KTime	pDefValue
	)

get a KTime prop by prop path

Parameters:

	pName
	pDefValue

void SetKTimeProp	(	char const *	pName,
		KTime	pValue
	)

set a KTime prop by prop path

Parameters:

	pName
	pValue

KString GetEnumProp	(	char const *	pName,
		KString	pDefValue
	)

get an enum prop by prop path

Parameters:

	pName
	pDefValue

int GetEnumProp	(	char const *	pName,
		int	pDefValue
	)

get an enum prop by prop path

Parameters:

	pName
	pDefValue

int GetEnumIndex	(	char const *	pName,
		KString	pValue
	)

get an enum prop by prop path

Parameters:

	pName
	pValue

void SetEnumProp	(	char const *	pName,
		KString	pValue
	)

set an enum prop by prop path

Parameters:

	pName
	pValue

void SetEnumProp	(	char const *	pName,
		int	pValue
	)

set an enum prop by prop path

Parameters:

	pName
	pValue

bool SetFlag	(	char const *	pName,
		FbxPropertyFlags::eFbxPropertyFlags	propFlag,
		bool	pValue
	)

set a specific flag value on a specific property.

Parameters:

	pName
	propFlag
	pValue

KString GetStringProp	(	char const *	pName,
		KString	pDefValue
	)

get a string prop by prop path

Parameters:

	pName
	pDefValue

void SetStringProp	(	char const *	pName,
		KString	pValue
	)

set a string prop by prop path

Parameters:

	pName
	pValue

virtual bool ReadXMLFile

(

KString &

path

)

[virtual]

Load the settings hierarchy from an XML file.

Parameters:

path

The path of the XML file.

Returns:

True on success, false otherwise.

virtual bool WriteXMLFile

(

KString &

path

)

[virtual]

Write the settings hierarchy to an XML file.

Parameters:

path

The path of the XML file.

Returns:

True on success, false otherwise.

bool WriteXmlPropToRegistry	(	KString &	regKeyName,
		KString &	regValueName,
		KString &	propPath,
		KString &	regPath
	)

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

Parameters:

	regKeyName
	regValueName
	propPath
	regPath

Returns:

True on success, false otherwise.

bool ReadXmlPropFromRegistry	(	KString &	regKeyName,
		KString &	regValueName,
		KString &	regPath
	)

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

Parameters:

	regKeyName
	regValueName
	regPath

Returns:

True on success, false otherwise.

bool ReadXmlPropFromMyDocument	(	KString &	subDir,
		KString &	filename
	)

Read an XML file from MyDocument dir.

Parameters:

	subDir	The sub directory.
	filename	The file name.

Returns:

True on success, false otherwise.

bool WriteXmlPropToMyDocument	(	KString &	subDir,
		KString &	filename,
		KString &	propPath
	)

Write property branch to an XML file in MyDocument dir.

Parameters:

	subDir
	filename
	propPath

Returns:

True on success, false otherwise.

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

Creates a clone of this object.

Parameters:

	pContainer	The object, typically a document or a scene, that contains the new clone(can be NULL).
	pCloneType	The type of clone to be created.

Returns:

The new clone, or NULL (if the specified clone type is not supported).

Reimplemented from KFbxObject.