CAnimationBaseObject Class

Article
01/12/2013

The base class for all animation objects.

class CAnimationBaseObject : public CObject;

Members

Public Constructors

Name	Description
CAnimationBaseObject::CAnimationBaseObject	Overloaded. Constructs an animation object.
CAnimationBaseObject::~CAnimationBaseObject	The destructor. Called when an animation object is being destroyed.

Public Methods

Name	Description
CAnimationBaseObject::ApplyTransitions	Adds transitions to storyboard with encapsulated animation variable.
CAnimationBaseObject::ClearTransitions	Removes all related transitions.
CAnimationBaseObject::ContainsVariable	Determines whether an animation object contains a particular animation variable.
CAnimationBaseObject::CreateTransitions	Creates transitions associated with an animation object.
CAnimationBaseObject::DetachFromController	Detaches an animation object from parent animation controller.
CAnimationBaseObject::EnableIntegerValueChangedEvent	Sets up Integer Value Changed event handler.
CAnimationBaseObject::EnableValueChangedEvent	Sets up Value Changed event handler.
CAnimationBaseObject::GetAutodestroyTransitions	Tells whether related transition are destroyed automatically.
CAnimationBaseObject::GetGroupID	Returns current Group ID.
CAnimationBaseObject::GetObjectID	Returns current Object ID.
CAnimationBaseObject::GetUserData	Returns user defined data.
CAnimationBaseObject::SetAutodestroyTransitions	Sets a flag that orders to automatically destroy transitions.
CAnimationBaseObject::SetID	Sets new IDs.
CAnimationBaseObject::SetUserData	Sets user-defined data.

Protected Methods

Name	Description
CAnimationBaseObject::GetAnimationVariableList	Collects pointers to contained animation variables.
CAnimationBaseObject::SetParentAnimationObjects	Establishes relationship between animation variables, contained in an animation object, and their container.

Protected Data Members

Name	Description
CAnimationBaseObject::m_bAutodestroyTransitions	Specifies whether related transitions should be automatically destroyed.
CAnimationBaseObject::m_dwUserData	Stores user-defined data.
CAnimationBaseObject::m_nGroupID	Specifies the Group ID of the animation object.
CAnimationBaseObject::m_nObjectID	Specifes the Object ID of the animation object.
CAnimationBaseObject::m_pParentController	A pointer to the parent animation controller.

Remarks

This class implements basic methods for all animation objects. An animation object can represent a value, point, size, rectangle or color in an application, as well as any custom entity. Animation objects are stored in animation groups (see CAnimationGroup). Each group can be animated separately and can be treated as an analogue of storyboard. An animation object encapsulates one or more animation variables (see CAnimationVariable), depending on its logical representation. For example, CAnimationRect contains four animation variables - one variable for each side of rectangle. Each animation object class exposes overloaded AddTransition method, which should be used to apply transitions to encapsulated animation variables. An animation object can be identified by Object ID (optionally) and by Group ID. A Group ID is necessary in order to place an animation object to correct group, but if a Group ID is not specified, an object is placed in the default group with ID 0. If you call SetID with different GroupID, an animation object will be moved to another group (a new group is created if necessary).

Inheritance Hierarchy

CObject

CAnimationBaseObject

Requirements

Header: afxanimationcontroller.h