StdControl Class Reference

#include <control.h>

Class Description

See also

Class Control, Class Interval, Class Matrix3, Class Point3, Additional_Controller_Related_Functions, Class Quat, Class ScaleValue

Description:

StdControl is a class from which you may derived controller objects. Controllers are the objects in 3ds Max that control animation. Any controller that does not evaluate itself as a function of its input can subclass off this class.

The purpose of this class is to simplify some aspects of implementing controllers. The only restriction when using this class is that the controller can not evaluate itself as a function of its input. For example, position, rotation, and scale controllers are passed a TM when they are evaluated. They are supposed to calculate their value and apply it to the TM (pre-multiply). It is possible that the controller could calculate its value as some function of this input matrix. For example, a rotation controller could look at the position of the matrix and the position of some other node in the scene and calculate the rotation such that the object is looking at the other node. Most controllers don't do this so they can subclass off this class which handles processing ORTs (Out of Range Types), ease curves and multiplier curves.

This class implements GetValue() and SetValue() but requires the derived class to implement two new methods: GetValueLocalTime() and SetValueLocalTime().

The implementations of GetValue() and SetValue() handle processing the ORTs and ease and multiplier curves.

Plug-In Information:

Class Defined In CONTROL.H

Super Class ID CTRL_FLOAT_CLASS_ID - Used by float controllers.

CTRL_POINT3_CLASS_ID - Used by Point3 controllers.

CTRL_MATRIX3_CLASS_ID - Used by Matrix3 controllers.

CTRL_POSITION_CLASS_ID - Used by position controllers.

CTRL_ROTATION_CLASS_ID - Used by rotation controllers.

CTRL_SCALE_CLASS_ID - Used by scale controllers.

CTRL_MORPH_CLASS_ID - Used by morph controllers.

Standard File Name Extension DLC

Extra Include File Needed None

Inheritance diagram for StdControl:

Public Member Functions
virtual void	GetValueLocalTime (TimeValue t, void *val, Interval &valid, GetSetMethod method=CTRL_ABSOLUTE)=0
virtual void	SetValueLocalTime (TimeValue t, void *val, int commit=1, GetSetMethod method=CTRL_ABSOLUTE)=0
CoreExport void	GetValue (TimeValue t, void *val, Interval &valid, GetSetMethod method=CTRL_ABSOLUTE)
CoreExport void	SetValue (TimeValue t, void *val, int commit=1, GetSetMethod method=CTRL_ABSOLUTE)
CoreExport bool	GetLocalTMComponents (TimeValue t, TMComponentsArg &cmpts, Matrix3Indirect &parentMatrix)
virtual void	Extrapolate (Interval range, TimeValue t, void *val, Interval &valid, int type)=0
virtual void *	CreateTempValue ()=0
virtual void	DeleteTempValue (void *val)=0
virtual void	ApplyValue (void *val, void *delta)=0
virtual void	MultiplyValue (void *val, float m)=0
Public Member Functions inherited from Control
CoreExport	Control ()
virtual	~Control ()
virtual BOOL	InheritsParentTransform ()
CoreExport int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold. More...
CoreExport RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference. More...
CoreExport int	NumSubs ()
CoreExport Animatable *	SubAnim (int i)
CoreExport MSTR	SubAnimName (int i)
CoreExport void *	GetInterface (ULONG id)
	Inherited from Animatable. More...
CoreExport int	PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
CoreExport int	GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	This method is called to calculate the largest and smallest values of the anim. More...
virtual CoreExport void	BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
virtual BOOL	PreventNodeDeletion ()
virtual CoreExport float	EvalVisibility (TimeValue t, View &view, Box3 pbox, Interval &valid)
virtual BOOL	VisibleInViewports ()
virtual BOOL	CanInstanceController ()
CoreExport void	CloneControl (Control *ctrl, RemapDir &remap)
virtual CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *object, int id, DWORD flags)
virtual CoreExport MSTR	SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
virtual CoreExport bool	SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
virtual CoreExport bool	SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
virtual CoreExport bool	SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
virtual void	Copy (Control *from)=0
virtual BOOL	IsReplaceable ()
virtual void	CommitValue (TimeValue t)
virtual void	RestoreValue (TimeValue t)
virtual INode *	GetTarget ()
virtual RefResult	SetTarget (INode *targ)
virtual Control *	GetPositionController ()
virtual Control *	GetRotationController ()
virtual Control *	GetScaleController ()
virtual BOOL	SetPositionController (Control *c)
virtual BOOL	SetRotationController (Control *c)
virtual BOOL	SetScaleController (Control *c)
virtual Control *	GetXController ()
virtual Control *	GetYController ()
virtual Control *	GetZController ()
virtual Control *	GetWController ()
virtual Control *	GetRollController ()
virtual BOOL	SetRollController (Control *c)
virtual DWORD	GetInheritanceFlags ()
virtual BOOL	SetInheritanceFlags (DWORD f, BOOL keepPos)
virtual BOOL	ChangeParents (TimeValue t, const Matrix3 &oldP, const Matrix3 &newP, const Matrix3 &tm)
virtual RefResult	PinNodeChanged (RefMessage message, const Interval &changeInt, PartID &partID)
virtual BOOL	IsColorController ()
virtual BOOL	IsLeaf ()
virtual int	IsKeyable ()
virtual int	GetORT (int type)
virtual CoreExport void	SetORT (int ort, int type)
virtual CoreExport void	EnableORTs (BOOL enable)
CoreExport IOResult	Save (ISave *isave)
CoreExport IOResult	Load (ILoad *iload)
virtual void	EnumIKParams (IKEnumCallback &callback)
virtual BOOL	CompDeriv (TimeValue t, Matrix3 &ptm, IKDeriv &derivs, DWORD flags)
virtual float	IncIKParam (TimeValue t, int index, float delta)
virtual void	ClearIKParam (Interval iv, int index)
virtual void	InitIKJoints (InitJointData *posData, InitJointData *rotData)
virtual BOOL	GetIKJoints (InitJointData *posData, InitJointData *rotData)
virtual BOOL	GetDOFParams (TimeValue t, Matrix3 &ptm, DOFParams &dofs, BOOL nodeSel)
virtual BOOL	CreateLockKey (TimeValue t, int which)
virtual void	MirrorIKConstraints (int axis, int which, BOOL pasteMirror=FALSE)
virtual BOOL	TerminateIK ()
virtual void	InitIKJoints2 (InitJointData2 *posData, InitJointData2 *rotData)
virtual BOOL	GetIKJoints2 (InitJointData2 *posData, InitJointData2 *rotData)
virtual void	NodeIKParamsChanged ()
virtual void	TMInvalidated ()
virtual BOOL	OKToBindToNode (INode *node)
virtual BOOL	CanCopyIKParams (int which)
virtual IKClipObject *	CopyIKParams (int which)
virtual BOOL	CanPasteIKParams (IKClipObject *co, int which)
virtual void	PasteIKParams (IKClipObject *co, int which)
virtual BOOL	CanApplyEaseMultCurves ()
CoreExport TimeValue	ApplyEase (TimeValue t, Interval &valid)
CoreExport void	AppendEaseCurve (Control *cont)
CoreExport void	DeleteEaseCurve (int i)
CoreExport Control *	GetEaseCurve (int i)
CoreExport int	NumEaseCurves ()
CoreExport float	GetMultVal (TimeValue t, Interval &valid)
CoreExport void	AppendMultCurve (Control *cont)
CoreExport void	DeleteMultCurve (int i)
CoreExport Control *	GetMultCurve (int i)
CoreExport int	NumMultCurves ()
virtual void	PostCloneNode ()
virtual int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
virtual int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt)
virtual void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box)
virtual void	ActivateSubobjSel (int level, XFormModes &modes)
virtual void	SelectSubComponent (CtrlHitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
virtual void	ClearSelection (int selLevel)
virtual int	SubObjectIndex (CtrlHitRecord *hitRec)
virtual void	SelectAll (int selLevel)
virtual void	InvertSelection (int selLevel)
virtual void	GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node)
virtual void	GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node)
virtual void	SubMove (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
virtual void	SubRotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
virtual void	SubScale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
virtual BOOL	RescaleTime (Interval oseg, Interval nseg)
virtual int	GetDrawPixelStep ()
virtual int	GetExtentTimeStep ()
Public Member Functions inherited from ReferenceTarget
virtual CoreExport void	GetClassName (MSTR &s)
	Retrieves the (localizable) name of the plugin class. More...
virtual CoreExport SClass_ID	SuperClassID ()
	Retrieves a constant representing the type of the plugin. More...
virtual BOOL	IsRefTarget ()
	Checks if this is a ReferenceTarget. More...
CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference. More...
CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references. More...
CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents. More...
void	BeginDependencyTest ()
	Starts Dependency Test. More...
BOOL	EndDependencyTest ()
	Ends Dependency Test. More...
virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target. More...
virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo. More...
virtual void	RefDeleted ()
	Called after a references to this is deleted. More...
virtual void	RefDeletedUndoRedo ()
	Called after a references to this is deleted because of undo or redo. More...
CoreExport RefResult	DeleteAllRefsToMe ()
	Deletes all references to this ReferenceTarget. More...
CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this. More...
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...
virtual CoreExport RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object. More...
virtual CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=NULL, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS)
	Notify all dependent RefMakers concerned with the message. More...
void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline. More...
virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG. More...
virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets. More...
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
	Inherited from Animatable. More...
CoreExport	ReferenceTarget ()
	Constructor. More...
virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents. More...
CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents. More...
Public Member Functions inherited from ReferenceMaker
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers. More...
CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker. More...
CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item. More...
CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference. More...
virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered. More...
CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker. More...
virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references. More...
virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy. More...
virtual CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags)
	Enumerate auxiliary files (e.g. bitmaps) More...
virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration. More...
virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save. More...
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...
CoreExport bool	EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
	This method provides a general purpose reference enumerator. More...
CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget. More...
virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker. More...
virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not. More...
virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save. More...
CoreExport	ReferenceMaker ()
	Constructor. More...
CoreExport void	DeleteMe ()
	Deletes an instance of this class. More...
Public Member Functions inherited from Animatable
virtual void	FreeCaches ()
virtual int	NumChildren ()
virtual Animatable *	ChildAnim (int i)
virtual CoreExport MSTR	NodeName ()
virtual void	EditTrack ()
virtual CoreExport BOOL	SubAnimSetKeyBufferPresent (int subNum)
	returns true if the sub-anim has a "Set Key" buffer present More...
virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present More...
virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim. More...
virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers. More...
virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim. More...
virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers. More...
virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete. More...
virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used. More...
virtual bool	GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
	This method is called to access the object specified name to use for the Maxscript macrorecorder. More...
CoreExport	Animatable ()
	Constructor. More...
virtual CoreExport void	DeleteThis ()
	Deletes an instance of this class. More...
MSTR	ClassName () const
	Returns the name of the plugin class. More...
virtual CoreExport Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class. More...
virtual void	BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev=NULL)
virtual void	EndEditParams (IObjParam *ip, ULONG flags, Animatable *next=NULL)
virtual CoreExport void	ReleaseInterface (ULONG id, void *i)
virtual CoreExport int	SetProperty (ULONG id, void *data)
virtual CoreExport void *	GetProperty (ULONG id)
CoreExport void	AppendProperty (AnimProperty *prop)
	A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs. More...
CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property. More...
CoreExport void	AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
	Adds application/plugin specific (custom) data to an Animatable. More...
CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable. More...
CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable. More...
CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable. More...
virtual BOOL	CanDeleteSubAnim (int i)
virtual void	DeleteSubAnim (int i)
virtual DWORD	GetSubAnimCurveColor (int subNum)
virtual int	SubNumToRefNum (int subNum)
virtual BOOL	CanCopyAnim ()
CoreExport int	HasSubElements (int type=0)
virtual int	GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	The values max and min should be initialized before calling this function. More...
virtual ParamDimension *	GetParamDimension (int i)
virtual BOOL	SelectSubAnim (int subNum)
virtual BOOL	BypassTreeView ()
virtual BOOL	BypassTrackBar ()
virtual BOOL	BypassPropertyLevel ()
virtual BOOL	InvisibleProperty ()
virtual int	NumKeys ()
virtual TimeValue	GetKeyTime (int index)
virtual int	GetKeyIndex (TimeValue t)
virtual BOOL	GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
virtual void	CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
virtual void	DeleteKeyAtTime (TimeValue t)
virtual BOOL	IsKeyAtTime (TimeValue t, DWORD flags)
virtual int	GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
virtual int	GetKeySelState (BitArray &sel, Interval range, DWORD flags)
CoreExport void	OpenTreeEntry (int type, DWORD tv)
CoreExport void	CloseTreeEntry (int type, DWORD tv)
CoreExport int	IsTreeEntryOpen (int type, DWORD tv)
CoreExport BOOL	GetSelInTrackView (DWORD tv)
CoreExport void	SetSelInTrackView (DWORD tv, BOOL sel)
CoreExport BOOL	InTrackViewSelSet (int which)
CoreExport void	SetTrackViewSelSet (int which, BOOL inOut)
virtual BOOL	AssignController (Animatable *control, int subAnim)
virtual BOOL	CanAssignController (int subAnim)
	Return true if we can reassign the subanim specified. More...
virtual BOOL	CanMakeUnique ()
CoreExport int	EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
virtual int	RenderBegin (TimeValue t, ULONG flags=0)
virtual int	RenderEnd (TimeValue t)
virtual CoreExport Interval	GetTimeRange (DWORD flags)
virtual void	EditTimeRange (Interval range, DWORD flags)
virtual void	DeleteTime (Interval iv, DWORD flags)
virtual void	ReverseTime (Interval iv, DWORD flags)
virtual void	ScaleTime (Interval iv, float s)
virtual void	InsertTime (TimeValue ins, TimeValue amount)
virtual BOOL	SupportTimeOperations ()
virtual CoreExport void	MapKeys (TimeMap *map, DWORD flags)
virtual void	DeleteKeys (DWORD flags)
virtual void	DeleteKeyByIndex (int index)
virtual void	SelectKeys (TrackHitTab &sel, DWORD flags)
virtual void	SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
virtual void	SelectSubCurve (int subNum, BOOL sel)
virtual void	SelectKeyByIndex (int i, BOOL sel)
virtual BOOL	IsKeySelected (int i)
virtual void	FlagKey (TrackHitRecord hit)
virtual int	GetFlagKeyIndex ()
virtual int	NumSelKeys ()
virtual void	CloneSelectedKeys (BOOL offset=FALSE)
virtual void	AddNewKey (TimeValue t, DWORD flags)
virtual void	MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
virtual void	ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
virtual void	SelectCurve (BOOL sel)
virtual BOOL	IsCurveSelected ()
	Returns TRUE if the function curve is selected; otherwise returns FALSE. More...
virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed. More...
virtual int	GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
virtual void	SetSelKeyCoords (TimeValue t, float val, DWORD flags)
virtual int	SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
virtual CoreExport BOOL	IsAnimated ()
virtual BOOL	CanCopyTrack (Interval iv, DWORD flags)
virtual BOOL	CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
virtual TrackClipObject *	CopyTrack (Interval iv, DWORD flags)
virtual void	PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
virtual BOOL	CanCopySubTrack (int subNum, Interval iv, DWORD flags)
virtual BOOL	CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
virtual TrackClipObject *	CopySubTrack (int subNum, Interval iv, DWORD flags)
virtual void	PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
virtual int	GetTrackVSpace (int lineHeight)
virtual int	HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)
virtual int	PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
virtual int	PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
virtual int	HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual void	EditTrackParams (TimeValue t, ParamDimensionBase *dim, const MCHAR *pname, HWND hParent, IObjParam *ip, DWORD flags)
virtual int	TrackParamsType ()
CoreExport void	AddNoteTrack (NoteTrack *note)
CoreExport void	DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)
CoreExport BOOL	HasNoteTracks ()
CoreExport int	NumNoteTracks ()
CoreExport NoteTrack *	GetNoteTrack (int i)
virtual void	FreeAllBitmaps ()
virtual void	GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
virtual BOOL	IsSubClassOf (Class_ID classID)
	returns true if the animatable has sub-classed off the given class More...
virtual CoreExport void	MouseCycleCompleted (TimeValue t)
virtual CoreExport void	MouseCycleStarted (TimeValue t)
virtual int	NumParamBlocks ()
virtual IParamBlock2 *	GetParamBlock (int i)
virtual IParamBlock2 *	GetParamBlockByID (short id)
CoreExport bool	SvSaveData (ISave *isave, USHORT id)
CoreExport bool	SvLoadData (ILoad *iLoad)
CoreExport DWORD	SvGetRefIndex ()
CoreExport void	SvSetRefIndex (DWORD i)
CoreExport bool	SvDeleteRefIndex ()
CoreExport SvGraphNodeReference	SvStdTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
virtual CoreExport bool	SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
virtual CoreExport bool	SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
	Called when the user deletes this object in the schematic view... More...
virtual CoreExport bool	SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
	Returns true if the object is selected in its schematic view. More...
virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport COLORREF	SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
virtual CoreExport bool	SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"... More...
virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method... More...
virtual CoreExport bool	SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship. More...
virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view... More...
CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class. More...
CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container. More...
CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container. More...
void	SetAFlag (DWORD mask)
void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags. More...
bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags. More...
void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags. More...
void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags. More...
bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags. More...
CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit. More...
CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit. More...
CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit. More...
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted. More...
static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object. More...
static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle. More...
static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables. More...
static CoreExport bool	RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...
static CoreExport bool	UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...
static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...
static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...
static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index. More...
static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index. More...
static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables. More...
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0
Protected Member Functions inherited from Control
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`. More...
Protected Member Functions inherited from ReferenceTarget
virtual CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep)
	Method to perform an enumeration on a ReferenceTarget. More...
virtual CoreExport	~ReferenceTarget ()=0
	Destructor. More...
Protected Member Functions inherited from ReferenceMaker
virtual RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)=0
	Receives and responds to messages. More...
virtual CoreExport	~ReferenceMaker ()=0
	Destructor. More...
void	BlockEval ()
void	UnblockEval ()
int	Evaluating ()
CoreExport RefResult	StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor. More...
Protected Member Functions inherited from Noncopyable
	Noncopyable ()
	~Noncopyable ()
Protected Attributes inherited from Animatable
DWORD	aflag
AnimPropertyList	aprops

Member Function Documentation

virtual void GetValueLocalTime ( TimeValue  t, void *  val, Interval &  valid, GetSetMethod  method = CTRL_ABSOLUTE  )

pure virtual

Remarks

This method is called to have the controller evaluate itself at the given time. In this class the system implements the method GetValue(). GetValue() calls this method to retrieves the value of the controller at the specified time. The implementation of GetValue() then takes care of handling the ORTs, ease curves and multiplier curves. The plug-in must only return the value of the controller.

Parameters

t	The time to retrieve the value.
val	This points to a variable to hold the computed value of the controller at the specified time. What the plug-in needs to do to store the value of the controller depends on the controller type. There are six controller types as follows: float *val points to a float Point3 *val points to a Point3 Position *val points to a Point3 Rotation *val points to a Quat Scale *val points to a ScaleValue Transform *val points to a Matrix3
valid	The interval into which the validity of the evaluated parameters is intersected.
method	This will always be: CTRL_ABSOLUTE . It indicates the controller should simply store its value in *val.

virtual void SetValueLocalTime ( TimeValue  t, void *  val, int  commit = 1, GetSetMethod  method = CTRL_ABSOLUTE  )

pure virtual

Remarks

In this class the system implements the method SetValue(). SetValue() calls this method to store the value of the controller at the specified time. The system takes care of handling the ORTs and multiplier curves. The plug-in must only store the value of the controller.

Parameters

t	The time to store the value.
val	Storage for the value to set. See *val in Control::SetValue() for the possible data types passed here.
commit	If this parameter is zero, the controller should save the value at the given time before setting the value. If commit is nonzero, the controller doesn't need to actually update its keys or tangents. See Control methods CommitValue() and RestoreValue().
method	One of the following values: CTRL_RELATIVE Indicates the plug-in should add the value to the existing value *val (i.e. Move/Rotate/Scale) CTRL_ABSOLUTE Indicates the plug-in should just set the value.

CoreExport void GetValue ( TimeValue  t, void *  val, Interval &  valid, GetSetMethod  method = CTRL_ABSOLUTE  )

virtual

Remarks

This method is implemented by the system. Controller that subclass from StdControl only need to implement GetValueLocalTime(). See above.

Implements Control.

CoreExport void SetValue ( TimeValue  t, void *  val, int  commit = 1, GetSetMethod  method = CTRL_ABSOLUTE  )

virtual

Remarks

This method is implemented by the system. Controller that subclass from StdControl only need to implement SetValueLocalTime(). See above.

Implements Control.

CoreExport bool GetLocalTMComponents ( TimeValue  t, TMComponentsArg &  cmpts, Matrix3Indirect &  parentMatrix  )

virtual

Remarks

This method returns the PRS components of the local matrix. In general, controller cannot decide on the local matrix without knowing the parent matrix. However, many controllers, such as default controllers, are well defined without the parent matrix. In these cases, it is more efficient to compute the local components directly without going through the world matrix.

Therefore, the argument parentMatrix is a reference to Matrix3Indirect. This would allow clients to supply a "delayed parent matrix," which will be computed only if it is necessary. It returns true for Matrix3, Position, Rotation, or Scale controllers, and return false otherwise.

The PRS components will be put in argument cmpts in the respective fields with corresponding validity intervals. NULL pointer, of TMComponentsArg::position for example, indicates that the client is not concerned about the component. When it is not NULL, the corresponding pointer to the validity interval MUST NOT be NULL. When it is not NULL, TMComponentsArg::rotation is a float[4]. rotRep tells what the numbers mean.

Position, Rotation, or Scale, controllers will put results at the respective component when the corresponding pointer is not NULL.

Upon entry, parentMatrix should represent the parent matrix up to the first requested components. For Matrix3 controllers, for example, if cmpts.position==NULL && cmpts.rotation!=NULL, then parentMatrix should be matrix that includes the parent node matrix plus the position of this node. Upon return, this matrix may be modified.

Parameters

t	The time at which to get the local TM components.
cmpts	See Structure TMComponentsArgs.
parentMatrix	The parent matrix. Note the definition: LocalMatrix = WorldMatrix * ParentWorldMatrix^(-1)

Reimplemented from Control.

virtual void Extrapolate ( Interval  range, TimeValue  t, void *  val, Interval &  valid, int  type  )

pure virtual

Remarks

This method is used to calculate some of the Out of Range Types (ORTs). There are several kinds of extrapolations that need to be done based on the ORT type. There are template functions implemented in CONTROL.H to do them. See Template Extrapolation Functions.

Parameters

range	The range that must be extrapolated.
t	The time outside the range to extrapolate.
val	Storage for the extrapolated value. See *val in GetValueLocalTime() for the possible data types passed here.
valid	The interval into which the validity of the evaluated parameters is intersected.
type	See Out of Range Types.

Sample Code:

The following sample code shows the implementation in the Simple Wave Controller (MAXSDK/samples/controllers/wavectrl/simpwave.cpp).

void FloatWaveControl::Extrapolate(
      Interval range,TimeValue t,void *val,Interval &valid,int type)
   {
   float val0, val1, val2, res = 0.0f;
   switch (type) {
      case ORT_LINEAR:        
         if (t<range.Start()) {
            GetValueLocalTime(range.Start(),&val0,valid);
            GetValueLocalTime(range.Start()+1,&val1,valid);
            res = LinearExtrapolate(range.Start(),t,val0,val1,val0);          
         } else {
            GetValueLocalTime(range.End()-1,&val0,valid);
            GetValueLocalTime(range.End(),&val1,valid);
            res = LinearExtrapolate(range.End(),t,val0,val1,val1);
            }
         break;

      case ORT_IDENTITY:
         if (t<range.Start()) {
            GetValueLocalTime(range.Start(),&val0,valid);
            res = IdentityExtrapolate(range.Start(),t,val0);
         } else {
            GetValueLocalTime(range.End(),&val0,valid);
            res = IdentityExtrapolate(range.End(),t,val0);
            }
         break;

      case ORT_RELATIVE_REPEAT:
         GetValueLocalTime(range.Start(),&val0,valid);
         GetValueLocalTime(range.End(),&val1,valid);
         GetValueLocalTime(CycleTime(range,t),&val2,valid);
         res = RepeatExtrapolate(range,t,val0,val1,val2);         
         break;
      }
   valid.Set(t,t);
   *((float*)val) = res;
   }

virtual void* CreateTempValue ( )

pure virtual

Remarks

When processing the ORTs the system might need a temporary variable to hold an intermediate value. Since the system doesn't know the type of the data that the controller is controlling it can't allocate the right amount of temporary storage. It calls this method to do so. The plug-in's implementation of this method should allocate storage to hold its type of data and return a pointer to it.

virtual void DeleteTempValue ( void *  val )

pure virtual

Remarks

This method simply deletes the memory allocated by CreateTempValue().

Parameters

val	Points to the memory allocated by CreateTempValue().

virtual void ApplyValue ( void *  val, void *  delta  )

pure virtual

Remarks

Applies the given value to the given input value. For position, rotation, and scale controllers, the input value will be a matrix and the value being applied will be a Point3, Quaternion, or ScaleValue, respectively. For other controllers the input value is the same type as the value being applied.

Parameters

val	The value to update.
delta	The value to apply.

virtual void MultiplyValue ( void *  val, float  m  )

pure virtual

Remarks

If the controller has multiplier curves then the system will calculate the factor from all the multiplier curves and then ask the controller to multiply the scalar value to the particular data type.

Parameters

val	The value to update.
m	The scalar value to multiply *val by.