ITreeView Class Reference
ITreeView Class Referenceabstract
#include <itreevw.h>
Class Description
- See also
- Class ITreeViewOps, Class IObject, Class ITrackViewArray, Class TrackViewActionCallback, Class TrackViewFilter, Class ReferenceTarget, Class Animatable
- Description:
- While this is the main TreeView class used for trackview operations, most of the operations for TreeView's are inherited through the ITreeViewOps class.
Inheritance diagram for ITreeView:
Additional Inherited Members | |
| Public Types inherited from ITreeViewOps | |
| 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 } |
| 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 Member Functions inherited from ITreeViewOps | |
| 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) |
| Protected Attributes inherited from BaseInterfaceServer | |
| Tab< BaseInterface * > | interfaces |
| Protected Attributes inherited from FPMixinInterface | |
| Tab< InterfaceNotifyCallback * > * | interfaceNotifyCBs |
Constructor & Destructor Documentation
|
inlinevirtual |
Member Function Documentation
- Remarks
- This method will position the TreeView window at the specified position using the specified size.
- Parameters:
- int x, int y
The x and y position of the TreeView window, in screen pixels.
int w, int h
The width and height of the TreeView window, in screen pixels.
|
pure virtual |
- Remarks
- This method shows the TreeView window.
|
pure virtual |
- Remarks
- This method hides the TreeView window.
|
pure virtual |
- Remarks
- This method allows you to enquire if the TreeView window is currently visible.
- Returns
- TRUE if the TreeView window is visible, otherwise FALSE.
|
pure virtual |
- Remarks
- This method allows you to enquire whether the TreeView is being displayed in a viewport.
- Returns
- TRUE if the TreeView is displayed in a viewport, otherwise FALSE.
|
pure virtual |
- Remarks
- This method allows you to set the TreeView root which represents the initial tree branch.
- Parameters:
- ReferenceTarget *root
A pointer to a reference target to use as the root in the TreeView.
ReferenceTarget *client
A pointer to the reference target which is the root's client.
int subNum
The sub-animatable number of the root you wish to set.
|
pure virtual |
- Remarks
- This method will instruct the TreeView to show the labels only.
- Parameters:
- BOOL only
The only parameter specifies if the label only flag should be set (TRUE) or not (FALSE).
|
pure virtual |
- Remarks
- This method controls the state of the TreeView's multi-select capability and allows you to enable or disable the selection of multiple selections.
- Parameters:
- BOOL on
Set this parameter to TRUE to enable multi-select. FALSE to disable multi-select.
|
pure virtual |
- Remarks
- This method allows you to set set a TreeView selection filter which controls the amount of information displayed in the TreeView.
- Parameters:
- TrackViewFilter *f
A pointer to a trackview filter which defines the displayable sub-set.
|
pure virtual |
- Remarks
- This method allows you to activate or inactivate the treeview.
- Parameters:
- BOOL active
TRUE to activate, FALSE to deactivate.
|
pure virtual |
- Remarks
- This method returns whether the TreeView is active (TRUE) or inactive (FALSE).
|
pure virtual |
- Remarks
- This method returns the handle to the TreeView window.
- Remarks
- This method
This method returns the parent index of a specific TrackView entry. If no parent is found, -1 will be returned.
- Parameters:
- int index
The index of the TrackView entry for which to return the parent index.
|
pure virtual |
- Remarks
- This method will flush the TreeView and resets its size to 0.
|
pure virtual |
- Remarks
- This method will recalculate the sub-tree and signal the list has changed.
|
pure virtual |
- Remarks
- This method will set the material browser flag.
|
pure virtual |
- Remarks
- This method returns the TrackView ID.
|
inlinevirtual |
|
inlinevirtual |
virtual UtilExport int NumInterfaces() const
|
inlinevirtual |
Definition: itreevw.h:197
virtual UtilExport BaseInterface * GetInterfaceAt(int i) const
|
inlinevirtual |
- Remarks
- This method returns a pointer to the BaseInterface of the specified interface.
- Parameters:
- Interface_ID id
The interface ID for which to return the BaseInterface.
Reimplemented from BaseInterfaceServer.
Definition: baseinterface.h:67
virtual UtilExport BaseInterface * GetInterface(Interface_ID id)