KFbxObject Class Reference

#include <kfbxobject.h>

Inherits KFbxPlug.

Inherited by KFbxCache, KFbxCharacterPose, KFbxGeometryConverter, KFbxGeometryWeightedMap, KFbxGlobalSettings, KFbxImageConverter, KFbxIO, KFbxKFCurveFilters, KFbxNodeAttribute, KFbxPose, KFbxScene, KFbxSceneInfo, KFbxStreamOptions, KFbxTakeNodeContainer, and KFbxThumbnail.

Inheritance diagram for KFbxObject:

List of all members.

---

Detailed Description

Basic class for object type identification and instance naming.

Definition at line 77 of file kfbxobject.h.

Object Name Management
void	SetName (char const *pName, bool wantPrefix=false)
	Set the name of the object.
char const *	GetName () const
	Return the full name of the object.
KString	GetNameWithoutNameSpacePrefix () const
	Return the name of the object without the namespace qualifier.
KString	GetNameWithNameSpacePrefix () const
	Return the name of the object with the namespace qualifier.
void	SetInitialName (char const *pName)
	Set the initial name of the object.
char const *	GetInitialName () const
	Return the initial name of the object.
KString	GetNameSpaceOnly ()
	Return the namespace of the object.
void	SetNameSpace (KString pNameSpace)
	Set the namespace of the object.
Properties access
int	GetPropertyCount () const
	Return the number of property defining this object.
KFbxProperty	GetProperty (int pIndex) const
	Get the property at the given index.
KFbxProperty	FindProperty (const char *pName, bool pCaseSensitive=true) const
	Find a property using its name and its data type.
KFbxProperty	FindProperty (const char *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const
	Return the number of property defining this object.
General Property Connection and Relationship Management
int	GetSrcPropertyCount ()
KFbxProperty	GetSrcProperty (int pIndex=0)
KFbxProperty	FindSrcProperty (const char *pName, int pStartIndex=0)
bool	ConnectSrcProperty (KFbxProperty const &pProperty)
bool	IsConnectedSrcProperty (KFbxProperty const &pProperty)
bool	DisconnectSrcProperty (KFbxProperty const &pProperty)
int	GetDstPropertyCount ()
KFbxProperty	GetDstProperty (int pIndex=0)
KFbxProperty	FindDstProperty (const char *pName, int pStartIndex=0)
bool	ConnectDstProperty (KFbxProperty const &pProperty)
bool	IsConnectedDstProperty (KFbxProperty const &pProperty)
bool	DisconnectDstProperty (KFbxProperty const &pProperty)
Public Member Functions
void	SetUserDataPtr (void *pUserData)
	Store a pointer to an application-specific memory region.
void *	GetUserDataPtr ()
	Retrieve the application-specific pointer stored in this KFbxObject.
KFbxScene *	GetScene ()
	Get a pointer to the scene containing this object.
const KFbxScene *	GetScene () const
	Get a const pointer to the scene containing this object.

---

Member Function Documentation

void SetName	(	char const *	pName,
		bool	wantPrefix = false
	)

Set the name of the object.

Parameters:

pName

A NULL terminated string.

char const* GetName

(

)

const

Return the full name of the object.

Returns:

Return a NULL terminated string.

KString GetNameWithoutNameSpacePrefix

(

)

const

Return the name of the object without the namespace qualifier.

Returns:

Return the name in a temporary string.

KString GetNameWithNameSpacePrefix

(

)

const

Return the name of the object with the namespace qualifier.

Returns:

Return the name in a temporary string.

void SetInitialName

(

char const *

pName

)

Set the initial name of the object.

Parameters:

pName

A NULL terminated string.

char const* GetInitialName

(

)

const

Return the initial name of the object.

Returns:

Return a NULL terminated string.

KString GetNameSpaceOnly

(

)

[inline]

Return the namespace of the object.

Returns:

Return a NULL terminated string.

Definition at line 122 of file kfbxobject.h.

void SetNameSpace

(

KString

pNameSpace

)

Set the namespace of the object.

Returns:

Return a NULL terminated string.

int GetPropertyCount

(

)

const

Return the number of property defining this object.

Referenced by KFbxStreamOptions::GetOption(), and KFbxStreamOptions::GetOptionCount().

KFbxProperty GetProperty

(

int

pIndex

)

const

Get the property at the given index.

Parameters:

pIndex

The index of the requested property. This value must be between 0 and the number of properties returned by GetPropertyCount().

Returns:

Return the property at the given index, or NULL if

Parameters:

pIndex

is out of bound.

Referenced by KFbxStreamOptions::GetOption().

KFbxProperty FindProperty	(	const char *	pName,
		bool	pCaseSensitive = true
	)			const

Find a property using its name and its data type.

Parameters:

pName

The name of the property as a NULL terminated string.

Returns:

Return a pointer to the property found or NULL if the property was not found.

KFbxProperty FindProperty	(	const char *	pName,
		KFbxDataType const &	pDataType,
		bool	pCaseSensitive = true
	)			const

Return the number of property defining this object.

void SetUserDataPtr

(

void *

pUserData

)

[virtual]

Store a pointer to an application-specific memory region.

Parameters:

pUserData

A pointer to be carry over by the KFbxObject.

Remarks:

The FBX SDK make no use of this pointer, it's the application responsability to allocate/free the memory referenced by this pointer.

Reimplemented from KFbxPlug.

void* GetUserDataPtr

(

)

[virtual]

Retrieve the application-specific pointer stored in this KFbxObject.

Returns:

Return the pointer previously stored by SetUserData(), or NULL if the pointer was not set.

Reimplemented from KFbxPlug.

KFbxScene* GetScene

(

)

Get a pointer to the scene containing this object.

Returns:

Return a pointer to the scene containing this object or NULL if the object does not belong to any scene.

const KFbxScene* GetScene

(

)

const

Get a const pointer to the scene containing this object.

Returns:

Return a const pointer to the scene containing this object or NULL if the object does not belong to any scene.