ICopyCollection Class Reference

Search for all occurrences

---

Detailed Description

A collection of copies.

This contains a collection of IBipCopy objects - postures, poses, and tracks. Access to an IBipCopy object is based on its type and its index in the collection of copy objects. An instance of ICopyCollection can be gotten from the IBipMaster8 GetCopyCollection and CreateCopyCollection functions.

#include <Biped8Api.h>

Inheritance diagram for ICopyCollection:

List of all members.

Public Member Functions
virtual	~ICopyCollection ()
	Destructor.
virtual const MCHAR *	GetName () const =0
	Gets the name of the copy collection.
virtual bool	SetName (const MCHAR *name)=0
	Sets the name of the copy collection.
virtual int	NumCopies (int copyType)=0
	Gets the number of copies of the specified type (posture/pose/track).
virtual IBipedCopy *	GetCopy (int copyType, int index)=0
	Gets the copy of the specified type at the specified index.
virtual IBipedCopy *	GetCopy (int copyType, const MCHAR *name, int *index)=0
	Gets a copy of the specified type with the specified name.
virtual bool	DeleteCopy (int copyType, int index)=0
	Deletes a copy.
virtual void	DeleteAllCopies (int copyType)=0
	Deletes all copies of a particular type (posture/pose/track) in a collection.

---

Constructor & Destructor Documentation

virtual ~ICopyCollection

(

)

[inline, virtual]

Destructor.

{;}

---

Member Function Documentation

virtual const MCHAR* GetName

(

)

const [pure virtual]

Search for all occurrences

Gets the name of the copy collection.

Returns:

the name of the copy

virtual bool SetName

(

const MCHAR *

name

)

[pure virtual]

Search for all occurrences

Sets the name of the copy collection.

Precondition:

name must be <= 256 characters

Parameters:

[in]

name

- name of the copy collection

Returns:

true if the name was set, false if it wasn't set

virtual int NumCopies

(

int

copyType

)

[pure virtual]

Search for all occurrences

Gets the number of copies of the specified type (posture/pose/track).

Parameters:

[in]

copyType

- type of copy, one of the following: COPY_POSTURE, COPY_POSE, COPY_TRACK

Returns:

the number of copies of the specified type

virtual IBipedCopy* GetCopy	(	int	copyType,
		int	index
	)		[pure virtual]

Search for all occurrences

Gets the copy of the specified type at the specified index.

Parameters:

[in]	copyType	- type of copy, one of the following: COPY_POSTURE, COPY_POSE, COPY_TRACK
[in]	index	- the index of the desired copy

Returns:

the copy of the specified type at the specified index, and NULL if the copy was not found

virtual IBipedCopy* GetCopy	(	int	copyType,
		const MCHAR *	name,
		int *	index
	)		[pure virtual]

Search for all occurrences

Gets a copy of the specified type with the specified name.

Parameters:

[in]	copyType	- type of copy, one of the following: COPY_POSTURE, COPY_POSE, COPY_TRACK
[in]	name	- the name of the desired copy
[out]	index	- the index of the desired copy

Returns:

the copy of the specified type with the specified name, and NULL if the copy was not found

virtual bool DeleteCopy	(	int	copyType,
		int	index
	)		[pure virtual]

Search for all occurrences

Deletes a copy.

Parameters:

[in]	copyType	- type of copy, one of the following: COPY_POSTURE, COPY_POSE, COPY_TRACK
[in]	index	- the index of the copy to delete

Returns:

true if the copy was deleted, false if the copy was not found

virtual void DeleteAllCopies

(

int

copyType

)

[pure virtual]

Search for all occurrences

Deletes all copies of a particular type (posture/pose/track) in a collection.

Parameters:

[in]

copyType

- type of copy, one of the following: COPY_POSTURE, COPY_POSE, COPY_TRACK

Returns:

true if the copies were deleted, false if the copy collection was not found