3ds Max C++ API Reference
Loading...
Searching...
No Matches
ITreeViewOps Class Referenceabstract

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/itreevw.h>

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_testFilter ,
  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 ReferenceTargetGetAnim (int index)=0
virtual ReferenceTargetGetClient (int index)=0
virtual BOOL CanAssignController ()=0
virtual void DoAssignController (BOOL clearMot=TRUE)=0
virtual void ShowControllerType (BOOL show)=0
virtual const MCHARGetTVName ()=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, fpSelectTrackByIndex, 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)
 FN_VA (tv_testFilter, TYPE_BOOL, fpTestFilter)
 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)
FPInterfaceDescGetDesc ()
Interface_ID GetID ()
virtual AnimatablefpGetSelectedAnimatable (int index)=0
virtual AnimatablefpGetSelectedClient (int index)=0
virtual int fpGetSelectedAnimSubNum (int index)=0
virtual BOOL fpSetFilter (FPParams *val)=0
virtual BOOL fpClearFilter (FPParams *val)=0
virtual BOOL fpTestFilter (FPParams *val)=0
virtual void fpSelectTrackByIndex (int index, BOOL clearSelection=TRUE)=0
 function-mapping version of SelectTrackByIndex, throwing an exception on an invalid index
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.
virtual BOOL IsolateCurve ()=0
 Get whether the Isolate Curve state is active.
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
ITreeViewUIfpGetUIInterface ()
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 ReferenceTargetGetRootTrack ()=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)
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.
virtual void StepPreviousKeySelection ()=0
 Moves the key selection backwards.
virtual void StepNextKeySelection ()=0
 Moves the key selection forward.
virtual void ShrinkKeySelection ()=0
 Shrinks key selection.
virtual void GrowKeySelection ()=0
 Grows Key Selection.
virtual void EaseToPreviousKey ()=0
 Eases the selected key value to the previous key.
virtual void EaseToNextKey ()=0
 Eases the selected key value to the next key.
virtual void MirrorKeyTangents ()=0
 Mirrors the tangents of the selected key to the adjacent ones.
virtual void NudgeKey (BOOL toLeft)=0
 Nudges key selection (moves the selected keys on the next frame).
virtual void ScaleTangentsDown (BOOL onlyInnerHandle)=0
 Scales tangents length and angle down.
virtual void ScaleTangentsUp (BOOL onlyInnerHandle)=0
 Scales tangents length and angle up.
virtual void LoopKey (BOOL toLastKey)=0
 Copies the first key value to the last frame of the current animation range.
virtual void SnapScaleOriginsToFirstSelectedKey ()=0
 Works with Scales Values tool.Moves the scale origin to the first selected key.
virtual void SpaceKeyEvenly (BOOL inValue)=0
 Spaces the key selection evenly in time between the first and last keys.
virtual void RelaxKeys (BOOL toLin)=0
 Eases key values and tangents between the first and last keys of the selection.
virtual void FlattenKeys (BOOL toLeft)=0
 Flattens the selected keys to the first selected key value.
virtual void AverageKeys (BOOL weld)=0
 Flattens the selected keys to the average value of the selected keys.
Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
virtual LifetimeType LifetimeControl ()
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport ~FPMixinInterface ()
virtual BaseInterfaceGetInterface (Interface_ID id)
virtual FPInterfaceDescGetDescByID (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 ActionTableGetActionTable ()
virtual void EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
virtual BaseInterfaceAcquireInterface ()
virtual void ReleaseInterface ()
virtual void DeleteInterface ()
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
template<class InterfaceType>
InterfaceType * GetTypedInterface ()

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)
FPMixinInterfaceoperator= (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 voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
static UtilExport voidaligned_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 Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs

Detailed Description

See also
Class FPMixinInterface, Class Animatable, Class ReferenceTarget

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

Member Enumeration Documentation

◆ anonymous enum

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_testFilter 
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 
407 {
436 //symbolic enums
452
453 };
@ tv_selectTrackByIndex
Definition itreevw.h:412
@ tv_splitKey
Definition itreevw.h:440
@ tv_setInTangentType
Definition itreevw.h:419
@ tv_getClient
Definition itreevw.h:411
@ tv_getSelTrack
Definition itreevw.h:408
@ tv_zoomOnTrack
Definition itreevw.h:410
@ tv_setUseSoftSelect
Definition itreevw.h:431
@ tv_setOutTangentType
Definition itreevw.h:419
@ tv_launchUtility
Definition itreevw.h:417
@ tv_setAutoExpandObjects
Definition itreevw.h:425
@ tv_launchUtilityDialog
Definition itreevw.h:417
@ tv_setInteractiveUpdate
Definition itreevw.h:418
@ tv_setAutoSelectPosition
Definition itreevw.h:427
@ tv_getAutoSelectScale
Definition itreevw.h:428
@ tv_setSyncTime
Definition itreevw.h:418
@ tv_setIsolateCurve
Definition itreevw.h:434
@ tv_getAutoExpandObjects
Definition itreevw.h:425
@ tv_getSoftSelectRange
Definition itreevw.h:432
@ tv_getUtilityCount
Definition itreevw.h:417
@ tv_getModifyChildren
Definition itreevw.h:416
@ tv_stepPreviousKeySelection
Definition itreevw.h:441
@ tv_setEditModeProp
Definition itreevw.h:414
@ tv_setRootTrack
Definition itreevw.h:433
@ tv_getNumTracks
Definition itreevw.h:408
@ tv_getEditMode
Definition itreevw.h:414
@ tv_testFilter
Definition itreevw.h:413
@ tv_getModifySubTree
Definition itreevw.h:415
@ tv_getAutoSelectPosition
Definition itreevw.h:427
@ tv_getEditModeProp
Definition itreevw.h:414
@ tv_getShowNonSelCurves
Definition itreevw.h:421
@ tv_getSyncTime
Definition itreevw.h:418
@ tv_setModifyChildren
Definition itreevw.h:416
@ tv_expandTracks
Definition itreevw.h:410
@ tv_doAssignController
Definition itreevw.h:409
@ tv_getAutoExpandMaterials
Definition itreevw.h:426
@ tv_getAutoZoomToRoot
Definition itreevw.h:430
@ tv_canAssignController
Definition itreevw.h:409
@ tv_averageKeys
Definition itreevw.h:451
@ tv_getSoftSelectFalloff
Definition itreevw.h:432
@ tv_getAutoZoomToSelected
Definition itreevw.h:430
@ tv_getManualNavigation
Definition itreevw.h:429
@ tv_enumEffectTracks
Definition itreevw.h:437
@ tv_setFreezeSelKeys
Definition itreevw.h:420
@ tv_easeToPreviousKey
Definition itreevw.h:443
@ tv_setAutoExpandMaterials
Definition itreevw.h:426
@ tv_getUtilityName
Definition itreevw.h:417
@ tv_loopKey
Definition itreevw.h:447
@ tv_setAutoSelectXYZ
Definition itreevw.h:429
@ tv_setAutoExpandTransforms
Definition itreevw.h:424
@ tv_getSelAnimSubNum
Definition itreevw.h:411
@ tv_nudgeKey
Definition itreevw.h:445
@ tv_getFreezeSelKeys
Definition itreevw.h:420
@ tv_scaleTangentsDown
Definition itreevw.h:446
@ tv_clearFilter
Definition itreevw.h:413
@ tv_editModeTypes
Definition itreevw.h:437
@ tv_setCurrent
Definition itreevw.h:415
@ tv_setModifySubTree
Definition itreevw.h:415
@ tv_numSelTracks
Definition itreevw.h:408
@ tv_zoomSelected
Definition itreevw.h:410
@ tv_getShowTangents
Definition itreevw.h:422
@ tv_getAnim
Definition itreevw.h:411
@ tv_setSoftSelectFalloff
Definition itreevw.h:432
@ tv_autoZoomOnSelChange
Definition itreevw.h:438
@ tv_setShowNonSelCurves
Definition itreevw.h:421
@ tv_getAutoExpandModifiers
Definition itreevw.h:425
@ tv_setAutoSelectAnimated
Definition itreevw.h:427
@ tv_getAutoExpandChildren
Definition itreevw.h:424
@ tv_getAutoSelectRotation
Definition itreevw.h:428
@ tv_setAutoZoomToSelected
Definition itreevw.h:430
@ tv_getAutoSelectAnimated
Definition itreevw.h:427
@ tv_getIsolateCurve
Definition itreevw.h:434
@ tv_setAutoExpandChildren
Definition itreevw.h:424
@ tv_getFreezeNonSelCurves
Definition itreevw.h:421
@ tv_getAutoSelectXYZ
Definition itreevw.h:429
@ tv_getSelClient
Definition itreevw.h:411
@ tv_scaleTangentsUp
Definition itreevw.h:446
@ tv_updateList
Definition itreevw.h:435
@ tv_getScaleValuesOrigin
Definition itreevw.h:433
@ tv_setAutoZoomToEdited
Definition itreevw.h:431
@ tv_setTangentType
Definition itreevw.h:419
@ tv_getInteractiveUpdate
Definition itreevw.h:418
@ tv_close
Definition itreevw.h:408
@ tv_getAutoExpandXYZ
Definition itreevw.h:426
@ tv_setFilter
Definition itreevw.h:413
@ tv_setAutoExpandModifiers
Definition itreevw.h:425
@ tv_setAutoZoomToRoot
Definition itreevw.h:430
@ tv_enumKeyTangentType
Definition itreevw.h:437
@ tv_setManualNavigation
Definition itreevw.h:429
@ tv_setSoftSelectRange
Definition itreevw.h:432
@ tv_setShowFrozenKeys
Definition itreevw.h:422
@ tv_showControllerTypes
Definition itreevw.h:409
@ tv_snapScaleOriginsToFirstSelectedKey
Definition itreevw.h:448
@ tv_setAutoSelectRotation
Definition itreevw.h:428
@ tv_restoreRootTrack
Definition itreevw.h:433
@ tv_getName
Definition itreevw.h:408
@ tv_closeUtility
Definition itreevw.h:417
@ tv_getIndex
Definition itreevw.h:412
@ tv_mirrorKeyTangents
Definition itreevw.h:444
@ tv_growKeySelection
Definition itreevw.h:442
@ tv_getRootTrack
Definition itreevw.h:433
@ tv_getUseSoftSelect
Definition itreevw.h:431
@ tv_getAutoZoomToEdited
Definition itreevw.h:431
@ tv_stepNextKeySelection
Definition itreevw.h:441
@ tv_reduceKeys
Definition itreevw.h:439
@ tv_getAutoExpandTransforms
Definition itreevw.h:424
@ tv_shrinkKeySelection
Definition itreevw.h:442
@ tv_spaceKeyEvenly
Definition itreevw.h:449
@ tv_setEffectSelectedObjectsOnly
Definition itreevw.h:423
@ tv_setFreezeNonSelCurves
Definition itreevw.h:421
@ tv_setAutoZoomOnSelChange
Definition itreevw.h:438
@ tv_relaxKeys
Definition itreevw.h:450
@ tv_easeToNextKey
Definition itreevw.h:443
@ tv_setAutoSelectScale
Definition itreevw.h:428
@ tv_selectTrack
Definition itreevw.h:412
@ tv_setScaleValuesOrigin
Definition itreevw.h:433
@ tv_getUIInterface
Definition itreevw.h:415
@ tv_getCurrent
Definition itreevw.h:415
@ tv_enumTangentDisplay
Definition itreevw.h:437
@ tv_setAutoExpandXYZ
Definition itreevw.h:426
@ tv_setShowTangents
Definition itreevw.h:422
@ tv_getSelAnim
Definition itreevw.h:411
@ tv_getShowFrozenKeys
Definition itreevw.h:422
@ tv_setEditMode
Definition itreevw.h:414
@ tv_flattenKeys
Definition itreevw.h:451
@ tv_assignController
Definition itreevw.h:409
@ tv_setName
Definition itreevw.h:408
@ tv_getEffectSelectedObjectsOnly
Definition itreevw.h:423

Constructor & Destructor Documentation

◆ ~ITreeViewOps()

virtual ~ITreeViewOps ( )
inlinevirtual
Remarks
Constructor.
219{}

Member Function Documentation

◆ fpAssignControllerToSelected()

BOOL fpAssignControllerToSelected ( ReferenceTarget * ctrl)
inlineprotected
198 {
199 // upcast
200 return AssignControllerToSelected((Animatable*)ctrl);
201 }
virtual BOOL AssignControllerToSelected(Animatable *ctrl)=0

◆ fpZoomOn()

void fpZoomOn ( ReferenceTarget * owner,
int subnum )
inlineprotected
203 {
204 // upcast
205 ZoomOn((Animatable*)owner, subnum);
206 }
virtual void ZoomOn(Animatable *owner, int subnum)=0

◆ fpGetIndex()

int fpGetIndex ( ReferenceTarget * refAnim)
inlineprotected
208 {
209 // upcast
210 return GetIndex((Animatable*)refAnim);
211 }
virtual int GetIndex(Animatable *anim)=0

◆ fpSelectTrack()

void fpSelectTrack ( ReferenceTarget * anim,
BOOL clearSelection = TRUE )
inlineprotected
213 {
214 // upcast
215 SelectTrack((Animatable*) anim, clearSelection);
216 }
virtual void SelectTrack(Animatable *anim, BOOL clearSelection=TRUE)=0

◆ GetNumTracks()

virtual int GetNumTracks ( )
pure virtual
Remarks
This method returns the number of tracks in the TreeView.

◆ NumSelTracks()

virtual int NumSelTracks ( )
pure virtual
Remarks
This method returns the number of currently selected tracks in the TreeView.

◆ GetSelTrack()

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.

◆ GetAnim()

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.

◆ GetClient()

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.

◆ CanAssignController()

virtual BOOL CanAssignController ( )
pure virtual
Remarks
This method returns TRUE if a controller can be assigned and FALSE if no controller can be assigned.

◆ DoAssignController()

virtual void DoAssignController ( BOOL clearMot = TRUE)
pure virtual
Remarks
This method will invoke the assign controller dialog.
Parameters:
BOOL clearMot

As of 2024.2, clearMot parameter is no longer used.

◆ ShowControllerType()

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.

◆ GetTVName()

virtual const MCHAR * GetTVName ( )
pure virtual
Remarks
This method returns the name of the TreeView name.

◆ SetTVName()

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.

◆ CloseTreeView()

virtual void CloseTreeView ( )
pure virtual
Remarks
This method will close the TreeView window.

◆ SetFilter()

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.

◆ ClearFilter()

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.

◆ TestFilter()

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.

◆ ZoomOn()

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.

◆ ZoomSelected()

virtual void ZoomSelected ( )
pure virtual
Remarks
This method will zoom/focus on the selected entry.

◆ ExpandTracks()

virtual void ExpandTracks ( )
pure virtual
Remarks
This method will expand the tracks in the TreeView.

◆ GetIndex()

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.

◆ SelectTrackByIndex()

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.

◆ SelectTrack()

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.

◆ AssignControllerToSelected()

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.

◆ SetEditMode()

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.

◆ GetEditMode()

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.

◆ IsCurrent()

virtual BOOL IsCurrent ( )
pure virtual
Remarks
This method returns TRUE if this trackview is the last trackview used by the user, otherwise FALSE.

◆ SetCurrent()

virtual void SetCurrent ( )
pure virtual
Remarks
This method allows you to set this trackview to be the current trackview.

◆ SetAutoZoomOnSelChange()

virtual void SetAutoZoomOnSelChange ( BOOL autoZoom)
pure virtual

◆ AutoZoomOnSelChange()

virtual BOOL AutoZoomOnSelChange ( ) const
pure virtual

◆ FN_0() [1/7]

◆ VFN_1() [1/11]

VFN_1 ( tv_setName ,
SetTVName ,
TYPE_STRING  )

◆ VFN_0() [1/17]

VFN_0 ( tv_close ,
CloseTreeView  )

◆ FN_0() [2/7]

◆ FN_0() [3/7]

◆ FN_0() [4/7]

◆ VFN_0() [2/17]

◆ FN_1() [1/8]

◆ VFN_1() [2/11]

◆ VFN_0() [3/17]

◆ VFN_0() [4/17]

◆ VFN_2() [1/6]

◆ FN_1() [2/8]

◆ FN_1() [3/8]

◆ FN_1() [4/8]

◆ FN_1() [5/8]

◆ FN_1() [6/8]

◆ FN_1() [7/8]

◆ VFN_2() [2/6]

◆ VFN_2() [3/6]

◆ FN_VA() [1/3]

◆ FN_VA() [2/3]

◆ FN_VA() [3/3]

◆ VFN_1() [3/11]

◆ FN_0() [5/7]

◆ PROP_FNS() [1/33]

◆ FN_0() [6/7]

◆ VFN_0() [5/17]

VFN_0 ( tv_setCurrent ,
SetCurrent  )

◆ RO_PROP_FN()

◆ PROP_FNS() [2/33]

◆ PROP_FNS() [3/33]

◆ VFN_0() [6/17]

◆ VFN_1() [4/11]

◆ VFN_1() [5/11]

◆ FN_0() [7/7]

◆ FN_1() [8/8]

◆ VFN_2() [4/6]

◆ VFN_2() [5/6]

◆ VFN_2() [6/6]

◆ VFN_1() [6/11]

◆ VFN_0() [7/17]

VFN_0 ( tv_splitKey ,
SplitKey  )

◆ VFN_0() [8/17]

◆ VFN_0() [9/17]

◆ VFN_0() [10/17]

◆ VFN_0() [11/17]

◆ VFN_0() [12/17]

◆ VFN_0() [13/17]

◆ VFN_0() [14/17]

◆ VFN_1() [7/11]

VFN_1 ( tv_nudgeKey ,
NudgeKey ,
TYPE_BOOL  )

◆ VFN_1() [8/11]

◆ VFN_1() [9/11]

◆ VFN_1() [10/11]

VFN_1 ( tv_loopKey ,
LoopKey ,
TYPE_BOOL  )

◆ VFN_0() [15/17]

◆ VFN_1() [11/11]

◆ PROP_FNS() [4/33]

◆ PROP_FNS() [5/33]

◆ PROP_FNS() [6/33]

◆ PROP_FNS() [7/33]

◆ PROP_FNS() [8/33]

◆ PROP_FNS() [9/33]

◆ PROP_FNS() [10/33]

◆ PROP_FNS() [11/33]

◆ PROP_FNS() [12/33]

◆ PROP_FNS() [13/33]

◆ PROP_FNS() [14/33]

◆ PROP_FNS() [15/33]

◆ PROP_FNS() [16/33]

◆ PROP_FNS() [17/33]

◆ PROP_FNS() [18/33]

◆ PROP_FNS() [19/33]

◆ PROP_FNS() [20/33]

◆ PROP_FNS() [21/33]

◆ PROP_FNS() [22/33]

◆ PROP_FNS() [23/33]

◆ PROP_FNS() [24/33]

◆ PROP_FNS() [25/33]

◆ PROP_FNS() [26/33]

◆ PROP_FNS() [27/33]

◆ PROP_FNS() [28/33]

◆ PROP_FNS() [29/33]

◆ PROP_FNS() [30/33]

◆ PROP_FNS() [31/33]

◆ VFN_0() [16/17]

◆ PROP_FNS() [32/33]

◆ VFN_0() [17/17]

VFN_0 ( tv_updateList ,
UpdateList  )

◆ PROP_FNS() [33/33]

◆ GetDesc()

FPInterfaceDesc * GetDesc ( )
inlinevirtual
Remarks
This method returns a pointer to the Function Publishing Interface Description.

Implements FPInterface.

virtual FPInterfaceDesc * GetDescByID(Interface_ID id)
Definition ifnpub.h:619
#define TREEVIEW_OPS_INTERFACE
Definition itreevw.h:187

◆ GetID()

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.

571{ return TREEVIEW_OPS_INTERFACE; }

◆ fpGetSelectedAnimatable()

virtual Animatable * fpGetSelectedAnimatable ( int index)
pure virtual

◆ fpGetSelectedClient()

virtual Animatable * fpGetSelectedClient ( int index)
pure virtual

◆ fpGetSelectedAnimSubNum()

virtual int fpGetSelectedAnimSubNum ( int index)
pure virtual

◆ fpSetFilter()

virtual BOOL fpSetFilter ( FPParams * val)
pure virtual

◆ fpClearFilter()

virtual BOOL fpClearFilter ( FPParams * val)
pure virtual

◆ fpTestFilter()

virtual BOOL fpTestFilter ( FPParams * val)
pure virtual

◆ fpSelectTrackByIndex()

virtual void fpSelectTrackByIndex ( int index,
BOOL clearSelection = TRUE )
pure virtual

function-mapping version of SelectTrackByIndex, throwing an exception on an invalid index

◆ ModifySubTree() [1/2]

virtual BOOL ModifySubTree ( )
pure virtual

◆ ModifySubTree() [2/2]

virtual void ModifySubTree ( BOOL onOff)
pure virtual

◆ ModifyChildren() [1/2]

virtual BOOL ModifyChildren ( )
pure virtual

◆ ModifyChildren() [2/2]

virtual void ModifyChildren ( BOOL onOff)
pure virtual

◆ LaunchUtility()

virtual void LaunchUtility ( MSTR name)
pure virtual

◆ LaunchUtilityDialog()

virtual void LaunchUtilityDialog ( )
pure virtual

◆ CloseUtility()

virtual void CloseUtility ( MSTR name)
pure virtual

◆ GetUtilityCount()

virtual int GetUtilityCount ( )
pure virtual

◆ GetUtilityName()

virtual MSTR GetUtilityName ( int index)
pure virtual

◆ InteractiveUpdate() [1/2]

virtual BOOL InteractiveUpdate ( )
pure virtual

◆ InteractiveUpdate() [2/2]

virtual void InteractiveUpdate ( BOOL update)
pure virtual

◆ SyncTime() [1/2]

virtual BOOL SyncTime ( )
pure virtual

◆ SyncTime() [2/2]

virtual void SyncTime ( BOOL sync)
pure virtual

◆ FreezeSelKeys() [1/2]

virtual BOOL FreezeSelKeys ( )
pure virtual

◆ FreezeSelKeys() [2/2]

virtual void FreezeSelKeys ( BOOL onOff)
pure virtual

◆ FreezeNonSelCurves() [1/2]

virtual BOOL FreezeNonSelCurves ( )
pure virtual

◆ FreezeNonSelCurves() [2/2]

virtual void FreezeNonSelCurves ( BOOL onOff)
pure virtual

◆ ShowNonSelCurves() [1/2]

virtual BOOL ShowNonSelCurves ( )
pure virtual

◆ ShowNonSelCurves() [2/2]

virtual void ShowNonSelCurves ( BOOL onOff)
pure virtual

◆ ShowTangents() [1/2]

virtual int ShowTangents ( )
pure virtual

◆ ShowTangents() [2/2]

virtual void ShowTangents ( int type)
pure virtual

◆ ShowFrozenKeys() [1/2]

virtual BOOL ShowFrozenKeys ( )
pure virtual

◆ ShowFrozenKeys() [2/2]

virtual void ShowFrozenKeys ( BOOL onOff)
pure virtual

◆ IsolateCurve() [1/2]

virtual void IsolateCurve ( BOOL onOff)
pure virtual

Turn or off the Isolate Curve state.

Parameters
[in]onOffWhen 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.

◆ IsolateCurve() [2/2]

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.

◆ UseSoftSelect() [1/2]

virtual void UseSoftSelect ( BOOL use)
pure virtual

◆ UseSoftSelect() [2/2]

virtual BOOL UseSoftSelect ( )
pure virtual

◆ SoftSelectRange() [1/2]

virtual void SoftSelectRange ( TimeValue range)
pure virtual

◆ SoftSelectRange() [2/2]

virtual TimeValue SoftSelectRange ( )
pure virtual

◆ SoftSelectFalloff() [1/2]

virtual void SoftSelectFalloff ( float falloff)
pure virtual

◆ SoftSelectFalloff() [2/2]

virtual float SoftSelectFalloff ( )
pure virtual

◆ SetTangentType()

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

◆ SetInTangentType()

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

◆ SetOutTangentType()

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

◆ fpGetUIInterface()

ITreeViewUI * fpGetUIInterface ( )
inline
647{ return (ITreeViewUI*)GetInterface(TREEVIEW_UI_INTERFACE); }
virtual BaseInterface * GetInterface(Interface_ID id)
Definition ifnpub.h:601
#define TREEVIEW_UI_INTERFACE
Definition itreevw.h:70

◆ EffectSelectedObjectsOnly() [1/2]

virtual BOOL EffectSelectedObjectsOnly ( )
pure virtual

◆ EffectSelectedObjectsOnly() [2/2]

virtual void EffectSelectedObjectsOnly ( BOOL effect)
pure virtual

◆ ManualNavigation() [1/2]

virtual BOOL ManualNavigation ( )
pure virtual

◆ ManualNavigation() [2/2]

virtual void ManualNavigation ( BOOL manual)
pure virtual

◆ AutoExpandChildren() [1/2]

virtual BOOL AutoExpandChildren ( )
pure virtual

◆ AutoExpandChildren() [2/2]

virtual void AutoExpandChildren ( BOOL expand)
pure virtual

◆ AutoExpandTransforms() [1/2]

virtual BOOL AutoExpandTransforms ( )
pure virtual

◆ AutoExpandTransforms() [2/2]

virtual void AutoExpandTransforms ( BOOL expand)
pure virtual

◆ AutoExpandObjects() [1/2]

virtual BOOL AutoExpandObjects ( )
pure virtual

◆ AutoExpandObjects() [2/2]

virtual void AutoExpandObjects ( BOOL expand)
pure virtual

◆ AutoExpandModifiers() [1/2]

virtual BOOL AutoExpandModifiers ( )
pure virtual

◆ AutoExpandModifiers() [2/2]

virtual void AutoExpandModifiers ( BOOL expand)
pure virtual

◆ AutoExpandMaterials() [1/2]

virtual BOOL AutoExpandMaterials ( )
pure virtual

◆ AutoExpandMaterials() [2/2]

virtual void AutoExpandMaterials ( BOOL expand)
pure virtual

◆ AutoExpandXYZ() [1/2]

virtual BOOL AutoExpandXYZ ( )
pure virtual

◆ AutoExpandXYZ() [2/2]

virtual void AutoExpandXYZ ( BOOL expand)
pure virtual

◆ AutoSelectAnimated() [1/2]

virtual BOOL AutoSelectAnimated ( )
pure virtual

◆ AutoSelectAnimated() [2/2]

virtual void AutoSelectAnimated ( BOOL select)
pure virtual

◆ AutoSelectPosition() [1/2]

virtual BOOL AutoSelectPosition ( )
pure virtual

◆ AutoSelectPosition() [2/2]

virtual void AutoSelectPosition ( BOOL select)
pure virtual

◆ AutoSelectRotation() [1/2]

virtual BOOL AutoSelectRotation ( )
pure virtual

◆ AutoSelectRotation() [2/2]

virtual void AutoSelectRotation ( BOOL select)
pure virtual

◆ AutoSelectScale() [1/2]

virtual BOOL AutoSelectScale ( )
pure virtual

◆ AutoSelectScale() [2/2]

virtual void AutoSelectScale ( BOOL select)
pure virtual

◆ AutoSelectXYZ() [1/2]

virtual BOOL AutoSelectXYZ ( )
pure virtual

◆ AutoSelectXYZ() [2/2]

virtual void AutoSelectXYZ ( BOOL select)
pure virtual

◆ AutoZoomToRoot() [1/2]

virtual BOOL AutoZoomToRoot ( )
pure virtual

◆ AutoZoomToRoot() [2/2]

virtual void AutoZoomToRoot ( BOOL zoom)
pure virtual

◆ AutoZoomToSelected() [1/2]

virtual BOOL AutoZoomToSelected ( )
pure virtual

◆ AutoZoomToSelected() [2/2]

virtual void AutoZoomToSelected ( BOOL zoom)
pure virtual

◆ AutoZoomToEdited() [1/2]

virtual BOOL AutoZoomToEdited ( )
pure virtual

◆ AutoZoomToEdited() [2/2]

virtual void AutoZoomToEdited ( BOOL zoom)
pure virtual

◆ GetRootTrack()

virtual ReferenceTarget * GetRootTrack ( )
pure virtual

◆ SetRootTrack()

virtual void SetRootTrack ( ReferenceTarget * root)
pure virtual

◆ RestoreDefaultRootTrack()

virtual void RestoreDefaultRootTrack ( )
pure virtual

◆ ScaleValuesOrigin() [1/2]

virtual float ScaleValuesOrigin ( )
pure virtual

◆ ScaleValuesOrigin() [2/2]

virtual void ScaleValuesOrigin ( float origin)
pure virtual

◆ UpdateList()

virtual void UpdateList ( )
pure virtual

◆ ReduceKeys()

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_thresholdif removing a key results in a change of value less than the tolerance, the key is removed.

◆ SplitKey()

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.

◆ StepPreviousKeySelection()

virtual void StepPreviousKeySelection ( )
pure virtual

Moves the key selection backwards.

◆ StepNextKeySelection()

virtual void StepNextKeySelection ( )
pure virtual

Moves the key selection forward.

◆ ShrinkKeySelection()

virtual void ShrinkKeySelection ( )
pure virtual

Shrinks key selection.

◆ GrowKeySelection()

virtual void GrowKeySelection ( )
pure virtual

Grows Key Selection.

◆ EaseToPreviousKey()

virtual void EaseToPreviousKey ( )
pure virtual

Eases the selected key value to the previous key.

◆ EaseToNextKey()

virtual void EaseToNextKey ( )
pure virtual

Eases the selected key value to the next key.

◆ MirrorKeyTangents()

virtual void MirrorKeyTangents ( )
pure virtual

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

◆ NudgeKey()

virtual void NudgeKey ( BOOL toLeft)
pure virtual

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

Parameters
[in]toLeftWhen true, nudges the key selection to the previous frame.

◆ ScaleTangentsDown()

virtual void ScaleTangentsDown ( BOOL onlyInnerHandle)
pure virtual

Scales tangents length and angle down.

Parameters
[in]onlyInnerHandleWhen true, scales only the inner tangent handles of the selection.

◆ ScaleTangentsUp()

virtual void ScaleTangentsUp ( BOOL onlyInnerHandle)
pure virtual

Scales tangents length and angle up.

Parameters
[in]onlyInnerHandleWhen true, scales only the inner tangent handles of the selection.

◆ LoopKey()

virtual void LoopKey ( BOOL toLastKey)
pure virtual

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

Parameters
[in]toLastKeyWhen true, copies the first key value of the current animation to the last one.

◆ SnapScaleOriginsToFirstSelectedKey()

virtual void SnapScaleOriginsToFirstSelectedKey ( )
pure virtual

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

◆ SpaceKeyEvenly()

virtual void SpaceKeyEvenly ( BOOL inValue)
pure virtual

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

Parameters
[in]inValueWhen true, spaces evenly in value.

◆ RelaxKeys()

virtual void RelaxKeys ( BOOL toLin)
pure virtual

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

Parameters
[in]toLinWhen true, aligns the keys between the first and last keys of the selection

◆ FlattenKeys()

virtual void FlattenKeys ( BOOL toLeft)
pure virtual

Flattens the selected keys to the first selected key value.

Parameters
[in]toLeftWhen true, flattens the selected keys to the value of the last selected one.

◆ AverageKeys()

virtual void AverageKeys ( BOOL weld)
pure virtual

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

Parameters
[in]weldWhen true, welds the selected keys.