FbxIteratorSrc< Type > Class Template Reference

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

#include <fbxobject.h>

Inheritance diagram for FbxIteratorSrc< Type >:

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

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

Detailed Description

template<class Type>
class FbxIteratorSrc< Type >

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

The class is a wrapper of FbxIteratorSrcBase with template.

Definition at line 1225 of file fbxobject.h.

Constructor & Destructor Documentation

FbxIteratorSrc ( FbxObject *  pObject )

inline

Constructor.

Parameters

pObject

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

Definition at line 1232 of file fbxobject.h.

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

FbxIteratorSrc ( FbxProperty &  pProperty )

inline

Constructor.

Parameters

pProperty

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

Definition at line 1238 of file fbxobject.h.

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

Member Function Documentation

Type* GetFirst ( )

inline

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

Returns

The first source object.

Definition at line 1244 of file fbxobject.h.

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

Type* GetNext ( )

inline

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

Returns

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

Definition at line 1250 of file fbxobject.h.

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

Type* GetSafeNext ( )

inline

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

Returns

The next source 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 1257 of file fbxobject.h.

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

Type* GetLast ( )

inline

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

Returns

The last source object.

Definition at line 1263 of file fbxobject.h.

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

Type* GetPrevious ( )

inline

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

Returns

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

Definition at line 1270 of file fbxobject.h.

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

Type* GetSafePrevious ( )

inline

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

Returns

The previous source 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 source object is returned.

Definition at line 1278 of file fbxobject.h.

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

---

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

• fbxsdk/core/fbxobject.h