KFbxCollection Class Reference

#include <kfbxcollection.h>

Inheritance diagram for KFbxCollection:

[legend]

List of all members.

---

Detailed Description

This class contains objects.

This class also provides access to global settings and take information.

Definition at line 61 of file kfbxcollection.h.

Collection member management
virtual void	Clear ()
	Delete all contained objects.
virtual bool	AddMember (KFbxObject *pMember)
	Add a member.
virtual bool	RemoveMember (KFbxObject *pMember)
	Remove a member.
template<class T>
T *	FindMember (T const *pfbxType, const char *pName)
	Find a member.
int	GetMemberCount () const
	Return the number of objects in the collection.
template<class T>
int	GetMemberCount (T const *pFBX_TYPE) const
	Return the number of objects of class T in the collection.
int	GetMemberCount (KFbxCriteria pCriteria) const
	Return the number of objects satisfying given criteria in the collection.
KFbxObject *	GetMember (int pIndex=0) const
	Return the index'th member of the collection.
template<class T>
T *	GetMember (T const *pFBX_TYPE, int pIndex=0) const
	Return the index'th member of class T in the collection.
KFbxObject *	GetMember (KFbxCriteria pCriteria, int pIndex=0) const
	Return the index'th member of the collection which satisfies given criteria.
virtual bool	IsMember (KFbxObject *pMember) const
	Is an object part of the collection.
Selection management
virtual void	SetSelectedAll (bool pSelection)
	Select/Deselect all contained objects.
virtual void	SetSelected (KFbxObject *pObject, bool pSelection)
	Select/Deselect objects.
virtual bool	GetSelected (KFbxObject *pObject)
	Get Selected/Deselected.

---

Member Function Documentation

virtual void Clear

(

)

[virtual]

Delete all contained objects.

Reimplemented in KFbxDocument, and KFbxScene.

virtual bool AddMember

(

KFbxObject *

pMember

)

[inline, virtual]

Add a member.

Parameters:

pMember

Object to be added.

Reimplemented in KFbxCollectionExclusive.

Definition at line 75 of file kfbxcollection.h.

References KFbxObject::ConnectSrcObject().

Referenced by KFbxDocument::AddRootMember().

virtual bool RemoveMember

(

KFbxObject *

pMember

)

[inline, virtual]

Remove a member.

Parameters:

pMember

Object to be removed.

Definition at line 79 of file kfbxcollection.h.

References KFbxObject::DisconnectSrcObject().

Referenced by KFbxDocument::RootRootRemoveMember().

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

Find a member.

Parameters:

	pfbxType	Member type.
	pName	Member name.

Definition at line 84 of file kfbxcollection.h.

References KFbxObject::FindSrcObject().

int GetMemberCount

(

)

const [inline]

Return the number of objects in the collection.

Returns:

The number of objects in the collection.

Definition at line 88 of file kfbxcollection.h.

References KFbxObject::GetSrcObjectCount().

Referenced by KFbxLibrary::InstantiateMember().

int GetMemberCount

(

T const *

pFBX_TYPE

)

const [inline]

Return the number of objects of class T in the collection.

Parameters:

pFBX_TYPE

Member type.

Returns:

The number of objects of class T in the collection.

Definition at line 93 of file kfbxcollection.h.

References KFbxObject::GetSrcObjectCount().

int GetMemberCount

(

KFbxCriteria

pCriteria

)

const

Return the number of objects satisfying given criteria in the collection.

Parameters:

pCriteria

The given criteria

Returns:

The number of objects satisfying given criteria in the collection.

KFbxObject* GetMember

(

int

pIndex = 0

)

const [inline]

Return the index'th member of the collection.

Parameters:

pIndex

The member index.

Returns:

The index'th member of the collection.

Definition at line 104 of file kfbxcollection.h.

References KFbxObject::GetSrcObject().

Referenced by KFbxLibrary::InstantiateMember().

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

Return the index'th member of class T in the collection.

Parameters:

	pFBX_TYPE	Member type information.
	pIndex	The member index.

Returns:

The index'th member of the collection.

Definition at line 110 of file kfbxcollection.h.

References KFbxObject::GetSrcObject().

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

Return the index'th member of the collection which satisfies given criteria.

Parameters:

	pCriteria	The given criteria.
	pIndex	The member index.

Returns:

The index'th member of the collection.

virtual bool IsMember

(

KFbxObject *

pMember

)

const [virtual]

Is an object part of the collection.

Parameters:

pMember

Whether pMember is part of the collection.

Returns:

True if is, false otherwise.

virtual void SetSelectedAll

(

bool

pSelection

)

[virtual]

Select/Deselect all contained objects.

Parameters:

pSelection

If true, all object are selected, otherwise all objects are unselected.

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

Select/Deselect objects.

Parameters:

	pObject
	pSelection	If true, pObject are selected, otherwise pObject are unselected.

virtual bool GetSelected

(

KFbxObject *

pObject

)

[virtual]

Get Selected/Deselected.

Parameters:

pObject

Get whether pObject is selected or unselected.