3ds Max C++ API Reference
|
Holds an Animatable handle, its clients handle and the subanim index such that: client->SubAnim(index) == anim. More...
#include <TreeEntry.h>
Public Member Functions | |
TreeEntry (Animatable *a, Animatable *c, int s) | |
Constructor for a TreeEntry. | |
virtual | ~TreeEntry () |
const Animatable * | GetAnim () const |
Animatable * | GetAnim () |
void | SetAnim (Animatable *anim) |
AnimHandle | GetAnimHandle () const |
const Animatable * | GetClient () const |
Animatable * | GetClient () |
void | SetClient (Animatable *client) |
AnimHandle | GetClientHandle () const |
int | GetSubNum () const |
void | SetSubNum (int n) |
TSTR | GetDisplayName (bool showType) const |
Get the name of this entry to display in the UI. | |
SClass_ID | GetEntrySuperClassID () |
Determine the super class id, pulls type from paramblocks otherwise straight from the anim. | |
bool | IsEaseCurve () const |
Returns true if this entry describes an easy curve controller. | |
bool | IsMultCurve () const |
Returns true if this entry describes a multiplier curve controller. | |
bool | IsNoteTrack () const |
Returns true if this entry describes a note track. | |
bool | IsVisTrack () const |
Returns true if this entry describes a visibility controller. | |
bool | IsNode () const |
Returns true if this entry describes a scene node. | |
bool | IsObject () const |
Returns true if this entry describes an object: geometry, camera, shape, helper, etc. | |
bool | IsModifier () const |
Returns true if this entry describes a modifier. | |
bool | IsMtlBased () const |
Returns true if this entry or client describes a material or texmap. | |
virtual bool | HasSubs () const |
Returns true if this entry has any sub animatables. | |
bool | IsPBlockDummy () const |
Returns true if the entry represents a paramblock dummy. | |
bool | IsPBlockDummy (SClass_ID &sid) const |
Returns true if the entry represents a paramblock dummy. If true, 'sid' will be set to the dummy's parameter super class id. | |
bool | IsLocked () |
Returns true if this entry is locked by the locked tracks manager (ILockedTracksMan ). | |
bool | IsParameterWired () |
Returns true if this entry is a source or destination of a parameter wire. | |
bool | IsPBlockDummyAnimatable () const |
Returns true if this entry is able to be animated. | |
bool | IsCustomAttribute () const |
Returns true if this entry describes a custom attribute. | |
bool | operator== (TreeEntry const &other) const |
Protected Attributes | |
AnimHandle | mAnim |
AnimHandle | mClient |
int | subNum |
Holds an Animatable handle, its clients handle and the subanim index such that: client->SubAnim(index) == anim.
Provides a series of useful methods to work with Animatables. A valid TreeEntry can be just an animatable or just a client and subanim. Safely stores the animatables as handles to avoid dangling pointers. Used by the trackviews tree view.
|
inline |
Constructor for a TreeEntry.
a | The target Animatable. |
c | The Animatables client (parent) in the scene. Important because most things only make sense in context with its parent. |
s | Which sub Animatable 'a' is in 'c' such that: c->SubAnim(s) == a. |
|
inlinevirtual |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
TSTR GetDisplayName | ( | bool | showType | ) | const |
Get the name of this entry to display in the UI.
showType | Whether or not to show the controller type in the name. |
SClass_ID GetEntrySuperClassID | ( | ) |
Determine the super class id, pulls type from paramblocks otherwise straight from the anim.
bool IsEaseCurve | ( | ) | const |
Returns true if this entry describes an easy curve controller.
bool IsMultCurve | ( | ) | const |
Returns true if this entry describes a multiplier curve controller.
bool IsNoteTrack | ( | ) | const |
Returns true if this entry describes a note track.
bool IsVisTrack | ( | ) | const |
Returns true if this entry describes a visibility controller.
bool IsNode | ( | ) | const |
Returns true if this entry describes a scene node.
bool IsObject | ( | ) | const |
Returns true if this entry describes an object: geometry, camera, shape, helper, etc.
bool IsModifier | ( | ) | const |
Returns true if this entry describes a modifier.
bool IsMtlBased | ( | ) | const |
Returns true if this entry or client describes a material or texmap.
|
virtual |
Returns true if this entry has any sub animatables.
bool IsPBlockDummy | ( | ) | const |
Returns true if the entry represents a paramblock dummy.
bool IsPBlockDummy | ( | SClass_ID & | sid | ) | const |
Returns true if the entry represents a paramblock dummy. If true, 'sid' will be set to the dummy's parameter super class id.
bool IsLocked | ( | ) |
Returns true if this entry is locked by the locked tracks manager (ILockedTracksMan ).
bool IsParameterWired | ( | ) |
Returns true if this entry is a source or destination of a parameter wire.
bool IsPBlockDummyAnimatable | ( | ) | const |
Returns true if this entry is able to be animated.
bool IsCustomAttribute | ( | ) | const |
Returns true if this entry describes a custom attribute.
|
inline |
|
protected |
|
protected |
|
protected |