AnimProperty Class Reference
 
 
 
AnimProperty Class Reference

This reference page is linked to from the following overview topics: New Classes and Methods.


#include <AnimProperty.h>

Inheritance diagram for AnimProperty:
MaxHeapOperators AnimAppData EaseCurveAnimProp InterpCtrlUI InterpKeyInfo IShapeRectRenderParams JointParams MultCurveAnimProp NoteAnimProperty PStamp SchematicViewProperty

Class 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.

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]
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]
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.