CAnimationGroup Class

Article
04/28/2015

Implements an animation group, which combines an animation storyboard, animation objects, and transitions to define an animation.

class CAnimationGroup;

Members

Public Constructors

Name	Description
CAnimationGroup::CAnimationGroup	Constructs an animation group.
CAnimationGroup::~CAnimationGroup	The destructor. Called when an animation group is being destroyed.

Public Methods

Name	Description
CAnimationGroup::Animate	Animates a group.
CAnimationGroup::ApplyTransitions	Applies transitions to animation objects.
CAnimationGroup::FindAnimationObject	Finds an animation object that contains the specified animation variable.
CAnimationGroup::GetGroupID	Returns GroupID.
CAnimationGroup::RemoveKeyframes	Removes and optionally destroys all keyframes that belong to an animation group.
CAnimationGroup::RemoveTransitions	Removes transitions from animation objects that belong to an animation group.
CAnimationGroup::Schedule	Schedules an animation at the specified time.
CAnimationGroup::SetAutodestroyTransitions	Directs all animation objects that belong to group automatically destroy transitions.

Protected Methods

Name	Description
CAnimationGroup::AddKeyframes	A helper that adds keyframes to a storyboard.
CAnimationGroup::AddTransitions	A helper that adds transitions to a storyboard.
CAnimationGroup::CreateTransitions	A helper that creates COM transition objects.

Public Data Members

Name	Description
CAnimationGroup::m_bAutoclearTransitions	Specifies how to clear transitions from animation objects that belong to group. If this member is TRUE, transitions are removed automatically when an animation has been scheduled. Otherwise you need to remove transitions manually.
CAnimationGroup::m_bAutodestroyAnimationObjects	Specifies how to destroy animation objects. If this parameter is TRUE, animation objects will be destroyed automatically when the group is destroyed. Otherwise animation objects must be destroyed manually. The default value is FALSE. Set this value to TRUE only if all animation objects that belong to group are allocated dynamically with operator new.
CAnimationGroup::m_bAutodestroyKeyframes	Specifies how to destroy keyframes. If this value is TRUE, all keyframes are removed and destroyed; otherwise they are removed from the list only. The default value is TRUE.
CAnimationGroup::m_lstAnimationObjects	Contains a list of animation objects.
CAnimationGroup::m_lstKeyFrames	Contains a list of keyframes.
CAnimationGroup::m_pStoryboard	Points to animation storyboard. This pointer is valid only after call on Animate.

Protected Data Members

Name	Description
CAnimationGroup::m_nGroupID	A unique identifier of animation group.
CAnimationGroup::m_pParentController	A pointer to animation controller this group belongs to.

Remarks

Animation groups are created automatically by animation controller (CAnimationController) when you add animation objects using CAnimationController::AddAnimationObject. An animation group is identified by GroupID, which is usually taken as a parameter to manipulate animation groups. The GroupID is taken from the first animation object being added to a new animation group. An encapsulated animation storyboard is created after you call CAnimationController::AnimateGroup and can be accessed via public member m_pStoryboard.

Inheritance Hierarchy

CAnimationGroup

Requirements

Header: afxanimationcontroller.h