KFbxCollection Class Reference

This reference page is linked to from the following overview topics: FBX SDK Object Model, FBX Objects, Connections, List of Python FBX classes.

---

Search for all occurrences

---

Detailed Description

A KFbxObject derived container for KFbxObjects.

Definition at line 59 of file kfbxcollection.h.

#include <kfbxcollection.h>

Inheritance diagram for KFbxCollection:

List of all members.

Protected Member Functions
	KFbxCollection (KFbxSdkManager &pManager, char const *pName)
Collection member management
virtual void	Clear ()
	Deletes all objects in the container.
virtual bool	AddMember (KFbxObject *pMember)
	Adds a member.
virtual bool	RemoveMember (KFbxObject *pMember)
	Removes a member.
template<class T >
T *	FindMember (T const *pfbxType, const char *pName)
	Searches for a member of class T.
int	GetMemberCount () const
	Returns the number of objects contained within the collection.
template<class T >
int	GetMemberCount (T const *pFBX_TYPE) const
	Returns the number of class T objects contained within the collection.
int	GetMemberCount (KFbxCriteria pCriteria) const
	Returns the number of objects in the collection that satisfy the given criteria.
KFbxObject *	GetMember (int pIndex=0) const
	Returns the member of the collection at the given index.
template<class T >
T *	GetMember (T const *pFBX_TYPE, int pIndex=0) const
	Returns the member of class T at the given index in the collection.
KFbxObject *	GetMember (KFbxCriteria pCriteria, int pIndex=0) const
	Returns the member that satisfies the given criteria at the given index in the collection.
virtual bool	IsMember (const KFbxObject *pMember) const
	Judges whether an object is a part of the collection.
Selection management
virtual void	SetSelectedAll (bool pSelection)
	Selects/Deselects all the contained objects.
virtual void	SetSelected (KFbxObject *pObject, bool pSelection)
	Selects/Deselects an object.
virtual bool	GetSelected (KFbxObject *pObject)
	Returns whether the specified object is selected or not.

---

Constructor & Destructor Documentation

KFbxCollection	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		[protected]

---

Member Function Documentation

virtual void Clear

(

)

[virtual]

Search for all occurrences

Deletes all objects in the container.

Reimplemented in KFbxDocument, and KFbxScene.

virtual bool AddMember

(

KFbxObject *

pMember

)

[inline, virtual]

Search for all occurrences

Adds a member.

Parameters:

pMember

Object to be added.

Reimplemented in KFbxCollectionExclusive.

Examples:

Animation/main.cxx, Common/AnimationUtility.cxx, ExportDocument/main.cxx, ExportScene01/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, ExportScene04/main.cxx, Instances/main.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, and UserProperties/main.cxx.

Definition at line 74 of file kfbxcollection.h.

{ return ConnectSrcObject(pMember); }

virtual bool RemoveMember

(

KFbxObject *

pMember

)

[inline, virtual]

Search for all occurrences

Removes a member.

Parameters:

pMember

Object to be removed.

Definition at line 79 of file kfbxcollection.h.

{ return DisconnectSrcObject(pMember); }

T* FindMember	(	T const *	pfbxType,
		const char *	pName
	)		[inline]

Search for all occurrences

Searches for a member of class T.

Parameters:

pfbxType	Member type.
pName	Member name.

Examples:

ViewScene/main.cxx.

Definition at line 85 of file kfbxcollection.h.

{ return FindSrcObject(pfbxType, pName); }

int GetMemberCount

(

)

const [inline]

Search for all occurrences

Returns the number of objects contained within the collection.

Returns:

The number of objects the collection contains.

Examples:

Animation/main.cxx, ExportDocument/main.cxx, and ImportScene/DisplayAnimation.cxx.

Definition at line 90 of file kfbxcollection.h.

{ return GetSrcObjectCount(); }

int GetMemberCount

(

T const *

pFBX_TYPE

)

const [inline]

Search for all occurrences

Returns the number of class T objects contained within the collection.

Parameters:

pFBX_TYPE

Member type.

Returns:

The number of objects of class T the collection contains.

Definition at line 96 of file kfbxcollection.h.

{ return GetSrcObjectCount(T::ClassId); }

int GetMemberCount

(

KFbxCriteria

pCriteria

)

const

Search for all occurrences

Returns the number of objects in the collection that satisfy the given criteria.

Parameters:

pCriteria

The given criteria

Returns:

The number of objects in the collection that satisfy the given criteria.

KFbxObject* GetMember

(

int

pIndex = 0

)

const [inline]

Search for all occurrences

Returns the member of the collection at the given index.

Parameters:

pIndex

The given index.

Returns:

The member of the collection at the given index.

Examples:

Animation/main.cxx, ExportDocument/main.cxx, ImportScene/DisplayAnimation.cxx, and ViewScene/main.cxx.

Definition at line 108 of file kfbxcollection.h.

{ return GetSrcObject(pIndex); }

T* GetMember	(	T const *	pFBX_TYPE,
		int	pIndex = 0
	)		const [inline]

Search for all occurrences

Returns the member of class T at the given index in the collection.

Parameters:

pFBX_TYPE	Member type.
pIndex	The given index.

Returns:

The member of class T at the given index.

Definition at line 115 of file kfbxcollection.h.

{ return (T *)GetSrcObject(T::ClassId,pIndex); }

KFbxObject* GetMember	(	KFbxCriteria	pCriteria,
		int	pIndex = 0
	)		const

Search for all occurrences

Returns the member that satisfies the given criteria at the given index in the collection.

Parameters:

pCriteria	The given criteria.
pIndex	The given index.

Returns:

The member that satisfies the given criteria at the given index.

virtual bool IsMember

(

const KFbxObject *

pMember

)

const [virtual]

Search for all occurrences

Judges whether an object is a part of the collection.

Parameters:

pMember

The member to be judged.

Returns:

True if it is a member of the collection, returns false if it is not a member.

virtual void SetSelectedAll

(

bool

pSelection

)

[virtual]

Search for all occurrences

Selects/Deselects all the contained objects.

Parameters:

pSelection

If true, all objects are selected, if false, all objects are deselected.

virtual void SetSelected	(	KFbxObject *	pObject,
		bool	pSelection
	)		[virtual]

Search for all occurrences

Selects/Deselects an object.

Parameters:

pObject	The object to be selected or deselected.
pSelection	If true, pObject is selected, if false, pObject is deselected.

virtual bool GetSelected

(

KFbxObject *

pObject

)

[virtual]

Search for all occurrences

Returns whether the specified object is selected or not.

Parameters:

pObject

The specified object.

Returns:

Whether pObject is selected or not.

---

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

• fbxfilesdk/fbxcore/fbxcollection/kfbxcollection.h