FbxIteratorSrc< Type > Class Template Reference

FbxIteratorSrc< Type > Class Template Reference

#include <fbxobject.h>

Class 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 1280 of file 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...
 
FbxObjectGetFirst ()
 Get the first source object that connects to the property or object. More...
 
FbxObjectGetNext ()
 Get next source object that connects to the property or object. More...
 
FbxObjectGetSafeNext ()
 Get next source object that connects to the property or object. More...
 
FbxObjectGetLast ()
 Get the last source object that connects to the property or object. More...
 
FbxObjectGetPrevious ()
 Get previous source object that connects to the property or object. More...
 
FbxObjectGetSafePrevious ()
 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...
 

Constructor & Destructor Documentation

FbxIteratorSrc ( FbxObject pObject)
inline

Constructor.

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

Definition at line 1287 of file fbxobject.h.

1287 : FbxIteratorSrcBase(pObject,Type::ClassId) {}
FbxIteratorSrcBase(FbxProperty &pProperty, FbxClassId pClassId)
Constructor.
Definition: fbxobject.h:1163
FbxIteratorSrc ( FbxProperty pProperty)
inline

Constructor.

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

Definition at line 1293 of file fbxobject.h.

1293 : FbxIteratorSrcBase(pProperty,Type::ClassId) {}
FbxIteratorSrcBase(FbxProperty &pProperty, FbxClassId pClassId)
Constructor.
Definition: fbxobject.h:1163

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

1299 { return (Type*)FbxIteratorSrcBase::GetFirst(); }
FbxObject * GetFirst()
Get the first source object that connects to the property or object.
Definition: fbxobject.h:1190
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 1305 of file fbxobject.h.

1305 { return (Type*)FbxIteratorSrcBase::GetNext(); }
FbxObject * GetNext()
Get next source object that connects to the property or object.
Definition: fbxobject.h:1200
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 1312 of file fbxobject.h.

1312 { return (Type*)FbxIteratorSrcBase::GetSafeNext(); }
FbxObject * GetSafeNext()
Get next source object that connects to the property or object.
Definition: fbxobject.h:1211
Type* GetLast ( )
inline

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

Returns
The last source object.

Definition at line 1318 of file fbxobject.h.

1318 { return (Type*)FbxIteratorSrcBase::GetLast(); }
FbxObject * GetLast()
Get the last source object that connects to the property or object.
Definition: fbxobject.h:1221
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 1325 of file fbxobject.h.

1325 { return (Type*)FbxIteratorSrcBase::GetPrevious(); }
FbxObject * GetPrevious()
Get previous source object that connects to the property or object.
Definition: fbxobject.h:1231
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 1333 of file fbxobject.h.

1333 { return (Type*)FbxIteratorSrcBase::GetSafePrevious(); }
FbxObject * GetSafePrevious()
Get previous source object that connects to the property or object.
Definition: fbxobject.h:1243

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