FbxIteratorSrcBase Class Reference

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

#include <fbxobject.h>

Inheritance diagram for FbxIteratorSrcBase:

Public Member Functions
	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 Member Functions
void	ResetToBegin ()
	Reset the iterate index to the beginning. More...
void	ResetToEnd ()
	Reset the iterate index to the end. More...

Protected Attributes
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

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

Definition at line 1100 of file fbxobject.h.

Constructor & Destructor Documentation

FbxIteratorSrcBase ( FbxProperty &  pProperty, FbxClassId  pClassId  )

inline

Constructor.

Parameters

pProperty	Property object. The iterator will iterate source objects that connect to it.
pClassId	The class ID specifies the type of the source objects.

Definition at line 1108 of file fbxobject.h.

                                                                          :
        mProperty(pProperty),
        mClassId(pClassId),
        mSize(0),
        mIndex(-1)
    {
        ResetToBegin();
    }

FbxIteratorSrcBase ( FbxObject *  pObject, FbxClassId  pClassId  )

inline

Constructor.

Parameters

pObject	FBX object. The iterator will iterate source objects that connect to it.
pClassId	The class ID specifies the type of the source objects.

Definition at line 1122 of file fbxobject.h.

                                                                      :
        mProperty(pObject->RootProperty),
        mClassId(pClassId),
        mSize(0),
        mIndex(-1)
    {
        ResetToBegin();
    }

Member Function Documentation

FbxObject* GetFirst ( )

inline

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

Returns

The first source object.

Definition at line 1135 of file fbxobject.h.

    {
        ResetToBegin();
        return GetNext();
    }

FbxObject* 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 1145 of file fbxobject.h.

    {
        mIndex++;
        return ((mIndex>=0) && (mIndex<mSize)) ? mProperty.GetSrcObject(FbxCriteria::ObjectType(mClassId), mIndex) : NULL;
    }

FbxObject* 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 1156 of file fbxobject.h.

    {
        mSize = mProperty.GetSrcObjectCount(FbxCriteria::ObjectType(mClassId));
        return GetNext();
    }

FbxObject* GetLast ( )

inline

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

Returns

The last source object.

Definition at line 1166 of file fbxobject.h.

    {
        ResetToEnd();
        return GetPrevious();
    }

FbxObject* 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 1176 of file fbxobject.h.

    {
        mIndex--;
        return ((mIndex>=0) && (mIndex<mSize)) ? mProperty.GetSrcObject(FbxCriteria::ObjectType(mClassId), mIndex) : NULL;
    }

FbxObject* 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 1188 of file fbxobject.h.

    {
        mSize = mProperty.GetSrcObjectCount(FbxCriteria::ObjectType(mClassId));
        while (mIndex>mSize) mIndex--;
        return GetPrevious();
    }

void ResetToBegin ( )

inlineprotected

Reset the iterate index to the beginning.

Definition at line 1199 of file fbxobject.h.

    {
        mSize = mProperty.GetSrcObjectCount(FbxCriteria::ObjectType(mClassId));
        mIndex = -1;
    }

void ResetToEnd ( )

inlineprotected

Reset the iterate index to the end.

Definition at line 1208 of file fbxobject.h.

    {
        mSize = mProperty.GetSrcObjectCount(FbxCriteria::ObjectType(mClassId));
        mIndex = mSize;
    }

Member Data Documentation

FbxProperty mProperty

protected

Definition at line 1214 of file fbxobject.h.

FbxClassId mClassId

protected

The property to iterate. If iterate an object, this is the root property of the object.

Definition at line 1215 of file fbxobject.h.

int mSize

protected

The class ID specifies the type of the source objects to be retrieved.

Definition at line 1216 of file fbxobject.h.

int mIndex

protected

The number of source objects whose type is specified by mClassId.

Definition at line 1217 of file fbxobject.h.

---

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

• fbxsdk/core/fbxobject.h