FbxIteratorSrcBase Class Reference

Search for all occurrences

#include <fbxobject.h>

---

Class Description

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

Definition at line 1276 of file fbxobject.h.

Inheritance diagram for FbxIteratorSrcBase:

List of all members.

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

---

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 1284 of file fbxobject.h.

        {
                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 1298 of file fbxobject.h.

        {
                ResetToBegin();
        }

---

Member Function Documentation

FbxObject* GetFirst

(

)

[inline]

Search for all occurrences

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

Returns:

The first source object.

Reimplemented in FbxIteratorSrc< Type >.

Definition at line 1311 of file fbxobject.h.

        {

FbxObject* GetNext

(

)

[inline]

Search for all occurrences

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

Returns:

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

Reimplemented in FbxIteratorSrc< Type >.

Definition at line 1321 of file fbxobject.h.

                                                                                                                         : NULL;
        }

FbxObject* GetSafeNext

(

)

[inline]

Search for all occurrences

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.

Reimplemented in FbxIteratorSrc< Type >.

Definition at line 1332 of file fbxobject.h.

        {

FbxObject* GetLast

(

)

[inline]

Search for all occurrences

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

Returns:

The last source object.

Reimplemented in FbxIteratorSrc< Type >.

Definition at line 1342 of file fbxobject.h.

        {

FbxObject* GetPrevious

(

)

[inline]

Search for all occurrences

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

Returns:

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

Reimplemented in FbxIteratorSrc< Type >.

Definition at line 1352 of file fbxobject.h.

                                                                                                                         : NULL;
        }

FbxObject* GetSafePrevious

(

)

[inline]

Search for all occurrences

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.

Reimplemented in FbxIteratorSrc< Type >.

Definition at line 1364 of file fbxobject.h.

         :

void ResetToBegin

(

)

[inline, protected]

Search for all occurrences

Reset the iterate index to the beginning.

Definition at line 1375 of file fbxobject.h.

        {

void ResetToEnd

(

)

[inline, protected]

Search for all occurrences

Reset the iterate index to the end.

Definition at line 1384 of file fbxobject.h.

                                          : protected FbxIteratorSrcBase

---

Member Data Documentation

FbxProperty mProperty [protected]

Search for all occurrences

Definition at line 1390 of file fbxobject.h.

FbxClassId mClassId [protected]

Search for all occurrences

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

Definition at line 1391 of file fbxobject.h.

int mSize [protected]

Search for all occurrences

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

Definition at line 1392 of file fbxobject.h.

int mIndex [protected]

Search for all occurrences

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

Definition at line 1393 of file fbxobject.h.

---

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

• fbxsdk/core/fbxobject.h