#include <mxsPlugin.h>

Inheritance diagram for MSPluginTrackViewUtility:

Public Member Functions
	MSPluginTrackViewUtility ()

	MSPluginTrackViewUtility (MSPluginClass *pc, BOOL loading)

	~MSPluginTrackViewUtility ()

void	BeginEditParams (Interface pIp, ITVUtility pIu) override

void	EndEditParams (Interface pIp, ITVUtility pIu) override

void	TrackSelectionChanged () override

void	NodeSelectionChanged () override

void	KeySelectionChanged () override

void	TimeSelectionChanged () override

void	MajorModeChanged () override

void	TrackListChanged () override

int	FilterAnim (Animatable anim, Animatable client, int subNum) override

HWND	AddRollupPage (HINSTANCE hInst, const MCHAR dlgTemplate, DLGPROC dlgProc, const MCHAR title, LPARAM param=0, DWORD vflags=0, int category=ROLLUP_CAT_STANDARD) override

void	DeleteRollupPage (HWND hRollup) override

IRollupWindow *	GetRollupWindow () override

void	RollupMouseMessage (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam) override

ReferenceTarget *	get_delegate () override

void	DeleteThis () override

void	GetClassName (MSTR &s, bool localized) const override
	Retrieves the name of the plugin class.

Class_ID	ClassID () override

void	FreeCaches () override

int	NumSubs () override

Animatable *	SubAnim (int i) override

MSTR	SubAnimName (int i, bool localized=true) override

int	NumParamBlocks () override

IParamBlock2 *	GetParamBlock (int i) override

IParamBlock2 *	GetParamBlockByID (BlockID id) override

void *	GetInterface (ULONG id) override

RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate) override
	Receives and responds to messages.

int	NumRefs () override
	Returns the total number of references this ReferenceMaker can hold.

RefTargetHandle	GetReference (int i) override
	Returns the 'i-th' reference.

RefTargetHandle	Clone (RemapDir &remap) override
	This method is used by 3ds Max to clone an object.

CoreExport void *	GetInterface (ULONG id) override
	Inherited from Animatable.

CoreExport BaseInterface *	GetInterface (Interface_ID id) override
	Inherited from Animatable.

Public Member Functions inherited from MSPlugin
	MSPlugin ()

virtual	~MSPlugin ()

void	init (MSPluginClass *pClass)

ScripterExport void	gc_trace () override

ScripterExport void	collect () override

void	DeleteThis ()

void	init_locals ()

void	call_handler (Value handler, Value *arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)

Value *	_call_handler (Value handler, Value *arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)

FPStatus	call_handler (const MCHAR handler_name, FPParams params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)

FPStatus	call_handler (Value handler, FPParams params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)

void	post_create (ReferenceTarget *me, BOOL loading)

void	call_all_set_handlers ()

void	disable ()

void	enable ()

BOOL	enabled ()

int	get_local_index (Value *prop)

Value *	get_local (int index)

void	set_local (int index, Value *val)

ScripterExport IParamBlock2 *	GetParamBlockByID (BlockID id)

virtual HWND	AddRollupPage (HINSTANCE hInst, const MCHAR dlgTemplate, DLGPROC dlgProc, const MCHAR title, LPARAM param=0, DWORD vflags=0, int category=ROLLUP_CAT_STANDARD)=0

virtual void	DeleteRollupPage (HWND hRollup)=0

virtual IRollupWindow *	GetRollupWindow ()=0

virtual void	RollupMouseMessage (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)=0

ScripterExport RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)

ScripterExport RefTargetHandle	clone_from (MSPlugin obj, ReferenceTarget obj_as_ref, RemapDir &remap)

void	RefAdded (RefMakerHandle rm)

ScripterExport void	RefDeleted (RefMakerHandle rm)

void	NotifyTarget (int msg, RefMakerHandle rm)

virtual ReferenceTarget *	get_delegate ()=0

IOResult	Save (ISave *isave) override

IOResult	Load (ILoad *iLoad)

void	post_load (ILoad *iLoad, int which)

void	dump_local_vars_and_externals (int indentLevel)

Public Member Functions inherited from Value
virtual ScripterExport BOOL	is_kind_of (ValueMetaClass *c)

virtual ScripterExport ValueMetaClass *	local_base_class ()

virtual Value *	eval ()

virtual Value *	eval_no_wrapper ()

virtual ScripterExport Value *	apply (Value *arglist, int count, CallContext cc=nullptr)

virtual ScripterExport Value *	apply_no_alloc_frame (Value *arglist, int count, CallContext cc=nullptr)

virtual void	export_to_scripter ()

virtual Value *	map (node_map &m)

virtual Value *	map_path (PathName *path, node_map &m)

virtual Value *	find_first (BOOL(test_fn)(INode node, int level, const void arg), const void test_arg)

virtual Value *	get_path (PathName *path)

virtual ScripterExport void	sprin1 (CharStream *stream)

virtual ScripterExport void	sprint (CharStream *stream)

virtual void	prin1 ()

virtual void	print ()

virtual Class_ID	get_max_class_id ()

virtual Value *	delete_vf (Value **arglist, int arg_count)

virtual Value *	clearSelection_vf (Value **arglist, int arg_count)

virtual float	to_float ()

virtual double	to_double ()

virtual const MCHAR *	to_string ()

virtual MSTR	to_mstr ()

virtual MSTR	to_filename ()

virtual int	to_int ()

virtual INT64	to_int64 ()

virtual INT_PTR	to_intptr ()

virtual BOOL	to_bool ()

virtual BitArray &	to_bitarray ()

virtual Point4	to_point4 ()

virtual Point3	to_point3 ()

virtual Point2	to_point2 ()

virtual AColor	to_acolor ()

virtual COLORREF	to_colorref ()

virtual INode *	to_node ()

virtual Ray	to_ray ()

virtual Interval	to_interval ()

virtual Quat	to_quat ()

virtual AngAxis	to_angaxis ()

virtual Matrix3 &	to_matrix3 ()

virtual Box3	to_box3 ()

virtual float *	to_eulerangles ()

virtual Mtl *	to_mtl ()

virtual Texmap *	to_texmap ()

virtual MtlBase *	to_mtlbase ()

virtual Modifier *	to_modifier ()

virtual TimeValue	to_timevalue ()

virtual Control *	to_controller ()

virtual Atmospheric *	to_atmospheric ()

virtual Effect *	to_effect ()

virtual IMultiPassCameraEffect *	to_mpassCamEffect ()

virtual ShadowType *	to_shadowtype ()

virtual FilterKernel *	to_filter ()

virtual INode *	to_rootnode ()

virtual ITrackViewNode *	to_trackviewnode ()

virtual NURBSIndependentPoint *	to_nurbsindependentpoint ()

virtual NURBSPoint *	to_nurbspoint ()

virtual NURBSObject *	to_nurbsobject ()

virtual NURBSControlVertex *	to_nurbscontrolvertex ()

virtual NURBSCurve *	to_nurbscurve ()

virtual NURBSCVCurve *	to_nurbscvcurve ()

virtual NURBSSurface *	to_nurbssurface ()

virtual NURBSTexturePoint *	to_nurbstexturepoint ()

virtual NURBSSet *	to_nurbsset ()

virtual ReferenceTarget *	to_reftarg ()

virtual Mesh *	to_mesh ()

virtual BezierShape *	to_beziershape ()

virtual Thunk *	to_thunk ()

virtual void	to_fpvalue (FPValue &v)

virtual Renderer *	to_renderer ()

virtual Box2 &	to_box2 ()

virtual NURBSTextureSurface *	to_nurbstexturesurface ()

virtual NURBSDisplay *	to_nurbsdisplay ()

virtual TessApprox *	to_tessapprox ()

virtual Value *	widen_to (Value arg, Value *arg_list)

virtual BOOL	comparable (Value *arg)

virtual BOOL	special_case_compare (Value *arg, bool &specialCaseCompareResult)

virtual ScripterExport Value *	deep_copy (HashTable *remapper)

virtual BOOL	is_const ()

virtual ScripterExport Value *	get_property (Value **arg_list, int count)

virtual ScripterExport Value *	set_property (Value **arg_list, int count)

ScripterExport Value *	_get_property (Value *prop)

virtual ScripterExport Value *	_set_property (Value prop, Value val)

virtual Value *	get_container_property (Value prop, Value cur_prop)

virtual Value *	set_container_property (Value prop, Value val, Value *cur_prop)

virtual BOOL	_is_collection ()

virtual BOOL	_is_charstream ()

virtual BOOL	_is_rolloutcontrol ()

virtual BOOL	_is_rolloutthunk ()

virtual BOOL	_is_function ()

virtual BOOL	_is_selection ()

virtual BOOL	_is_thunk ()

virtual BOOL	_is_indirect_thunk ()

virtual SelectionIterator *	selection_iterator ()

virtual ScripterExport IOResult	Save (ISave *isave)

virtual void	drop_MAX_refs ()

virtual BaseInterface *	GetInterface (Interface_ID id)

ScripterExport Value *	make_heap_permanent ()

ScripterExport Value *	make_heap_static ()

ScripterExport Value *	get_heap_ptr ()

ScripterExport Value *	get_stack_heap_ptr ()

ScripterExport Value *	migrate_to_heap ()

ScripterExport Value *	get_live_ptr ()

virtual BOOL	object_supports_case_sensitive_names ()

ScripterExport Value *	_get_property (Value prop, Value prop_name_as_parsed)

ScripterExport Value *	_set_property (Value prop, Value val, Value *prop_name_as_parsed)

virtual ScripterExport Value *	get_case_sensitive_property (Value *arg_list, int count, const TCHAR case_sensitive_name)

virtual ScripterExport Value *	set_case_sensitive_property (Value *arg_list, int count, const TCHAR case_sensitive_name)

ScripterExport Value *	invoke_getter_case_sensitive_property (Value target, getter_vf getter, Value arg_list, int count, const TCHAR case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)

ScripterExport Value *	invoke_setter_case_sensitive_property (Value target, setter_vf setter, Value arg_list, int count, const TCHAR case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)

Public Member Functions inherited from Collectable
ScripterExport	Collectable ()

virtual ScripterExport	~Collectable ()

ScripterExport void *	operator new (size_t sz, char flag)

ScripterExport void *	operator new (size_t sz)

ScripterExport void	operator delete (void *val)

ScripterExport void	operator delete (void *val, char flag)

virtual void	collect ()=0

virtual ScripterExport void	gc_trace ()

ScripterExport bool	derives_from_Animatable ()

virtual BOOL	derives_from_MAXWrapper ()

ScripterExport void	make_collectable ()

void	make_permanent ()

void	make_static ()

int	is_marked ()

int	is_not_marked ()

int	is_garbage ()

int	is_permanent ()

void	mark_in_use ()

void	unmark_in_use ()

int	has_heap_copy ()

int	is_in_heap ()

int	is_on_stack ()

Public Member Functions inherited from TrackViewUtility
virtual void	DeleteThis ()=0

virtual void	BeginEditParams (Interface ip, ITVUtility iu)

virtual void	EndEditParams (Interface ip, ITVUtility iu)

virtual void	TrackSelectionChanged ()

virtual void	NodeSelectionChanged ()

virtual void	KeySelectionChanged ()

virtual void	TimeSelectionChanged ()

virtual void	MajorModeChanged ()

virtual void	TrackListChanged ()

virtual int	FilterAnim (Animatable anim, Animatable client, int subNum)

virtual void	GetClassName (MSTR &s) const

virtual Class_ID	ClassID ()

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.

virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Public Member Functions inherited from ReferenceTarget
CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.

CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.

BOOL	IsRefTarget () override
	Checks if this is a ReferenceTarget.

CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference.

CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references.

CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents.

void	BeginDependencyTest ()
	Starts Dependency Test.

BOOL	EndDependencyTest ()
	Ends Dependency Test.

virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target.

virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo.

	__declspec (deprecated) virtual void RefDeleted() final

virtual void	RefDeleted (ReferenceMaker *oldOwner)
	Called after a reference to this is deleted.

	__declspec (deprecated) virtual void RefDeletedUndoRedo() final

virtual void	RefDeletedUndoRedo (RefMakerHandle oldOwner)
	Called after a reference to this is deleted because of undo or redo.

CoreExport RefResult	DeleteAllRefsToMe () override
	Deletes all references to this ReferenceTarget.

CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this.

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.

virtual CoreExport void	BaseClone (ReferenceTarget from, ReferenceTarget to, RemapDir &remap)
	This method copies base class data from an object to its clone.

CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=nullptr, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS) override
	Notify all dependent RefMakers concerned with the message.

void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline.

virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG.

virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets.

CoreExport	ReferenceTarget ()
	Constructor.

virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents.

CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents.

Public Member Functions inherited from ReferenceMaker
void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.

CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.

CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers.

CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker.

CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item.

CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference.

virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered.

CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker.

virtual CoreExport IOResult	Save (ISave *isave)
	Called for saving data.

virtual CoreExport IOResult	Save (ISave *isave, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.

virtual CoreExport IOResult	Load (ILoad *iload)
	Called for loading data.

virtual CoreExport IOResult	Load (ILoad *iload, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.

virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references.

virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy.

CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags) override
	Enumerate auxiliary files (e.g. bitmaps)

virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration.

virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save.

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.

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.

CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget.

BOOL	IsRefMaker () override
	Tells whether it is a ReferenceMaker.

virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not.

virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save.

CoreExport	ReferenceMaker ()
	Constructor.

CoreExport void	DeleteMe ()
	Deletes an instance of this class.

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

virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present

virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim.

virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers.

virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim.

virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers.

virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete.

virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker.

virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used.

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.

CoreExport	Animatable ()
	Constructor.

MSTR	ClassName (bool localized=true) const
	Returns the name of the plugin class.

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.

CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property.

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.

CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable.

CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable.

CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable.

	__declspec (deprecated) virtual MSTR SubAnimName(int i) MAX_SEALED

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.

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.

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.

virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed.

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	PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, 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 ()

virtual int	GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	This method is called to calculate the largest and smallest values of the anim.

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

virtual CoreExport void	MouseCycleCompleted (TimeValue t)

virtual CoreExport void	MouseCycleStarted (TimeValue t)

CoreExport bool	SvSaveData (ISave *isave, USHORT id)

CoreExport bool	SvLoadData (ILoad *iLoad)

CoreExport DWORD	SvGetRefIndex ()

CoreExport void	SvSetRefIndex (DWORD i)

CoreExport bool	SvDeleteRefIndex ()

virtual CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager gom, Animatable owner, int id, DWORD flags)

CoreExport SvGraphNodeReference	SvStdTraverseAnimGraph (IGraphObjectManager gom, Animatable owner, int id, DWORD flags)

virtual CoreExport bool	SvCanInitiateLink (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvCanConcludeLink (IGraphObjectManager gom, IGraphNode gNode, IGraphNode *gNodeChild)

virtual CoreExport MSTR	SvGetName (IGraphObjectManager gom, IGraphNode gNode, bool isBeingEdited)

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

virtual CoreExport bool	SvIsSelected (IGraphObjectManager gom, IGraphNode gNode)
	Returns true if the object is selected in its schematic view.

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 bool	SvLinkChild (IGraphObjectManager gom, IGraphNode gNodeThis, IGraphNode *gNodeChild)

virtual CoreExport bool	SvHandleDoubleClick (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvCanSelect (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvEditProperties (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"...

virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method...

virtual CoreExport bool	SvDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship.

virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view...

CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class.

CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container.

CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container.

void	SetAFlag (DWORD mask)

void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags.

bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags.

void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags.

void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags.

bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags.

CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit.

CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit.

CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit.

Static Public Member Functions
static TrackViewUtility *	create (MSPluginClass *pc, BOOL loading)

Static Public Member Functions inherited from Collectable
static ScripterExport void	for_all_values (void(map_fn)(Value val), ValueMapper mapper=nullptr, ValueMetaClass c=nullptr)

static void	mark ()

static void	sweep ()

static void	setup (size_t)

static ScripterExport void	gc ()

static void	coalesce_free_list ()

static void	close_down ()

static void	drop_maxwrapper_refs ()

static ScripterExport void	push_alloc_stack_frame ()

static ScripterExport void	pop_alloc_stack_frame ()

static ScripterExport ULONGLONG	get_num_values_created ()

static ScripterExport bool	validate_value_linkages ()

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator.

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Static Public Member Functions inherited from Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted.

static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object.

static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle.

static CoreExport AnimHandle	GetNextHandle ()
	Get the unique handle for the next Animatable object to be created.

static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables.

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.

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.

static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file.

static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.

static CoreExport void	ClearAFlagInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable flags in all Animatables.

static CoreExport void	ClearAFlagExInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable extended flags in all Animatables.

static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index.

static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index.

static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables.

Public Attributes
Interface *	ip

ITVUtility *	iu

Public Attributes inherited from MSPlugin
MSPluginClass *	pc

Value **	locals

short	flags

int	version

ReferenceTarget *	ref

Tab< IParamBlock2 * >	pblocks

ILoad *	iload

Public Attributes inherited from Value
ValueMetaClass *	tag

Public Attributes inherited from Collectable
Collectable *	next

Collectable *	prev

byte	flags

byte	flags2

short	flags3

Protected Member Functions
void	SetReference (int i, RefTargetHandle rtarg) override
	Stores a ReferenceTarget as its 'i-th' reference`.

Protected Member Functions inherited from ReferenceTarget
CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep) override
	Method to perform an enumeration on a ReferenceTarget.

virtual CoreExport	~ReferenceTarget ()=0
	Destructor.

Protected Member Functions inherited from ReferenceMaker
virtual CoreExport	~ReferenceMaker ()=0
	Destructor.

void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target.

void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target.

int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target.

CoreExport RefResult	StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
	Validates a given reference link between this reference maker and its reference target.

Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor.

Protected Member Functions inherited from Noncopyable
	Noncopyable ()

	~Noncopyable ()

Additional Inherited Members
Static Public Attributes inherited from Collectable
static CRITICAL_SECTION	heap_update

static Collectable *	collectable_list

static Collectable *	permanent_list

static free_mem *	free_list [GC_NUM_SUBLISTS]

static size_t	heap_allocated

static size_t	heap_size

static ScripterExport collectable_state	state

static ScripterExport bool	fullCollectNextHoldFlush

static bool	gc_light

static bool	in_gc

static HANDLE	hGCCompletedEvent

Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0

Protected Attributes inherited from Animatable
DWORD	aflag

AnimPropertyList	aprops

Static Protected Attributes inherited from Value
static ScripterExport Value *	keyarg_marker_value

Constructor & Destructor Documentation

◆ MSPluginTrackViewUtility() [1/2]

MSPluginTrackViewUtility ( )

inline

3135{ }

◆ MSPluginTrackViewUtility() [2/2]

MSPluginTrackViewUtility	(	MSPluginClass *	pc,
		BOOL	loading
	)

◆ ~MSPluginTrackViewUtility()

~MSPluginTrackViewUtility ( )

inline

3137{ DeleteAllRefsFromMe(); }

ReferenceMaker::DeleteAllRefsFromMe

CoreExport RefResult DeleteAllRefsFromMe()

Deletes all references from this ReferenceMaker.

Member Function Documentation

◆ BeginEditParams()

void BeginEditParams	(	Interface *	ip,
		ITVUtility *	iu
	)

overridevirtual

Remarks: This method is called to begin editing of the Track View utility plug-in's parameters.

Parameters:: Interface *ip

An interface for calling functions provided by 3ds Max.

ITVUtility *iu

An interface for allowing track view utilities to access the Track View they are launched from.

Default Implementation:: {}

Reimplemented from TrackViewUtility.

◆ EndEditParams()

void EndEditParams	(	Interface *	ip,
		ITVUtility *	iu
	)

overridevirtual

Remarks: This method is called when the user has closed the Track View utility or Track View itself.

Parameters:: Interface *ip

An interface for calling functions provided by 3ds Max.

ITVUtility *iu

An interface for allowing track view utilities to access the Track View they are launched from.

Default Implementation:: {}

Reimplemented from TrackViewUtility.

◆ TrackSelectionChanged()

void TrackSelectionChanged ( )

overridevirtual

Remarks: This method is called when the selection of tracks has changed.

Default Implementation:: {}

Reimplemented from TrackViewUtility.

◆ NodeSelectionChanged()

void NodeSelectionChanged ( )

overridevirtual

Remarks: This method is called when the selection of nodes has changed.

Default Implementation:: {}

Reimplemented from TrackViewUtility.

◆ KeySelectionChanged()

void KeySelectionChanged ( )

overridevirtual

Remarks: This method is called when the selection of keys has changed.

Default Implementation:: {}

Reimplemented from TrackViewUtility.

◆ TimeSelectionChanged()

void TimeSelectionChanged ( )

overridevirtual

Remarks: This method is called when the amount of time selected changes in Edit Time mode. See ITVUtility::GetTimeSelection().

Default Implementation:: {}

Reimplemented from TrackViewUtility.

◆ MajorModeChanged()

void MajorModeChanged ( )

overridevirtual

Remarks: This method is called if the current mode of Track View changes. These are the modes such as Edit Keys, Edit Time, Edit Ranges, Position Ranges, and Edit Function Curves. See ITVUtility::GetMajorMode().

Default Implementation:: {}

Reimplemented from TrackViewUtility.

◆ TrackListChanged()

void TrackListChanged ( )

overridevirtual

Remarks: This method is called when the Track View list is rebuild. This is the list of items that are visible (currently open).

Default Implementation:: {}

Reimplemented from TrackViewUtility.

◆ FilterAnim()

int FilterAnim	(	Animatable *	anim,
		Animatable *	client,
		int	subNum
	)

overridevirtual

Reimplemented from TrackViewUtility.

◆ create()

static TrackViewUtility * create	(	MSPluginClass *	pc,
		BOOL	loading
	)

static

◆ AddRollupPage()

HWND AddRollupPage	(	HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		DLGPROC	dlgProc,
		const MCHAR *	title,
		LPARAM	param = `0`,
		DWORD	vflags = `0`,
		int	category = `ROLLUP_CAT_STANDARD`
	)

overridevirtual

Implements MSPlugin.

◆ DeleteRollupPage()

void DeleteRollupPage ( HWND hRollup )

overridevirtual

Implements MSPlugin.

◆ GetRollupWindow()

IRollupWindow * GetRollupWindow ( )

overridevirtual

Implements MSPlugin.

◆ RollupMouseMessage()

void RollupMouseMessage	(	HWND	hDlg,
		UINT	message,
		WPARAM	wParam,
		LPARAM	lParam
	)

overridevirtual

Implements MSPlugin.

◆ get_delegate()

ReferenceTarget * get_delegate ( )

inlineoverridevirtual

Implements MSPlugin.

3164{ return nullptr; } // no delegate

◆ DeleteThis()

void DeleteThis ( )

inlineoverridevirtual

Remarks: This method is called to delete this instance of the plug-in class. This method should free the memory allocated in ClassDesc::Create(). See the Advanced Topics section on Memory Management for more details.

Implements TrackViewUtility.

3169{ MSPlugin::DeleteThis(); }

MSPlugin::DeleteThis

void DeleteThis()

◆ GetClassName()

void GetClassName	(	MSTR &	s,
		bool	localized
	)		const

inlineoverridevirtual

Retrieves the name of the plugin class.

This name is used in 3ds Max's UI and in MAXScript. For Material plug-ins this method is used to put up the material "type" name in the Material Editor.

Parameters

s	Reference to a string filled in with the name of the plugin class.
localized	If true, then the class name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the class name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the class name in English.

Reimplemented from Animatable.

3170{ s = (localized) ? pc->ClassName() : pc->NonLocalizedClassName(); }

MSPluginClass::NonLocalizedClassName

const MCHAR * NonLocalizedClassName()

Definition: mxsPlugin.h:218

MSPluginClass::ClassName

const MCHAR * ClassName()

Definition: mxsPlugin.h:217

MSPlugin::pc

MSPluginClass * pc

Definition: mxsPlugin.h:352

◆ ClassID()

Class_ID ClassID ( )

inlineoverridevirtual

Reimplemented from TrackViewUtility.

3171{ return pc->class_id; }

MAXClass::class_id

Class_ID class_id

Definition: mxsobjects.h:541

◆ FreeCaches()

void FreeCaches ( )

inlineoverridevirtual

Remarks: This is called to delete any item that can be rebuilt. For example, the procedural sphere object has a mesh that it caches. It could call Mesh::FreeAll() on the mesh from this method. This will free the vertex/face/uv arrays. If the sphere is ever evaluated again it can just rebuild the mesh. If an object (like a sphere) has modifiers applied to it, and those modifiers are not animated, then the result of the pipeline is cached in the node. So there is no reason for the sphere to also have a cache of its representation. Therefore when this method is called, the sphere can free the data of the mesh.

Default Implementation:: {}

Reimplemented from Animatable.

3172{ }

◆ NumSubs()

int NumSubs ( )

inlineoverridevirtual

Remarks: The system uses a virtual array mechanism to access the sub-anims of a plug-in. This method returns the total number of sub-anims maintained by the plug-in. If a plug-in is using a parameter block to manage its parameters it should just return 1 for all the parameters directed by the parameter block.

Returns: The number of sub-anims used by the plug-in.

Default Implementation:: { return 0; }

Reimplemented from Animatable.

3173{ return pblocks.Count(); }

MSPlugin::pblocks

Tab< IParamBlock2 * > pblocks

Definition: mxsPlugin.h:357

Tab::Count

int Count() const

Retrieves the number of items in the Tab.

Definition: tab.h:219

◆ SubAnim()

Animatable * SubAnim ( int i )

inlineoverridevirtual

Remarks: This method returns a pointer to the 'i-th' sub-anim. If a plug-in is using a parameter block to manage all its parameters it should just return a pointer to the parameter block itself from this method. This method may return NULL so developers need to check the return value before calling other sub anim methods (such as SubAnimName()).

Parameters

i	This is the index of the sub-anim to return.

Default Implementation:: { return NULL };

Reimplemented from Animatable.

3174{ return pblocks[i]; }

◆ SubAnimName()

MSTR SubAnimName	(	int	i,
		bool	localized = `true`
	)

inlineoverridevirtual

Remarks: This method returns the name of the 'i-th' sub-anim to appear in track view. The system has no idea what name to assign to the sub-anim (it only knows it by the virtual array index), so this method is called to retrieve the name to display. Developer need to make sure the 'i-th' SubAnim() is non-NULL or this method will fail.

Parameters

i	The index of the parameter name to return
localized	If true, then the sub-anim name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the sub-anim name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the sub-anim name in English.

Returns: The name of the 'i-th' parameter.

Reimplemented from Animatable.

    {
        if (pblocks[i]->GetDesc()->local_name != 0)
        {
            return localized ? pblocks[i]->GetLocalName() : pblocks[i]->GetDesc()->int_name.data();
        }
        
        return _T("");
    }

◆ NumParamBlocks()

int NumParamBlocks ( )

inlineoverridevirtual

Remarks: This method is available in release 3.0 and later only.

This method returns the number of ParamBlock2s in this instance.

Default Implementation:: { return 0; }

Reimplemented from Animatable.

3184{ return pblocks.Count(); }

◆ GetParamBlock()

IParamBlock2 * GetParamBlock ( int i )

inlineoverridevirtual

Remarks: This method return 'i-th' ParamBlock2 in this instance (or NULL if not available).

Parameters

i	The zero based index of the ParamBlock2 to return.

Default Implementation:: { return NULL; }

Reimplemented from Animatable.

3185{ return pblocks[i]; }

◆ GetParamBlockByID()

IParamBlock2 * GetParamBlockByID ( BlockID id )

inlineoverridevirtual

Remarks: This method returns a pointer to the ParamBlock2 as specified by the ID passed (or NULL if not available).

Parameters

id	The BlockID of the ParamBlock2 instance.

Default Implementation:: { return NULL; }

Reimplemented from Animatable.

3186{ return MSPlugin::GetParamBlockByID(id); }

MSPlugin::GetParamBlockByID

ScripterExport IParamBlock2 * GetParamBlockByID(BlockID id)

◆ GetInterface() [1/3]

void * GetInterface ( ULONG id )

inlineoverridevirtual

Remarks: This method provides a mechanism for extending the class in the future. In 3ds Max 4.0 there are new interfaces that are accessed by passing an id to this method and it will respond by returning the corresponding interface pointer.

This method has been used however for a different purpose. It currently is used to determine if an object is of a particular class. With controllers for example, there is one base class Control, however there are many super classes (CTRL_FLOAT_CLASS_ID, CTRL_SCALE_CLASS_ID, etc.). If you wanted to find out if a given Animatable was a controller you would need to compare its SuperClassID to all the known types and only if it wasn't one of the known types could you be sure it wasn't a controller. Having to do this is inconvenient for a developer.

Instead the Control class implements this method. It looks at the id, and if it matches a predefined constant I_CONTROL, it returns its this pointer. In this way, given any Animatable, it is easy to find out if it is a controller by simply asking for the control interface. There is a macro that does this:

#define GetControlInterface(anim)

((Control*)anim-\>GetInterface(I_CONTROL))

Control
Definition: control.h:1055

MSPluginTrackViewUtility::GetInterface
void * GetInterface(ULONG id) override
Definition: mxsPlugin.h:3187

I_CONTROL
#define I_CONTROL
An Animatable supporting this interface is a Control.
Definition: AnimatableInterfaceIDs.h:33

A plug-in developer may use this macro as follows:

Control *c = GetControlInterface(anim);

This will either be NULL or a pointer to a valid controller.

Note: Plug-in defined interfaces should be greater than the following value:

#define I_USERINTERFACE 0x0000ffff

If a plug-in implements this method for its own purposes, it would, in general, switch on the id and if it is not aware of the id it would call this method on the base class. Otherwise it could respond to the id as it needed. See the sample code below for the how the Control class implements this method.

Parameters

id	The id of the interface.

Default Implementation:: { return NULL; }

Sample Code:: The following is the Control class implementation of this method. It looks at the id passed, and if it matches I_CONTROL it returns its this pointer. Otherwise it calls the base class method.

void* Control::GetInterface(ULONG id)

{

if (id==I_CONTROL) {

return this;

}

else {

return Animatable::GetInterface(id);

}

}

Animatable::GetInterface
virtual CoreExport void * GetInterface(ULONG id)

Control::GetInterface
CoreExport void * GetInterface(ULONG id)

Reimplemented from Animatable.

3187{ if (id == I_MAXSCRIPTPLUGIN) return (MSPlugin*)this; return ReferenceTarget::GetInterface(id); }

MSPlugin

Definition: mxsPlugin.h:350

ReferenceTarget::GetInterface

CoreExport void * GetInterface(ULONG id) override

Inherited from Animatable.

I_MAXSCRIPTPLUGIN

#define I_MAXSCRIPTPLUGIN

An Animatable supporting this interface is a MSPlugin.

Definition: AnimatableInterfaceIDs.h:64

◆ NotifyRefChanged()

RefResult NotifyRefChanged	(	const Interval &	changeInt,
		RefTargetHandle	hTarget,
		PartID &	partID,
		RefMessage	message,
		BOOL	propagate
	)

inlineoverridevirtual

Receives and responds to messages.

A plugin which makes references must implement a method to receive and respond to messages broadcast by its dependents. This is done by implementing NotifyRefChanged(). The plugin developer usually implements this method as a switch statement where each case is one of the messages the plugin needs to respond to. The Method StdNotifyRefChanged calls this, which can change the partID to new value. If it doesn't depend on the particular message& partID, it should return REF_DONTCARE.

For developer that need to update a dialog box with data about an object you reference note the following related to this method: This method may be called many times. For instance, say you have a dialog box that displays data about an object you reference. This method will get called many time during the drag operations on that object. If you updated the display every time you'd wind up with a lot of 'flicker' in the dialog box. Rather than updating the dialog box each time, you should just invalidate the window in response to the NotifyRefChanged() call. Then, as the user drags the mouse your window will still receive paint messages. If the scene is complex the user may have to pause (but not let up on the mouse) to allow the paint message to go through since they have a low priority. This is the way many windows in 3ds Max work.

Parameters

changeInt	- This is the interval of time over which the message is active. Currently, all plug-ins will receive FOREVER for this interval, with the exception of REFMSG_FLAGDEPENDENTS notifications. In that case, changeInt.Start() is the timepoint to perform the dependency test.
hTarget	- This is the handle of the reference target the message was sent by. The reference maker uses this handle to know specifically which reference target sent the message.
partID	- This contains information specific to the message passed in. Some messages don't use the partID at all. See the section List of Reference Messages for more information about the meaning of the partID for some common messages.
message	- The message parameters passed into this method is the specific message which needs to be handled.
propagate	- If called through ReferenceMaker::NotifyDependents(), the value of 'propagate' passed to it. Used if calling NotifyDependents() from within NotifyRefChanged().

Returns: The return value from this method is of type RefResult. This is usually REF_SUCCEED indicating the message was processed. Sometimes, the return value may be REF_STOP. This return value is used to stop the message from being propagated to the dependents of the item.

Implements ReferenceMaker.

                    { 
                        return ((MSPlugin*)this)->NotifyRefChanged(changeInt, hTarget, partID, message, propagate); 
                    }

◆ NumRefs()

int NumRefs ( )

overridevirtual

Returns the total number of references this ReferenceMaker can hold.

The plugin implements this method to indicate the total number of of references it can make. This includes all references whether they are NULL (inactive) or non-NULL (active) at the time when this method is called. A plugin can hold a variable number of references, thus the return value of this method is not to be cached and reused by client code.

Returns: The total number of references this plugin can hold. The default implementation is return 0.

Reimplemented from ReferenceMaker.

◆ GetReference()

RefTargetHandle GetReference ( int i )

overridevirtual

Returns the 'i-th' reference.

The plugin implements this method to return its 'i-th' reference. The plug-in simply keeps track of its references using an integer index for each one. This method is normally called by the system.

Parameters

i	- The index of the reference to retrieve. Valid values are from 0 to NumRefs()-1.

Returns: The reference handle of the 'i-th' reference. Note that different calls to this method with the same 'i' value can result in different reference handles being retrieved, as the plugin changes the scene objects it references as its 'i-th' reference.

Reimplemented from ReferenceMaker.

◆ SetReference()

void SetReference	(	int	i,
		RefTargetHandle	rtarg
	)

overrideprotectedvirtual

Stores a ReferenceTarget as its 'i-th' reference`.

The plugin implements this method to store the reference handle passed to it as its 'i-th' reference. In its implementation of this method, the plugin should simply assign the reference handle passed in as a parameter to the member variable that holds the 'i-th' reference. Other reference handling methods such as ReferenceMaker::DeleteReference(), or ReferenceMaker::ReplaceReference() should not be called from within this method. The plugin itself or other plugins should not call this method directly. The system will call this method when a new reference is created or an existing one is replaced by calling ReferenceMaker::ReplaceReference().

Parameters

i	- The index of the reference to store. Valid values are from 0 to NumRefs()-1.
rtarg	- The reference handle to store.

Reimplemented from ReferenceMaker.

◆ Clone()

RefTargetHandle Clone ( RemapDir & remap )

overridevirtual

This method is used by 3ds Max to clone an object.

See also: CloneRefHierarchy(), class RemapDir This method is called by 3ds Max to have the plugin clone itself. The plug-in's implementation of this method should copy both the data structure and all the data residing in the data structure of this reference target. The plugin should clone all its references as well. Also, the plug-in's implementation of this method must call BaseClone(). In order for classes derived from this class to clone cleanly, the Clone method should just create the new instance, and then call an implementation of BaseClone that clones the references and copies any other necessary data. For example:
class MyDerivedPlugin

: public MyBasePlugin

{

const int MY_REFERENCE = 1;

ReferenceTarget* Clone(RemapDir& remap)

{

ReferenceTarget* result = new MyDerivedPlugin();

BaseClone(this, result, remap);

return result;

}

void BaseClone(ReferenceTarget* from, ReferenceTarget* to, RemapDir& remap)

{

if (!to || !from || from == to)

return;

MyBasePlugin::BaseClone(from, to, remap);

to->ReplaceReference(MY_REFERENCE, remap->CloneRef(from->GetReference(MY_REFERENCE)));

}

};

ReferenceMaker::GetReference
virtual CoreExport RefTargetHandle GetReference(int i)
Returns the 'i-th' reference.

ReferenceMaker::ReplaceReference
CoreExport RefResult ReplaceReference(int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
Used when cloning reference makers.

ReferenceTarget
A scene entity that is being owned and listened to by other scene entities.
Definition: ref.h:1849

RemapDir
For remapping references during a Clone.
Definition: ref.h:830

RemapDir::CloneRef
virtual RefTargetHandle CloneRef(RefTargetHandle oldTarg)
Creates a clone of a reference target only if it hasn't been cloned already.

This method should not be directly called by plug-ins. Instead, either RemapDir::CloneRef() or CloneRefHierachy() should be used to perform cloning. These methods ensure that the mapping from the original object to the clone is added to the RemapDir used for cloning, which may be used during backpatch operations

Note: See the remarks in method BaseClone() below.

Parameters

remap - A RemapDir instance used for remapping references during a Clone.

Returns: A pointer to the cloned item.

Reimplemented from ReferenceTarget.

◆ GetInterface() [2/3]

CoreExport void * GetInterface ( ULONG id )

overridevirtual

Inherited from Animatable.

Returns a pointer to the interface.

Parameters

id	- The id of the interface.

Returns: A Pointer to the Interface

Reimplemented from ReferenceTarget.

◆ GetInterface() [3/3]

CoreExport BaseInterface * GetInterface ( Interface_ID id )

overridevirtual

Inherited from Animatable.

Returns a pointer to the Base Interface for the interface ID passed.

Parameters

id	- The unique ID of the interface to get

Returns: A Pointer to the Interface

Reimplemented from ReferenceTarget.

Member Data Documentation

◆ ip

Interface* ip

◆ iu

ITVUtility* iu

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ MSPluginTrackViewUtility() [1/2]

◆ MSPluginTrackViewUtility() [2/2]

◆ ~MSPluginTrackViewUtility()

Member Function Documentation

◆ BeginEditParams()

◆ EndEditParams()

◆ TrackSelectionChanged()

◆ NodeSelectionChanged()

◆ KeySelectionChanged()

◆ TimeSelectionChanged()

◆ MajorModeChanged()

◆ TrackListChanged()

◆ FilterAnim()

◆ create()

◆ AddRollupPage()

◆ DeleteRollupPage()

◆ GetRollupWindow()

◆ RollupMouseMessage()

◆ get_delegate()

◆ DeleteThis()

◆ GetClassName()

◆ ClassID()

◆ FreeCaches()

◆ NumSubs()

◆ SubAnim()

◆ SubAnimName()

◆ NumParamBlocks()

◆ GetParamBlock()

◆ GetParamBlockByID()

◆ GetInterface() [1/3]

◆ NotifyRefChanged()

◆ NumRefs()

◆ GetReference()

◆ SetReference()

◆ Clone()

◆ GetInterface() [2/3]

◆ GetInterface() [3/3]

Member Data Documentation

◆ ip

◆ iu