FbxIteratorDst< Type > Class Template Reference

A utility class for iterating over destination objects that connect to property (FbxProperty) or object (FbxObject). More...

#include <fbxobject.h>

Inheritance diagram for FbxIteratorDst< Type >:

Public Member Functions
	FbxIteratorDst (FbxObject *pObject)
	Constructor. More...
	FbxIteratorDst (FbxProperty &pProperty)
	Constructor. More...
Type *	GetFirst ()
	Get the first destination object that connects to the property or object. More...
Type *	GetNext ()
	Get next destination object that connects to the property or object. More...
Type *	GetSafeNext ()
	Get next destination object that connects to the property or object. More...
Type *	GetLast ()
	Get the last destination object that connects to the property or object. More...
Type *	GetPrevious ()
	Get previous destination object that connects to the property or object. More...
Type *	GetSafePrevious ()
	Get previous destination object that connects to the property or object. More...

Additional Inherited Members
Protected Member Functions inherited from FbxIteratorDstBase
void	ResetToBegin ()
	Reset the iterate index to the beginning. More...
void	ResetToEnd ()
	Reset the iterate index to the end. More...
	FbxIteratorDstBase (FbxProperty &pProperty, FbxClassId pClassId)
	Constructor. More...
	FbxIteratorDstBase (FbxObject *pObject, FbxClassId pClassId)
	Constructor. More...
FbxObject *	GetFirst ()
	Get the first destination object that connects to the property or object. More...
FbxObject *	GetNext ()
	Get next destination object that connects to the property or object. More...
FbxObject *	GetSafeNext ()
	Get next destination object that connects to the property or object. More...
FbxObject *	GetLast ()
	Get the last destination object that connects to the property or object. More...
FbxObject *	GetPrevious ()
	Get previous destination object that connects to the property or object. More...
FbxObject *	GetSafePrevious ()
	Get previous destination object that connects to the property or object. More...
Protected Attributes inherited from FbxIteratorDstBase
FbxProperty	mProperty
	The property to iterate. More...
FbxClassId	mClassId
	The class ID specifies the type of the destination objects to be retrieved. More...
int	mSize
	The number of destination objects whose type is specified by mClassId. More...
int	mIndex
	Iterate index. More...

Detailed Description

template<class Type>
class FbxIteratorDst< Type >

A utility class for iterating over destination objects that connect to property (FbxProperty) or object (FbxObject).

The class is a wrapper of FbxIteratorDstBase with template.

Definition at line 1414 of file fbxobject.h.

Constructor & Destructor Documentation

FbxIteratorDst ( FbxObject *  pObject )

inline

Constructor.

Parameters

pObject

FBX object. The iterator will iterate destination objects that connect to it.

Definition at line 1421 of file fbxobject.h.

: FbxIteratorDstBase(pObject,Type::ClassId) {}

FbxIteratorDst ( FbxProperty &  pProperty )

inline

Constructor.

Parameters

pProperty

Property object. The iterator will iterate destination objects that connect to it.

Definition at line 1427 of file fbxobject.h.

: FbxIteratorDstBase(pProperty,Type::ClassId) {}

Member Function Documentation

Type* GetFirst ( )

inline

Get the first destination object that connects to the property or object.

Returns

The first destination object.

Definition at line 1433 of file fbxobject.h.

{ return (Type*)FbxIteratorDstBase::GetFirst(); }

Type* GetNext ( )

inline

Get next destination object that connects to the property or object.

Returns

The next destination object. If there are no more objects, return NULL.

Definition at line 1439 of file fbxobject.h.

{ return (Type*)FbxIteratorDstBase::GetNext(); }

Type* GetSafeNext ( )

inline

Get next destination object that connects to the property or object.

Returns

The next destination object. If there are no more objects, return NULL.

Remarks

This method makes sure the iterate index is not out of bounds.

Definition at line 1446 of file fbxobject.h.

{ return (Type*)FbxIteratorDstBase::GetSafeNext(); }

Type* GetLast ( )

inline

Get the last destination object that connects to the property or object.

Returns

The last destination object.

Definition at line 1452 of file fbxobject.h.

{ return (Type*)FbxIteratorDstBase::GetLast(); }

Type* GetPrevious ( )

inline

Get previous destination object that connects to the property or object.

Returns

The previous destination object. If there are no more objects, return NULL.

Definition at line 1458 of file fbxobject.h.

{ return (Type*)FbxIteratorDstBase::GetPrevious(); }

Type* GetSafePrevious ( )

inline

Get previous destination object that connects to the property or object.

Returns

The previous destination object. If there are no more objects, return NULL.

Remarks

This method makes sure the iterate index is not out of bounds. If the iterate index is out of bounds, the last destination object is returned.

Definition at line 1466 of file fbxobject.h.

{ return (Type*)FbxIteratorDstBase::GetSafePrevious(); }

---

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

• fbxsdk/core/fbxobject.h