AnimProperty Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class Animatable.

Description:

This is the base class for classes that can be hung off an animatable's property list. When an animatable is deleted, its properties will be deleted and their virtual destructor will be called.

#include <AnimProperty.h>

Inheritance diagram for AnimProperty:

List of all members.

Public Member Functions
virtual BOOL	DontDelete ()
virtual	~AnimProperty ()
virtual DWORD	ID ()=0

---

Constructor & Destructor Documentation

virtual ~AnimProperty

(

)

[inline, virtual]

{}

---

Member Function Documentation

virtual BOOL DontDelete

(

)

[inline, virtual]

Search for all occurrences

Remarks:

When the animatable is destroyed it will normally delete all the properties. If a plug-in wants to add a property to the list that it does not want deleted it can implement this method to return TRUE.

Returns:

TRUE if the item should not be deleted; otherwise FALSE.

Default Implementation:

{return FALSE;}

{return FALSE;}

virtual DWORD ID

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the ID of the property. Values above PROPID_USER can be used by plug-ins. Note: that a plug-in should only put user defined properties on its own list. So IDs only have to be unique within a plug-in. If a plug-in needs to attach data to another object, it can do so via APP_DATA.

Implemented in AnimAppData, EaseCurveAnimProp, MultCurveAnimProp, InterpCtrlUI, InterpKeyInfo, JointParams, NoteAnimProperty, IShapeRectRenderParams, and SchematicViewProperty.