Contains a set of animations that are played in parallel with the SetKey() method. More...

Inheritance diagram for disti::GlsAnimationCollection:

Public Types
typedef stdortr1::shared_ptr< GlsAnimationCollection >	Ptr
	Alias for easier reading.

typedef GlsKeyframeCurveBase::Key	Key
	Alias for easier reading.

typedef GlsKeyframeCurveBase::KeyPair	KeyPair
	Alias for easier reading.

Public Types inherited from disti::GlsAnimation
typedef stdortr1::shared_ptr< GlsAnimation >	Ptr
	Alias for easier reading.

typedef GlsKeyframeCurveBase::Key	Key
	Alias for easier reading.

typedef GlsKeyframeCurveBase::KeyPair	KeyPair
	Alias for easier reading.

typedef GlsKeyframeCurveBase::Size	Size
	Alias for easier reading.

Public Member Functions
	GlsAnimationCollection (const std::string &name, GlsAnimation *animation=0)

	GlsAnimationCollection (const std::string &name, const GlsAnimation::Ptr &animation)

void	Add (GlsAnimation *animation)

void	Add (const GlsAnimation::Ptr &animation)

Key	GetKeyRange () const
	Override from GlsAnimation.

KeyPair	GetMinMaxKeys () const
	Override from GlsAnimation.

bool	SetDisplayFrame (DisplayFrame *displayFrame)

bool	IsReadyToAnimate () const
	Override from GlsAnimation.

Key	GetKey () const
	Override from GlsAnimation.

void	SetKey (const Key &key)
	Override from GlsAnimation.

void	Reset ()
	Override from GlsAnimation.

GlsAnimation::Ptr	Clone () const
	Override from GlsAnimation.

Size	GetAnimationCount () const
	Gets the number of animations currently in the collection.

std::vector< std::string >	GetPropertyNames () const
	Override from GlsAnimation.

void	RetargetPropertyNames (const std::vector< std::string > &propertyNames)
	Override from GlsAnimation.

void	RetargetPropertyNames (const std::string &findStr, const std::string &replaceStr)
	Override from GlsAnimation.

Size	CountPropertyNames () const
	Override from GlsAnimation.

Public Member Functions inherited from disti::GlsAnimation
virtual	~GlsAnimation ()
	Destructor.

const std::string &	GetName () const
	Returns the given name of this animation sequence.

Additional Inherited Members
Protected Member Functions inherited from disti::GlsAnimation
	GlsAnimation (const std::string &name)
	Constructor - for base classes only.

Protected Attributes inherited from disti::GlsAnimation
DisplayFrame *	_displayFrame
	The display frame used for retargeting.

Detailed Description

Contains a set of animations that are played in parallel with the SetKey() method.

Constructor & Destructor Documentation

disti::GlsAnimationCollection::GlsAnimationCollection	(	const std::string &	name,
		GlsAnimation *	animation = `0`
	)

explicit

Constructs a named animation sequence

Parameters

name	The name of the animation sequence
animation	An optional animation object. If valid, the animation sequence takes ownership of the animation object.

disti::GlsAnimationCollection::GlsAnimationCollection	(	const std::string &	name,
		const GlsAnimation::Ptr &	animation
	)

explicit

Constructs a named animation sequence

Parameters

name	The name of the animation sequence
animation	An animation object.

void disti::GlsAnimationCollection::Add ( GlsAnimation * animation )

Adds an animation to an animation sequence

Parameters

animation The animation to add to the sequence. The animation sequence takes ownership of the animation object.

Precondition: animation != 0; Start() has not been called.; animation->GetKeyRange() is not NaN

void disti::GlsAnimationCollection::Add ( const GlsAnimation::Ptr & animation )

Adds an animation to an animation sequence

Parameters

animation The animation to add to the sequence.

Precondition: animation.get() != 0; Start() has not been called.; animation->GetKeyRange() is not NaN

bool disti::GlsAnimationCollection::SetDisplayFrame ( DisplayFrame * displayFrame )

virtual

Override from GlsAnimation

Returns: True indicates that all the given attributes already existed in the display frame, and false indicates that they did not and that SetKey() will not animate them.

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