FbxIteratorDstBase Class Reference

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

#include <fbxobject.h>

Inheritance diagram for FbxIteratorDstBase:

Public Member Functions
	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 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
	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

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

Definition at line 1284 of file fbxobject.h.

Constructor & Destructor Documentation

FbxIteratorDstBase ( FbxProperty &  pProperty, FbxClassId  pClassId  )

inline

Constructor.

Parameters

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

Definition at line 1302 of file fbxobject.h.

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

FbxIteratorDstBase ( 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 1316 of file fbxobject.h.

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

Member Function Documentation

FbxObject* GetFirst ( )

inline

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

Returns

The first destination object.

Definition at line 1329 of file fbxobject.h.

    {
        ResetToBegin();
        return GetNext();
    }

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

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

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

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

FbxObject* GetLast ( )

inline

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

Returns

The last destination object.

Definition at line 1360 of file fbxobject.h.

    {
        ResetToEnd();
        return GetPrevious();
    }

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

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

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

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

void ResetToBegin ( )

inlineprotected

Reset the iterate index to the beginning.

Definition at line 1393 of file fbxobject.h.

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

void ResetToEnd ( )

inlineprotected

Reset the iterate index to the end.

Definition at line 1402 of file fbxobject.h.

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

Member Data Documentation

FbxProperty mProperty

protected

The property to iterate.

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

Definition at line 1288 of file fbxobject.h.

FbxClassId mClassId

protected

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

Definition at line 1290 of file fbxobject.h.

int mSize

protected

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

Definition at line 1292 of file fbxobject.h.

int mIndex

protected

Iterate index.

Definition at line 1294 of file fbxobject.h.

---

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

• fbxsdk/core/fbxobject.h