ITreeViewOps Class Reference

#include <itreevw.h>

Class Description

See also

Class FPMixinInterface, Class Animatable, Class ReferenceTarget

Description:

This class contains the operations you can do on any open trackview.

Inheritance diagram for ITreeViewOps:

Public Types
enum	{   tv_getName, tv_setName, tv_close, tv_numSelTracks,   tv_getNumTracks, tv_getSelTrack, tv_canAssignController, tv_doAssignController,   tv_assignController, tv_showControllerTypes, tv_expandTracks, tv_zoomSelected,   tv_zoomOnTrack, tv_getAnim, tv_getClient, tv_getSelAnim,   tv_getSelClient, tv_getSelAnimSubNum, tv_getIndex, tv_selectTrackByIndex,   tv_selectTrack, tv_setFilter, tv_clearFilter, tv_setEditMode,   tv_getEditMode, tv_setEditModeProp, tv_getEditModeProp, tv_setCurrent,   tv_getCurrent, tv_getUIInterface, tv_getModifySubTree, tv_setModifySubTree,   tv_getModifyChildren, tv_setModifyChildren, tv_launchUtilityDialog, tv_launchUtility,   tv_getUtilityCount, tv_getUtilityName, tv_closeUtility, tv_getInteractiveUpdate,   tv_setInteractiveUpdate, tv_getSyncTime, tv_setSyncTime, tv_setTangentType,   tv_setInTangentType, tv_setOutTangentType, tv_getFreezeSelKeys, tv_setFreezeSelKeys,   tv_getFreezeNonSelCurves, tv_setFreezeNonSelCurves, tv_getShowNonSelCurves, tv_setShowNonSelCurves,   tv_getShowTangents, tv_setShowTangents, tv_getShowFrozenKeys, tv_setShowFrozenKeys,   tv_getEffectSelectedObjectsOnly, tv_setEffectSelectedObjectsOnly, tv_getAutoExpandChildren, tv_setAutoExpandChildren,   tv_getAutoExpandTransforms, tv_setAutoExpandTransforms, tv_getAutoExpandObjects, tv_setAutoExpandObjects,   tv_getAutoExpandModifiers, tv_setAutoExpandModifiers, tv_getAutoExpandMaterials, tv_setAutoExpandMaterials,   tv_getAutoExpandXYZ, tv_setAutoExpandXYZ, tv_getAutoSelectAnimated, tv_setAutoSelectAnimated,   tv_getAutoSelectPosition, tv_setAutoSelectPosition, tv_getAutoSelectRotation, tv_setAutoSelectRotation,   tv_getAutoSelectScale, tv_setAutoSelectScale, tv_getAutoSelectXYZ, tv_setAutoSelectXYZ,   tv_getManualNavigation, tv_setManualNavigation, tv_getAutoZoomToRoot, tv_setAutoZoomToRoot,   tv_getAutoZoomToSelected, tv_setAutoZoomToSelected, tv_getAutoZoomToEdited, tv_setAutoZoomToEdited,   tv_getUseSoftSelect, tv_setUseSoftSelect, tv_getSoftSelectRange, tv_setSoftSelectRange,   tv_getSoftSelectFalloff, tv_setSoftSelectFalloff, tv_getRootTrack, tv_setRootTrack,   tv_restoreRootTrack, tv_getScaleValuesOrigin, tv_setScaleValuesOrigin, tv_getIsolateCurve,   tv_setIsolateCurve, tv_updateList, tv_enumEffectTracks, tv_enumKeyTangentType,   tv_editModeTypes, tv_enumTangentDisplay, tv_autoZoomOnSelChange, tv_setAutoZoomOnSelChange,   tv_reduceKeys, tv_splitKey, tv_stepPreviousKeySelection, tv_stepNextKeySelection,   tv_shrinkKeySelection, tv_growKeySelection, tv_easeToPreviousKey, tv_easeToNextKey,   tv_mirrorKeyTangents, tv_nudgeKey, tv_scaleTangentsDown, tv_scaleTangentsUp,   tv_loopKey, tv_snapScaleOriginsToFirstSelectedKey, tv_spaceKeyEvenly, tv_relaxKeys,   tv_flattenKeys, tv_averageKeys }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
virtual	~ITreeViewOps ()
virtual int	GetNumTracks ()=0
virtual int	NumSelTracks ()=0
virtual void	GetSelTrack (int i, AnimatablePtr &anim, AnimatablePtr &client, int &subNum)=0
virtual ReferenceTarget *	GetAnim (int index)=0
virtual ReferenceTarget *	GetClient (int index)=0
virtual BOOL	CanAssignController ()=0
virtual void	DoAssignController (BOOL clearMot=TRUE)=0
virtual void	ShowControllerType (BOOL show)=0
virtual const MCHAR *	GetTVName ()=0
virtual void	SetTVName (const MCHAR *)=0
virtual void	CloseTreeView ()=0
virtual void	SetFilter (DWORD mask, int which, BOOL redraw=TRUE)=0
virtual void	ClearFilter (DWORD mask, int which, BOOL redraw=TRUE)=0
virtual DWORD	TestFilter (DWORD mask, int which)=0
virtual void	ZoomOn (Animatable *owner, int subnum)=0
virtual void	ZoomSelected ()=0
virtual void	ExpandTracks ()=0
virtual int	GetIndex (Animatable *anim)=0
virtual void	SelectTrackByIndex (int index, BOOL clearSelection=TRUE)=0
virtual void	SelectTrack (Animatable *anim, BOOL clearSelection=TRUE)=0
virtual BOOL	AssignControllerToSelected (Animatable *ctrl)=0
virtual void	SetEditMode (int mode)=0
virtual int	GetEditMode ()=0
virtual BOOL	IsCurrent ()=0
virtual void	SetCurrent ()=0
virtual void	SetAutoZoomOnSelChange (BOOL autoZoom)=0
virtual BOOL	AutoZoomOnSelChange () const =0
	FN_0 (tv_getName, TYPE_STRING, GetTVName)
	VFN_1 (tv_setName, SetTVName, TYPE_STRING)
	VFN_0 (tv_close, CloseTreeView)
	FN_0 (tv_getNumTracks, TYPE_INT, GetNumTracks)
	FN_0 (tv_numSelTracks, TYPE_INT, NumSelTracks)
	FN_0 (tv_canAssignController, TYPE_BOOL, CanAssignController)
	VFN_0 (tv_doAssignController, DoAssignController)
	FN_1 (tv_assignController, TYPE_BOOL, fpAssignControllerToSelected, TYPE_REFTARG)
	VFN_1 (tv_showControllerTypes, ShowControllerType, TYPE_BOOL)
	VFN_0 (tv_expandTracks, ExpandTracks)
	VFN_0 (tv_zoomSelected, ZoomSelected)
	VFN_2 (tv_zoomOnTrack, fpZoomOn, TYPE_REFTARG, TYPE_INT)
	FN_1 (tv_getAnim, TYPE_REFTARG, GetAnim, TYPE_INDEX)
	FN_1 (tv_getClient, TYPE_REFTARG, GetClient, TYPE_INDEX)
	FN_1 (tv_getSelAnim, TYPE_REFTARG, fpGetSelectedAnimatable, TYPE_INDEX)
	FN_1 (tv_getSelClient, TYPE_REFTARG, fpGetSelectedClient, TYPE_INDEX)
	FN_1 (tv_getSelAnimSubNum, TYPE_INDEX, fpGetSelectedAnimSubNum, TYPE_INDEX)
	FN_1 (tv_getIndex, TYPE_INDEX, fpGetIndex, TYPE_REFTARG)
	VFN_2 (tv_selectTrackByIndex, SelectTrackByIndex, TYPE_INDEX, TYPE_BOOL)
	VFN_2 (tv_selectTrack, fpSelectTrack, TYPE_REFTARG, TYPE_BOOL)
	FN_VA (tv_setFilter, TYPE_BOOL, fpSetFilter)
	FN_VA (tv_clearFilter, TYPE_BOOL, fpClearFilter)
	VFN_1 (tv_setEditMode, SetEditMode, TYPE_ENUM)
	FN_0 (tv_getEditMode, TYPE_ENUM, GetEditMode)
	PROP_FNS (tv_getEditModeProp, GetEditMode, tv_setEditModeProp, SetEditMode, TYPE_ENUM)
	FN_0 (tv_getCurrent, TYPE_BOOL, IsCurrent)
	VFN_0 (tv_setCurrent, SetCurrent)
	RO_PROP_FN (tv_getUIInterface, fpGetUIInterface, TYPE_INTERFACE)
	PROP_FNS (tv_getModifySubTree, ModifySubTree, tv_setModifySubTree, ModifySubTree, TYPE_BOOL)
	PROP_FNS (tv_getModifyChildren, ModifyChildren, tv_setModifyChildren, ModifyChildren, TYPE_BOOL)
	VFN_0 (tv_launchUtilityDialog, LaunchUtilityDialog)
	VFN_1 (tv_launchUtility, LaunchUtility, TYPE_TSTR_BV)
	VFN_1 (tv_closeUtility, CloseUtility, TYPE_TSTR_BV)
	FN_0 (tv_getUtilityCount, TYPE_INT, GetUtilityCount)
	FN_1 (tv_getUtilityName, TYPE_TSTR_BV, GetUtilityName, TYPE_INDEX)
	VFN_2 (tv_setTangentType, SetTangentType, TYPE_ENUM, TYPE_ENUM)
	VFN_2 (tv_setInTangentType, SetInTangentType, TYPE_ENUM, TYPE_ENUM)
	VFN_2 (tv_setOutTangentType, SetOutTangentType, TYPE_ENUM, TYPE_ENUM)
	VFN_1 (tv_reduceKeys, ReduceKeys, TYPE_FLOAT)
	VFN_0 (tv_splitKey, SplitKey)
	VFN_0 (tv_stepPreviousKeySelection, StepPreviousKeySelection)
	VFN_0 (tv_stepNextKeySelection, StepNextKeySelection)
	VFN_0 (tv_shrinkKeySelection, ShrinkKeySelection)
	VFN_0 (tv_growKeySelection, GrowKeySelection)
	VFN_0 (tv_easeToPreviousKey, EaseToPreviousKey)
	VFN_0 (tv_easeToNextKey, EaseToNextKey)
	VFN_0 (tv_mirrorKeyTangents, MirrorKeyTangents)
	VFN_1 (tv_nudgeKey, NudgeKey, TYPE_BOOL)
	VFN_1 (tv_scaleTangentsDown, ScaleTangentsDown, TYPE_BOOL)
	VFN_1 (tv_scaleTangentsUp, ScaleTangentsUp, TYPE_BOOL)
	VFN_1 (tv_loopKey, LoopKey, TYPE_BOOL)
	VFN_0 (tv_snapScaleOriginsToFirstSelectedKey, SnapScaleOriginsToFirstSelectedKey)
	VFN_1 (tv_spaceKeyEvenly, SpaceKeyEvenly, TYPE_BOOL)
	PROP_FNS (tv_getInteractiveUpdate, InteractiveUpdate, tv_setInteractiveUpdate, InteractiveUpdate, TYPE_BOOL)
	PROP_FNS (tv_getSyncTime, SyncTime, tv_setSyncTime, SyncTime, TYPE_BOOL)
	PROP_FNS (tv_getFreezeSelKeys, FreezeSelKeys, tv_setFreezeSelKeys, FreezeSelKeys, TYPE_BOOL)
	PROP_FNS (tv_getFreezeNonSelCurves, FreezeNonSelCurves, tv_setFreezeNonSelCurves, FreezeNonSelCurves, TYPE_BOOL)
	PROP_FNS (tv_getShowNonSelCurves, ShowNonSelCurves, tv_setShowNonSelCurves, ShowNonSelCurves, TYPE_BOOL)
	PROP_FNS (tv_getShowTangents, ShowTangents, tv_setShowTangents, ShowTangents, TYPE_ENUM)
	PROP_FNS (tv_getShowFrozenKeys, ShowFrozenKeys, tv_setShowFrozenKeys, ShowFrozenKeys, TYPE_BOOL)
	PROP_FNS (tv_getIsolateCurve, IsolateCurve, tv_setIsolateCurve, IsolateCurve, TYPE_BOOL)
	PROP_FNS (tv_getUseSoftSelect, UseSoftSelect, tv_setUseSoftSelect, UseSoftSelect, TYPE_BOOL)
	PROP_FNS (tv_getSoftSelectRange, SoftSelectRange, tv_setSoftSelectRange, SoftSelectRange, TYPE_TIMEVALUE)
	PROP_FNS (tv_getSoftSelectFalloff, SoftSelectFalloff, tv_setSoftSelectFalloff, SoftSelectFalloff, TYPE_FLOAT)
	PROP_FNS (tv_getEffectSelectedObjectsOnly, EffectSelectedObjectsOnly, tv_setEffectSelectedObjectsOnly, EffectSelectedObjectsOnly, TYPE_BOOL)
	PROP_FNS (tv_getManualNavigation, ManualNavigation, tv_setManualNavigation, ManualNavigation, TYPE_BOOL)
	PROP_FNS (tv_getAutoExpandChildren, AutoExpandChildren, tv_setAutoExpandChildren, AutoExpandChildren, TYPE_BOOL)
	PROP_FNS (tv_getAutoExpandTransforms, AutoExpandTransforms, tv_setAutoExpandTransforms, AutoExpandTransforms, TYPE_BOOL)
	PROP_FNS (tv_getAutoExpandObjects, AutoExpandObjects, tv_setAutoExpandObjects, AutoExpandObjects, TYPE_BOOL)
	PROP_FNS (tv_getAutoExpandModifiers, AutoExpandModifiers, tv_setAutoExpandModifiers, AutoExpandModifiers, TYPE_BOOL)
	PROP_FNS (tv_getAutoExpandMaterials, AutoExpandMaterials, tv_setAutoExpandMaterials, AutoExpandMaterials, TYPE_BOOL)
	PROP_FNS (tv_getAutoExpandXYZ, AutoExpandXYZ, tv_setAutoExpandXYZ, AutoExpandXYZ, TYPE_BOOL)
	PROP_FNS (tv_getAutoSelectAnimated, AutoSelectAnimated, tv_setAutoSelectAnimated, AutoSelectAnimated, TYPE_BOOL)
	PROP_FNS (tv_getAutoSelectPosition, AutoSelectPosition, tv_setAutoSelectPosition, AutoSelectPosition, TYPE_BOOL)
	PROP_FNS (tv_getAutoSelectRotation, AutoSelectRotation, tv_setAutoSelectRotation, AutoSelectRotation, TYPE_BOOL)
	PROP_FNS (tv_getAutoSelectScale, AutoSelectScale, tv_setAutoSelectScale, AutoSelectScale, TYPE_BOOL)
	PROP_FNS (tv_getAutoSelectXYZ, AutoSelectXYZ, tv_setAutoSelectXYZ, AutoSelectXYZ, TYPE_BOOL)
	PROP_FNS (tv_getAutoZoomToRoot, AutoZoomToRoot, tv_setAutoZoomToRoot, AutoZoomToRoot, TYPE_BOOL)
	PROP_FNS (tv_getAutoZoomToSelected, AutoZoomToSelected, tv_setAutoZoomToSelected, AutoZoomToSelected, TYPE_BOOL)
	PROP_FNS (tv_getAutoZoomToEdited, AutoZoomToEdited, tv_setAutoZoomToEdited, AutoZoomToEdited, TYPE_BOOL)
	PROP_FNS (tv_getRootTrack, GetRootTrack, tv_setRootTrack, SetRootTrack, TYPE_REFTARG)
	VFN_0 (tv_restoreRootTrack, RestoreDefaultRootTrack)
	PROP_FNS (tv_getScaleValuesOrigin, ScaleValuesOrigin, tv_setScaleValuesOrigin, ScaleValuesOrigin, TYPE_FLOAT)
	VFN_0 (tv_updateList, UpdateList)
	PROP_FNS (tv_autoZoomOnSelChange, AutoZoomOnSelChange, tv_setAutoZoomOnSelChange, SetAutoZoomOnSelChange, TYPE_BOOL)
FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()
virtual Animatable *	fpGetSelectedAnimatable (int index)=0
virtual Animatable *	fpGetSelectedClient (int index)=0
virtual int	fpGetSelectedAnimSubNum (int index)=0
virtual BOOL	fpSetFilter (FPParams *val)=0
virtual BOOL	fpClearFilter (FPParams *val)=0
virtual BOOL	ModifySubTree ()=0
virtual void	ModifySubTree (BOOL onOff)=0
virtual BOOL	ModifyChildren ()=0
virtual void	ModifyChildren (BOOL onOff)=0
virtual void	LaunchUtility (MSTR name)=0
virtual void	LaunchUtilityDialog ()=0
virtual void	CloseUtility (MSTR name)=0
virtual int	GetUtilityCount ()=0
virtual MSTR	GetUtilityName (int index)=0
virtual BOOL	InteractiveUpdate ()=0
virtual void	InteractiveUpdate (BOOL update)=0
virtual BOOL	SyncTime ()=0
virtual void	SyncTime (BOOL sync)=0
virtual BOOL	FreezeSelKeys ()=0
virtual void	FreezeSelKeys (BOOL onOff)=0
virtual BOOL	FreezeNonSelCurves ()=0
virtual void	FreezeNonSelCurves (BOOL onOff)=0
virtual BOOL	ShowNonSelCurves ()=0
virtual void	ShowNonSelCurves (BOOL onOff)=0
virtual int	ShowTangents ()=0
virtual void	ShowTangents (int type)=0
virtual BOOL	ShowFrozenKeys ()=0
virtual void	ShowFrozenKeys (BOOL onOff)=0
virtual void	IsolateCurve (BOOL onOff)=0
	Turn or off the Isolate Curve state. More...
virtual BOOL	IsolateCurve ()=0
	Get whether the Isolate Curve state is active. More...
virtual void	UseSoftSelect (BOOL use)=0
virtual BOOL	UseSoftSelect ()=0
virtual void	SoftSelectRange (TimeValue range)=0
virtual TimeValue	SoftSelectRange ()=0
virtual void	SoftSelectFalloff (float falloff)=0
virtual float	SoftSelectFalloff ()=0
virtual void	SetTangentType (int type, int effect=EFFECT_ALL_SEL_KEYS)=0
virtual void	SetInTangentType (int type, int effect=EFFECT_ALL_SEL_KEYS)=0
virtual void	SetOutTangentType (int type, int effect=EFFECT_ALL_SEL_KEYS)=0
ITreeViewUI *	fpGetUIInterface ()
virtual BOOL	EffectSelectedObjectsOnly ()=0
virtual void	EffectSelectedObjectsOnly (BOOL effect)=0
virtual BOOL	ManualNavigation ()=0
virtual void	ManualNavigation (BOOL manual)=0
virtual BOOL	AutoExpandChildren ()=0
virtual void	AutoExpandChildren (BOOL expand)=0
virtual BOOL	AutoExpandTransforms ()=0
virtual void	AutoExpandTransforms (BOOL expand)=0
virtual BOOL	AutoExpandObjects ()=0
virtual void	AutoExpandObjects (BOOL expand)=0
virtual BOOL	AutoExpandModifiers ()=0
virtual void	AutoExpandModifiers (BOOL expand)=0
virtual BOOL	AutoExpandMaterials ()=0
virtual void	AutoExpandMaterials (BOOL expand)=0
virtual BOOL	AutoExpandXYZ ()=0
virtual void	AutoExpandXYZ (BOOL expand)=0
virtual BOOL	AutoSelectAnimated ()=0
virtual void	AutoSelectAnimated (BOOL select)=0
virtual BOOL	AutoSelectPosition ()=0
virtual void	AutoSelectPosition (BOOL select)=0
virtual BOOL	AutoSelectRotation ()=0
virtual void	AutoSelectRotation (BOOL select)=0
virtual BOOL	AutoSelectScale ()=0
virtual void	AutoSelectScale (BOOL select)=0
virtual BOOL	AutoSelectXYZ ()=0
virtual void	AutoSelectXYZ (BOOL select)=0
virtual BOOL	AutoZoomToRoot ()=0
virtual void	AutoZoomToRoot (BOOL zoom)=0
virtual BOOL	AutoZoomToSelected ()=0
virtual void	AutoZoomToSelected (BOOL zoom)=0
virtual BOOL	AutoZoomToEdited ()=0
virtual void	AutoZoomToEdited (BOOL zoom)=0
virtual ReferenceTarget *	GetRootTrack ()=0
virtual void	SetRootTrack (ReferenceTarget *root)=0
virtual void	RestoreDefaultRootTrack ()=0
virtual float	ScaleValuesOrigin ()=0
virtual void	ScaleValuesOrigin (float origin)=0
virtual void	UpdateList ()=0
virtual void	ReduceKeys (float in_threshold)=0
	Remove redundant keys of selected tracks (or just the selected keys if keys are selected for a track) More...
virtual void	SplitKey ()=0
	Deletes all the selected keys and creates two new keys for each deleted key, one on the previous frame, the other one on the next frame. More...
virtual void	StepPreviousKeySelection ()=0
	Moves the key selection backwards. More...
virtual void	StepNextKeySelection ()=0
	Moves the key selection forward. More...
virtual void	ShrinkKeySelection ()=0
	Shrinks key selection. More...
virtual void	GrowKeySelection ()=0
	Grows Key Selection. More...
virtual void	EaseToPreviousKey ()=0
	Eases the selected key value to the previous key. More...
virtual void	EaseToNextKey ()=0
	Eases the selected key value to the next key. More...
virtual void	MirrorKeyTangents ()=0
	Mirrors the tangents of the selected key to the adjacent ones. More...
virtual void	NudgeKey (BOOL toLeft)=0
	Nudges key selection (moves the selected keys on the next frame). More...
virtual void	ScaleTangentsDown (BOOL onlyInnerHandle)=0
	Scales tangents length and angle down. More...
virtual void	ScaleTangentsUp (BOOL onlyInnerHandle)=0
	Scales tangents length and angle up. More...
virtual void	LoopKey (BOOL toLastKey)=0
	Copies the first key value to the last frame of the current animation range. More...
virtual void	SnapScaleOriginsToFirstSelectedKey ()=0
	Works with Scales Values tool.Moves the scale origin to the first selected key. More...
virtual void	SpaceKeyEvenly (BOOL inValue)=0
	Spaces the key selection evenly in time between the first and last keys. More...
virtual void	RelaxKeys (BOOL toLin)=0
	Eases key values and tangents between the first and last keys of the selection. More...
virtual void	FlattenKeys (BOOL toLeft)=0
	Flattens the selected keys to the first selected key value. More...
virtual void	AverageKeys (BOOL weld)=0
	Flattens the selected keys to the average value of the selected keys. More...
Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()
virtual LifetimeType	LifetimeControl ()
virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport	~FPMixinInterface ()
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)
Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=NULL)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Protected Member Functions
BOOL	fpAssignControllerToSelected (ReferenceTarget *ctrl)
void	fpZoomOn (ReferenceTarget *owner, int subnum)
int	fpGetIndex (ReferenceTarget *refAnim)
void	fpSelectTrack (ReferenceTarget *anim, BOOL clearSelection=TRUE)
Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface &	operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Additional Inherited Members
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 Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Member Enumeration Documentation

anonymous enum

Enumerator
tv_getName
tv_setName
tv_close
tv_numSelTracks
tv_getNumTracks
tv_getSelTrack
tv_canAssignController
tv_doAssignController
tv_assignController
tv_showControllerTypes
tv_expandTracks
tv_zoomSelected
tv_zoomOnTrack
tv_getAnim
tv_getClient
tv_getSelAnim
tv_getSelClient
tv_getSelAnimSubNum
tv_getIndex
tv_selectTrackByIndex
tv_selectTrack
tv_setFilter
tv_clearFilter
tv_setEditMode
tv_getEditMode
tv_setEditModeProp
tv_getEditModeProp
tv_setCurrent
tv_getCurrent
tv_getUIInterface
tv_getModifySubTree
tv_setModifySubTree
tv_getModifyChildren
tv_setModifyChildren
tv_launchUtilityDialog
tv_launchUtility
tv_getUtilityCount
tv_getUtilityName
tv_closeUtility
tv_getInteractiveUpdate
tv_setInteractiveUpdate
tv_getSyncTime
tv_setSyncTime
tv_setTangentType
tv_setInTangentType
tv_setOutTangentType
tv_getFreezeSelKeys
tv_setFreezeSelKeys
tv_getFreezeNonSelCurves
tv_setFreezeNonSelCurves
tv_getShowNonSelCurves
tv_setShowNonSelCurves
tv_getShowTangents
tv_setShowTangents
tv_getShowFrozenKeys
tv_setShowFrozenKeys
tv_getEffectSelectedObjectsOnly
tv_setEffectSelectedObjectsOnly
tv_getAutoExpandChildren
tv_setAutoExpandChildren
tv_getAutoExpandTransforms
tv_setAutoExpandTransforms
tv_getAutoExpandObjects
tv_setAutoExpandObjects
tv_getAutoExpandModifiers
tv_setAutoExpandModifiers
tv_getAutoExpandMaterials
tv_setAutoExpandMaterials
tv_getAutoExpandXYZ
tv_setAutoExpandXYZ
tv_getAutoSelectAnimated
tv_setAutoSelectAnimated
tv_getAutoSelectPosition
tv_setAutoSelectPosition
tv_getAutoSelectRotation
tv_setAutoSelectRotation
tv_getAutoSelectScale
tv_setAutoSelectScale
tv_getAutoSelectXYZ
tv_setAutoSelectXYZ
tv_getManualNavigation
tv_setManualNavigation
tv_getAutoZoomToRoot
tv_setAutoZoomToRoot
tv_getAutoZoomToSelected
tv_setAutoZoomToSelected
tv_getAutoZoomToEdited
tv_setAutoZoomToEdited
tv_getUseSoftSelect
tv_setUseSoftSelect
tv_getSoftSelectRange
tv_setSoftSelectRange
tv_getSoftSelectFalloff
tv_setSoftSelectFalloff
tv_getRootTrack
tv_setRootTrack
tv_restoreRootTrack
tv_getScaleValuesOrigin
tv_setScaleValuesOrigin
tv_getIsolateCurve
tv_setIsolateCurve
tv_updateList
tv_enumEffectTracks
tv_enumKeyTangentType
tv_editModeTypes
tv_enumTangentDisplay
tv_autoZoomOnSelChange
tv_setAutoZoomOnSelChange
tv_reduceKeys
tv_splitKey
tv_stepPreviousKeySelection
tv_stepNextKeySelection
tv_shrinkKeySelection
tv_growKeySelection
tv_easeToPreviousKey
tv_easeToNextKey
tv_mirrorKeyTangents
tv_nudgeKey
tv_scaleTangentsDown
tv_scaleTangentsUp
tv_loopKey
tv_snapScaleOriginsToFirstSelectedKey
tv_spaceKeyEvenly
tv_relaxKeys
tv_flattenKeys
tv_averageKeys

             {
            tv_getName, tv_setName, tv_close, tv_numSelTracks, tv_getNumTracks, tv_getSelTrack,
            tv_canAssignController, tv_doAssignController, tv_assignController, tv_showControllerTypes,
            tv_expandTracks, tv_zoomSelected, tv_zoomOnTrack,
            tv_getAnim, tv_getClient, tv_getSelAnim, tv_getSelClient, tv_getSelAnimSubNum,
            tv_getIndex, tv_selectTrackByIndex, tv_selectTrack,
            tv_setFilter, tv_clearFilter,
            tv_setEditMode, tv_getEditMode, tv_setEditModeProp, tv_getEditModeProp,
            tv_setCurrent, tv_getCurrent, tv_getUIInterface, tv_getModifySubTree, tv_setModifySubTree,
            tv_getModifyChildren, tv_setModifyChildren,
            tv_launchUtilityDialog, tv_launchUtility, tv_getUtilityCount, tv_getUtilityName, tv_closeUtility,
            tv_getInteractiveUpdate, tv_setInteractiveUpdate, tv_getSyncTime, tv_setSyncTime,
            tv_setTangentType, tv_setInTangentType, tv_setOutTangentType,
            tv_getFreezeSelKeys, tv_setFreezeSelKeys,
            tv_getFreezeNonSelCurves, tv_setFreezeNonSelCurves, tv_getShowNonSelCurves, tv_setShowNonSelCurves,
            tv_getShowTangents, tv_setShowTangents, tv_getShowFrozenKeys, tv_setShowFrozenKeys,
            tv_getEffectSelectedObjectsOnly, tv_setEffectSelectedObjectsOnly,
            tv_getAutoExpandChildren, tv_setAutoExpandChildren, tv_getAutoExpandTransforms, tv_setAutoExpandTransforms,
            tv_getAutoExpandObjects, tv_setAutoExpandObjects, tv_getAutoExpandModifiers, tv_setAutoExpandModifiers,
            tv_getAutoExpandMaterials, tv_setAutoExpandMaterials, tv_getAutoExpandXYZ, tv_setAutoExpandXYZ,
            tv_getAutoSelectAnimated, tv_setAutoSelectAnimated, tv_getAutoSelectPosition, tv_setAutoSelectPosition,
            tv_getAutoSelectRotation, tv_setAutoSelectRotation, tv_getAutoSelectScale, tv_setAutoSelectScale,
            tv_getAutoSelectXYZ, tv_setAutoSelectXYZ, tv_getManualNavigation, tv_setManualNavigation,
            tv_getAutoZoomToRoot, tv_setAutoZoomToRoot, tv_getAutoZoomToSelected, tv_setAutoZoomToSelected,
            tv_getAutoZoomToEdited, tv_setAutoZoomToEdited, tv_getUseSoftSelect, tv_setUseSoftSelect,
            tv_getSoftSelectRange, tv_setSoftSelectRange, tv_getSoftSelectFalloff, tv_setSoftSelectFalloff,
            tv_getRootTrack, tv_setRootTrack, tv_restoreRootTrack, tv_getScaleValuesOrigin, tv_setScaleValuesOrigin,
            tv_getIsolateCurve, tv_setIsolateCurve,
            tv_updateList,
            //symbolic enums
            tv_enumEffectTracks, tv_enumKeyTangentType, tv_editModeTypes, tv_enumTangentDisplay,
            tv_autoZoomOnSelChange, tv_setAutoZoomOnSelChange,
            tv_reduceKeys,
            tv_splitKey,
            tv_stepPreviousKeySelection, tv_stepNextKeySelection,
            tv_shrinkKeySelection, tv_growKeySelection,
            tv_easeToPreviousKey, tv_easeToNextKey,
            tv_mirrorKeyTangents,
            tv_nudgeKey,
            tv_scaleTangentsDown, tv_scaleTangentsUp,
            tv_loopKey,
            tv_snapScaleOriginsToFirstSelectedKey,
            tv_spaceKeyEvenly,
            tv_relaxKeys,
            tv_flattenKeys, tv_averageKeys,

            };

Constructor & Destructor Documentation

virtual ~ITreeViewOps ( )

inlinevirtual

Remarks

Constructor.

{}

Member Function Documentation

BOOL fpAssignControllerToSelected ( ReferenceTarget *  ctrl )

inlineprotected

        {
            // upcast
            return AssignControllerToSelected((Animatable*)ctrl);
        }

void fpZoomOn ( ReferenceTarget *  owner, int  subnum  )

inlineprotected

        {
            // upcast
            ZoomOn((Animatable*)owner, subnum);
        }

int fpGetIndex ( ReferenceTarget *  refAnim )

inlineprotected

        {
            // upcast
            return GetIndex((Animatable*)refAnim);
        }

void fpSelectTrack ( ReferenceTarget *  anim, BOOL  clearSelection = TRUE  )

inlineprotected

        {
            // upcast
            SelectTrack((Animatable*) anim, clearSelection);
        }

virtual int GetNumTracks ( )

pure virtual

Remarks

This method returns the number of tracks in the TreeView.

virtual int NumSelTracks ( )

pure virtual

Remarks

This method returns the number of currently selected tracks in the TreeView.

virtual void GetSelTrack ( int  i, AnimatablePtr &  anim, AnimatablePtr &  client, int &  subNum  )

pure virtual

Remarks

This method retrieves a track by its specified index.

Parameters:

int i

The index of the track you wish you retrieve.

AnimatablePtr &anim

A reference to the Animatable object of the track that was specified.

AnimatablePtr &client

A reference to the client object of the track that was specified. This is the 'parent' or 'owner' of the specified item.

int &subNum

The index of the sub-anim of the track that was specified.

virtual ReferenceTarget* GetAnim ( int  index )

pure virtual

Remarks

This method returns a pointer to the reference target associated with a TrackView entry.

Parameters:

int index

The index of the TrackView entry for which to retrieve the reference target.

virtual ReferenceTarget* GetClient ( int  index )

pure virtual

Remarks

This method returns a pointer to the client of the specified track. This is the 'parent' or 'owner' of the specified item.

Parameters:

int index

The index of the TrackView entry for which to retrieve the client.

virtual BOOL CanAssignController ( )

pure virtual

Remarks

This method returns TRUE if a controller can be assigned and FALSE if no controller can be assigned.

virtual void DoAssignController ( BOOL  clearMot = TRUE )

pure virtual

Remarks

This method will invoke the assign controller dialog.

Parameters:

BOOL clearMot

TRUE to clear the current settings, FALSE to leave the current settings.

virtual void ShowControllerType ( BOOL  show )

pure virtual

Remarks

This method allows you to set the show controller type flag, on or off.

Parameters:

BOOL show

Set the parameter to TRUE if the controller type should be shown. FALSE if the controller type should not be shown.

virtual const MCHAR* GetTVName ( )

pure virtual

Remarks

This method returns the name of the TreeView name.

virtual void SetTVName ( const MCHAR *  )

pure virtual

Remarks

This method allows you to set the TreeView name.

Parameters:

MCHAR* s

The name of the TreeView you wish to set.

virtual void CloseTreeView ( )

pure virtual

Remarks

This method will close the TreeView window.

virtual void SetFilter ( DWORD  mask, int  which, BOOL  redraw = TRUE  )

pure virtual

Remarks

This method allows you to set set a TreeView selection filter by adding to the selection mask.

Parameters:

DWORD mask

The filter selection mask. See the List of TrackView Filter Mask Types for details.

int which

The filter you wish to set, 0 for filter 1, and 1 for filter 2.

BOOL redraw

Signal that a redraw should be issued.

virtual void ClearFilter ( DWORD  mask, int  which, BOOL  redraw = TRUE  )

pure virtual

Remarks

This method allows you to set set a TreeView selection filter by subtracting from the selection mask.

Parameters:

DWORD mask

The filter selection mask. See the List of TrackView Filter Mask Types for details.

int which

The filter you wish to clear, 0 for filter 1, and 1 for filter 2.

BOOL redraw

Signal that a redraw should be issued.

virtual DWORD TestFilter ( DWORD  mask, int  which  )

pure virtual

Remarks

This method allows you to test if a filter has been set.

Parameters:

DWORD mask

The filter selection mask. See the List of TrackView Filter Mask Types for details.

int which

The filter you wish to test, 0 for filter 1, and 1 for filter 2.

virtual void ZoomOn ( Animatable *  owner, int  subnum  )

pure virtual

Remarks

This method allows you to zoom/focus on a specified entry.

Parameters:

Animatable* owner

A pointer to the Animatable you wish to zoom/focus on.

int subnum

The sub-anim you wish to zoom/focus on.

virtual void ZoomSelected ( )

pure virtual

Remarks

This method will zoom/focus on the selected entry.

virtual void ExpandTracks ( )

pure virtual

Remarks

This method will expand the tracks in the TreeView.

virtual int GetIndex ( Animatable *  anim )

pure virtual

Remarks

This method returns the index of the specified Animatable.

Parameters:

Animatable *anim

A pointer to the Animatable you wish to get the index of.

virtual void SelectTrackByIndex ( int  index, BOOL  clearSelection = TRUE  )

pure virtual

Remarks

This method allows you to select a specific track by providing its index.

Parameters:

int index

The index of the track you wish to select.

BOOL clearSelection

Set this parameter to TRUE to signal the TreeView to clear the current selection, otherwise FALSE.

virtual void SelectTrack ( Animatable *  anim, BOOL  clearSelection = TRUE  )

pure virtual

Remarks

This method allows you to select the track in trackview corresponding to the Animatable* passed as the argument.

Parameters:

Animatable* anim

A pointer to the Animatable you wish to select.

BOOL clearSelection

Set this parameter to TRUE to signal the TreeView to clear the current selection, otherwise FALSE.

virtual BOOL AssignControllerToSelected ( Animatable *  ctrl )

pure virtual

Remarks

This method allows you to assign a controller to the selected entry. The function checks to make sure a controller can be assigned to the selected tracks, and that the controller passed in is of the appropriate SuperClass_ID. Returns FALSE if the tracks don't all have the same SuperClassID, or if the controller argument is of the wrong type.

Parameters:

Animatable* ctrl

A pointer to the Animatable controller you wish to assign.

Returns

TRUE if the assignment was successful, otherwise FALSE.

virtual void SetEditMode ( int  mode )

pure virtual

Remarks

This method allows you to set the edit mode that the trackview displays.

Parameters:

int mode

The edit mode, which is one of the following;

MODE_EDITKEYS

Edit keys mode.

MODE_EDITTIME

Edit time mode.

MODE_EDITRANGES

Edit ranges mode.

MODE_POSRANGES

Edit pos ranges model

MODE_EDITFCURVE

Edit function curves mode.

virtual int GetEditMode ( )

pure virtual

Remarks

This method returns the current edit mode.

Returns

The edit mode, which is one of the following;

MODE_EDITKEYS

Edit keys mode.

MODE_EDITTIME

Edit time mode.

MODE_EDITRANGES

Edit ranges mode.

MODE_POSRANGES

Edit pos ranges model

MODE_EDITFCURVE

Edit function curves mode.

virtual BOOL IsCurrent ( )

pure virtual

Remarks

This method returns TRUE if this trackview is the last trackview used by the user, otherwise FALSE.

virtual void SetCurrent ( )

pure virtual

Remarks

This method allows you to set this trackview to be the current trackview.

virtual void SetAutoZoomOnSelChange ( BOOL  autoZoom )

pure virtual

virtual BOOL AutoZoomOnSelChange ( ) const

pure virtual

FN_0	(	tv_getName	,
		TYPE_STRING	,
		GetTVName
	)

VFN_1	(	tv_setName	,
		SetTVName	,
		TYPE_STRING
	)

VFN_0	(	tv_close	,
		CloseTreeView
	)

FN_0	(	tv_getNumTracks	,
		TYPE_INT	,
		GetNumTracks
	)

FN_0	(	tv_numSelTracks	,
		TYPE_INT	,
		NumSelTracks
	)

FN_0	(	tv_canAssignController	,
		TYPE_BOOL	,
		CanAssignController
	)

VFN_0	(	tv_doAssignController	,
		DoAssignController
	)

FN_1	(	tv_assignController	,
		TYPE_BOOL	,
		fpAssignControllerToSelected	,
		TYPE_REFTARG
	)

VFN_1	(	tv_showControllerTypes	,
		ShowControllerType	,
		TYPE_BOOL
	)

VFN_0	(	tv_expandTracks	,
		ExpandTracks
	)

VFN_0	(	tv_zoomSelected	,
		ZoomSelected
	)

VFN_2	(	tv_zoomOnTrack	,
		fpZoomOn	,
		TYPE_REFTARG	,
		TYPE_INT
	)

FN_1	(	tv_getAnim	,
		TYPE_REFTARG	,
		GetAnim	,
		TYPE_INDEX
	)

FN_1	(	tv_getClient	,
		TYPE_REFTARG	,
		GetClient	,
		TYPE_INDEX
	)

FN_1	(	tv_getSelAnim	,
		TYPE_REFTARG	,
		fpGetSelectedAnimatable	,
		TYPE_INDEX
	)

FN_1	(	tv_getSelClient	,
		TYPE_REFTARG	,
		fpGetSelectedClient	,
		TYPE_INDEX
	)

FN_1	(	tv_getSelAnimSubNum	,
		TYPE_INDEX	,
		fpGetSelectedAnimSubNum	,
		TYPE_INDEX
	)

FN_1	(	tv_getIndex	,
		TYPE_INDEX	,
		fpGetIndex	,
		TYPE_REFTARG
	)

VFN_2	(	tv_selectTrackByIndex	,
		SelectTrackByIndex	,
		TYPE_INDEX	,
		TYPE_BOOL
	)

VFN_2	(	tv_selectTrack	,
		fpSelectTrack	,
		TYPE_REFTARG	,
		TYPE_BOOL
	)

FN_VA	(	tv_setFilter	,
		TYPE_BOOL	,
		fpSetFilter
	)

FN_VA	(	tv_clearFilter	,
		TYPE_BOOL	,
		fpClearFilter
	)

VFN_1	(	tv_setEditMode	,
		SetEditMode	,
		TYPE_ENUM
	)

FN_0	(	tv_getEditMode	,
		TYPE_ENUM	,
		GetEditMode
	)

PROP_FNS	(	tv_getEditModeProp	,
		GetEditMode	,
		tv_setEditModeProp	,
		SetEditMode	,
		TYPE_ENUM
	)

FN_0	(	tv_getCurrent	,
		TYPE_BOOL	,
		IsCurrent
	)

VFN_0	(	tv_setCurrent	,
		SetCurrent
	)

RO_PROP_FN	(	tv_getUIInterface	,
		fpGetUIInterface	,
		TYPE_INTERFACE
	)

PROP_FNS	(	tv_getModifySubTree	,
		ModifySubTree	,
		tv_setModifySubTree	,
		ModifySubTree	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getModifyChildren	,
		ModifyChildren	,
		tv_setModifyChildren	,
		ModifyChildren	,
		TYPE_BOOL
	)

VFN_0	(	tv_launchUtilityDialog	,
		LaunchUtilityDialog
	)

VFN_1	(	tv_launchUtility	,
		LaunchUtility	,
		TYPE_TSTR_BV
	)

VFN_1	(	tv_closeUtility	,
		CloseUtility	,
		TYPE_TSTR_BV
	)

FN_0	(	tv_getUtilityCount	,
		TYPE_INT	,
		GetUtilityCount
	)

FN_1	(	tv_getUtilityName	,
		TYPE_TSTR_BV	,
		GetUtilityName	,
		TYPE_INDEX
	)

VFN_2	(	tv_setTangentType	,
		SetTangentType	,
		TYPE_ENUM	,
		TYPE_ENUM
	)

VFN_2	(	tv_setInTangentType	,
		SetInTangentType	,
		TYPE_ENUM	,
		TYPE_ENUM
	)

VFN_2	(	tv_setOutTangentType	,
		SetOutTangentType	,
		TYPE_ENUM	,
		TYPE_ENUM
	)

VFN_1	(	tv_reduceKeys	,
		ReduceKeys	,
		TYPE_FLOAT
	)

VFN_0	(	tv_splitKey	,
		SplitKey
	)

VFN_0	(	tv_stepPreviousKeySelection	,
		StepPreviousKeySelection
	)

VFN_0	(	tv_stepNextKeySelection	,
		StepNextKeySelection
	)

VFN_0	(	tv_shrinkKeySelection	,
		ShrinkKeySelection
	)

VFN_0	(	tv_growKeySelection	,
		GrowKeySelection
	)

VFN_0	(	tv_easeToPreviousKey	,
		EaseToPreviousKey
	)

VFN_0	(	tv_easeToNextKey	,
		EaseToNextKey
	)

VFN_0	(	tv_mirrorKeyTangents	,
		MirrorKeyTangents
	)

VFN_1	(	tv_nudgeKey	,
		NudgeKey	,
		TYPE_BOOL
	)

VFN_1	(	tv_scaleTangentsDown	,
		ScaleTangentsDown	,
		TYPE_BOOL
	)

VFN_1	(	tv_scaleTangentsUp	,
		ScaleTangentsUp	,
		TYPE_BOOL
	)

VFN_1	(	tv_loopKey	,
		LoopKey	,
		TYPE_BOOL
	)

VFN_0	(	tv_snapScaleOriginsToFirstSelectedKey	,
		SnapScaleOriginsToFirstSelectedKey
	)

VFN_1	(	tv_spaceKeyEvenly	,
		SpaceKeyEvenly	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getInteractiveUpdate	,
		InteractiveUpdate	,
		tv_setInteractiveUpdate	,
		InteractiveUpdate	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getSyncTime	,
		SyncTime	,
		tv_setSyncTime	,
		SyncTime	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getFreezeSelKeys	,
		FreezeSelKeys	,
		tv_setFreezeSelKeys	,
		FreezeSelKeys	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getFreezeNonSelCurves	,
		FreezeNonSelCurves	,
		tv_setFreezeNonSelCurves	,
		FreezeNonSelCurves	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getShowNonSelCurves	,
		ShowNonSelCurves	,
		tv_setShowNonSelCurves	,
		ShowNonSelCurves	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getShowTangents	,
		ShowTangents	,
		tv_setShowTangents	,
		ShowTangents	,
		TYPE_ENUM
	)

PROP_FNS	(	tv_getShowFrozenKeys	,
		ShowFrozenKeys	,
		tv_setShowFrozenKeys	,
		ShowFrozenKeys	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getIsolateCurve	,
		IsolateCurve	,
		tv_setIsolateCurve	,
		IsolateCurve	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getUseSoftSelect	,
		UseSoftSelect	,
		tv_setUseSoftSelect	,
		UseSoftSelect	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getSoftSelectRange	,
		SoftSelectRange	,
		tv_setSoftSelectRange	,
		SoftSelectRange	,
		TYPE_TIMEVALUE
	)

PROP_FNS	(	tv_getSoftSelectFalloff	,
		SoftSelectFalloff	,
		tv_setSoftSelectFalloff	,
		SoftSelectFalloff	,
		TYPE_FLOAT
	)

PROP_FNS	(	tv_getEffectSelectedObjectsOnly	,
		EffectSelectedObjectsOnly	,
		tv_setEffectSelectedObjectsOnly	,
		EffectSelectedObjectsOnly	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getManualNavigation	,
		ManualNavigation	,
		tv_setManualNavigation	,
		ManualNavigation	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoExpandChildren	,
		AutoExpandChildren	,
		tv_setAutoExpandChildren	,
		AutoExpandChildren	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoExpandTransforms	,
		AutoExpandTransforms	,
		tv_setAutoExpandTransforms	,
		AutoExpandTransforms	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoExpandObjects	,
		AutoExpandObjects	,
		tv_setAutoExpandObjects	,
		AutoExpandObjects	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoExpandModifiers	,
		AutoExpandModifiers	,
		tv_setAutoExpandModifiers	,
		AutoExpandModifiers	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoExpandMaterials	,
		AutoExpandMaterials	,
		tv_setAutoExpandMaterials	,
		AutoExpandMaterials	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoExpandXYZ	,
		AutoExpandXYZ	,
		tv_setAutoExpandXYZ	,
		AutoExpandXYZ	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoSelectAnimated	,
		AutoSelectAnimated	,
		tv_setAutoSelectAnimated	,
		AutoSelectAnimated	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoSelectPosition	,
		AutoSelectPosition	,
		tv_setAutoSelectPosition	,
		AutoSelectPosition	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoSelectRotation	,
		AutoSelectRotation	,
		tv_setAutoSelectRotation	,
		AutoSelectRotation	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoSelectScale	,
		AutoSelectScale	,
		tv_setAutoSelectScale	,
		AutoSelectScale	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoSelectXYZ	,
		AutoSelectXYZ	,
		tv_setAutoSelectXYZ	,
		AutoSelectXYZ	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoZoomToRoot	,
		AutoZoomToRoot	,
		tv_setAutoZoomToRoot	,
		AutoZoomToRoot	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoZoomToSelected	,
		AutoZoomToSelected	,
		tv_setAutoZoomToSelected	,
		AutoZoomToSelected	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getAutoZoomToEdited	,
		AutoZoomToEdited	,
		tv_setAutoZoomToEdited	,
		AutoZoomToEdited	,
		TYPE_BOOL
	)

PROP_FNS	(	tv_getRootTrack	,
		GetRootTrack	,
		tv_setRootTrack	,
		SetRootTrack	,
		TYPE_REFTARG
	)

VFN_0	(	tv_restoreRootTrack	,
		RestoreDefaultRootTrack
	)

PROP_FNS	(	tv_getScaleValuesOrigin	,
		ScaleValuesOrigin	,
		tv_setScaleValuesOrigin	,
		ScaleValuesOrigin	,
		TYPE_FLOAT
	)

VFN_0	(	tv_updateList	,
		UpdateList
	)

PROP_FNS	(	tv_autoZoomOnSelChange	,
		AutoZoomOnSelChange	,
		tv_setAutoZoomOnSelChange	,
		SetAutoZoomOnSelChange	,
		TYPE_BOOL
	)

FPInterfaceDesc* GetDesc ( )

inlinevirtual

Remarks

This method returns a pointer to the Function Publishing Interface Description.

Implements FPInterface.

{ return GetDescByID(TREEVIEW_OPS_INTERFACE); }

Interface_ID GetID ( )

inlinevirtual

Remarks

This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.

Returns

The Interface_ID.

Default Implementation:

{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

{ return TREEVIEW_OPS_INTERFACE; }

virtual Animatable* fpGetSelectedAnimatable ( int  index )

pure virtual

virtual Animatable* fpGetSelectedClient ( int  index )

pure virtual

virtual int fpGetSelectedAnimSubNum ( int  index )

pure virtual

virtual BOOL fpSetFilter ( FPParams *  val )

pure virtual

virtual BOOL fpClearFilter ( FPParams *  val )

pure virtual

virtual BOOL ModifySubTree ( )

pure virtual

virtual void ModifySubTree ( BOOL  onOff )

pure virtual

virtual BOOL ModifyChildren ( )

pure virtual

virtual void ModifyChildren ( BOOL  onOff )

pure virtual

virtual void LaunchUtility ( MSTR  name )

pure virtual

virtual void LaunchUtilityDialog ( )

pure virtual

virtual void CloseUtility ( MSTR  name )

pure virtual

virtual int GetUtilityCount ( )

pure virtual

virtual MSTR GetUtilityName ( int  index )

pure virtual

virtual BOOL InteractiveUpdate ( )

pure virtual

virtual void InteractiveUpdate ( BOOL  update )

pure virtual

virtual BOOL SyncTime ( )

pure virtual

virtual void SyncTime ( BOOL  sync )

pure virtual

virtual BOOL FreezeSelKeys ( )

pure virtual

virtual void FreezeSelKeys ( BOOL  onOff )

pure virtual

virtual BOOL FreezeNonSelCurves ( )

pure virtual

virtual void FreezeNonSelCurves ( BOOL  onOff )

pure virtual

virtual BOOL ShowNonSelCurves ( )

pure virtual

virtual void ShowNonSelCurves ( BOOL  onOff )

pure virtual

virtual int ShowTangents ( )

pure virtual

virtual void ShowTangents ( int  type )

pure virtual

virtual BOOL ShowFrozenKeys ( )

pure virtual

virtual void ShowFrozenKeys ( BOOL  onOff )

pure virtual

virtual void IsolateCurve ( BOOL  onOff )

pure virtual

Turn or off the Isolate Curve state.

Parameters

[in]

onOff

When TRUE the trackview will isolate the current selection to those tracks which have keys selected and enter the Isolate Curve state. If FALSE, and the Isolate Curve state is active, it will revert back to the selection before Isolate Curve was activated. Note that if the track view selection changes in any way when the Isolate Curve state is active, the state automatically deactivates.

virtual BOOL IsolateCurve ( )

pure virtual

Get whether the Isolate Curve state is active.

Returns

Return TRUE if the Isolate Curve state is active, FALSE otherwise.

virtual void UseSoftSelect ( BOOL  use )

pure virtual

virtual BOOL UseSoftSelect ( )

pure virtual

virtual void SoftSelectRange ( TimeValue  range )

pure virtual

virtual TimeValue SoftSelectRange ( )

pure virtual

virtual void SoftSelectFalloff ( float  falloff )

pure virtual

virtual float SoftSelectFalloff ( )

pure virtual

virtual void SetTangentType ( int  type, int  effect = EFFECT_ALL_SEL_KEYS  )

pure virtual

virtual void SetInTangentType ( int  type, int  effect = EFFECT_ALL_SEL_KEYS  )

pure virtual

virtual void SetOutTangentType ( int  type, int  effect = EFFECT_ALL_SEL_KEYS  )

pure virtual

ITreeViewUI* fpGetUIInterface ( )

inline

{ return (ITreeViewUI*)GetInterface(TREEVIEW_UI_INTERFACE); }

virtual BOOL EffectSelectedObjectsOnly ( )

pure virtual

virtual void EffectSelectedObjectsOnly ( BOOL  effect )

pure virtual

virtual BOOL ManualNavigation ( )

pure virtual

virtual void ManualNavigation ( BOOL  manual )

pure virtual

virtual BOOL AutoExpandChildren ( )

pure virtual

virtual void AutoExpandChildren ( BOOL  expand )

pure virtual

virtual BOOL AutoExpandTransforms ( )

pure virtual

virtual void AutoExpandTransforms ( BOOL  expand )

pure virtual

virtual BOOL AutoExpandObjects ( )

pure virtual

virtual void AutoExpandObjects ( BOOL  expand )

pure virtual

virtual BOOL AutoExpandModifiers ( )

pure virtual

virtual void AutoExpandModifiers ( BOOL  expand )

pure virtual

virtual BOOL AutoExpandMaterials ( )

pure virtual

virtual void AutoExpandMaterials ( BOOL  expand )

pure virtual

virtual BOOL AutoExpandXYZ ( )

pure virtual

virtual void AutoExpandXYZ ( BOOL  expand )

pure virtual

virtual BOOL AutoSelectAnimated ( )

pure virtual

virtual void AutoSelectAnimated ( BOOL  select )

pure virtual

virtual BOOL AutoSelectPosition ( )

pure virtual

virtual void AutoSelectPosition ( BOOL  select )

pure virtual

virtual BOOL AutoSelectRotation ( )

pure virtual

virtual void AutoSelectRotation ( BOOL  select )

pure virtual

virtual BOOL AutoSelectScale ( )

pure virtual

virtual void AutoSelectScale ( BOOL  select )

pure virtual

virtual BOOL AutoSelectXYZ ( )

pure virtual

virtual void AutoSelectXYZ ( BOOL  select )

pure virtual

virtual BOOL AutoZoomToRoot ( )

pure virtual

virtual void AutoZoomToRoot ( BOOL  zoom )

pure virtual

virtual BOOL AutoZoomToSelected ( )

pure virtual

virtual void AutoZoomToSelected ( BOOL  zoom )

pure virtual

virtual BOOL AutoZoomToEdited ( )

pure virtual

virtual void AutoZoomToEdited ( BOOL  zoom )

pure virtual

virtual ReferenceTarget* GetRootTrack ( )

pure virtual

virtual void SetRootTrack ( ReferenceTarget *  root )

pure virtual

virtual void RestoreDefaultRootTrack ( )

pure virtual

virtual float ScaleValuesOrigin ( )

pure virtual

virtual void ScaleValuesOrigin ( float  origin )

pure virtual

virtual void UpdateList ( )

pure virtual

virtual void ReduceKeys ( float  in_threshold )

pure virtual

Remove redundant keys of selected tracks (or just the selected keys if keys are selected for a track)

Parameters

[in]

in_threshold

if removing a key results in a change of value less than the tolerance, the key is removed.

virtual void SplitKey ( )

pure virtual

Deletes all the selected keys and creates two new keys for each deleted key, one on the previous frame, the other one on the next frame.

virtual void StepPreviousKeySelection ( )

pure virtual

Moves the key selection backwards.

virtual void StepNextKeySelection ( )

pure virtual

Moves the key selection forward.

virtual void ShrinkKeySelection ( )

pure virtual

Shrinks key selection.

virtual void GrowKeySelection ( )

pure virtual

Grows Key Selection.

virtual void EaseToPreviousKey ( )

pure virtual

Eases the selected key value to the previous key.

virtual void EaseToNextKey ( )

pure virtual

Eases the selected key value to the next key.

virtual void MirrorKeyTangents ( )

pure virtual

Mirrors the tangents of the selected key to the adjacent ones.

virtual void NudgeKey ( BOOL  toLeft )

pure virtual

Nudges key selection (moves the selected keys on the next frame).

Parameters

[in]

toLeft

When true, nudges the key selection to the previous frame.

virtual void ScaleTangentsDown ( BOOL  onlyInnerHandle )

pure virtual

Scales tangents length and angle down.

Parameters

[in]

onlyInnerHandle

When true, scales only the inner tangent handles of the selection.

virtual void ScaleTangentsUp ( BOOL  onlyInnerHandle )

pure virtual

Scales tangents length and angle up.

Parameters

[in]

onlyInnerHandle

When true, scales only the inner tangent handles of the selection.

virtual void LoopKey ( BOOL  toLastKey )

pure virtual

Copies the first key value to the last frame of the current animation range.

Parameters

[in]

toLastKey

When true, copies the first key value of the current animation to the last one.

virtual void SnapScaleOriginsToFirstSelectedKey ( )

pure virtual

Works with Scales Values tool.Moves the scale origin to the first selected key.

virtual void SpaceKeyEvenly ( BOOL  inValue )

pure virtual

Spaces the key selection evenly in time between the first and last keys.

Parameters

[in]

inValue

When true, spaces evenly in value.

virtual void RelaxKeys ( BOOL  toLin )

pure virtual

Eases key values and tangents between the first and last keys of the selection.

Parameters

[in]

toLin

When true, aligns the keys between the first and last keys of the selection

virtual void FlattenKeys ( BOOL  toLeft )

pure virtual

Flattens the selected keys to the first selected key value.

Parameters

[in]

toLeft

When true, flattens the selected keys to the value of the last selected one.

virtual void AverageKeys ( BOOL  weld )

pure virtual

Flattens the selected keys to the average value of the selected keys.

Parameters

[in]

weld

When true, welds the selected keys.