Class IKey

3DS Max Plug-In SDK

Class IKey

See Also: Class IKeyControl, Class Animatable.

class IKey

Description:

This is the base class for keys that are part of the controller interface. This class stores the time of the key, and some flags that describe the properties of the key.

Data Members:

public:

TimeValue time;

The time of the key.

DWORD flags;

The flag bits for keys. One or more of the following values:

General flags

IKEY_SELECTED

The key is selected.

IKEY_XSEL

In the function curve editor X is selected.

IKEY_YSEL

In the function curve editor Y is selected.

IKEY_ZSEL

In the function curve editor Z is selected.

IKEY_FLAGGED

The key is flagged. See Animatable:: FlagKey().

IKEY_TIME_LOCK

The key is locked in time so it won't move.

TCB specific key flags:

TCBKEY_QUATVALID

The quaternion TCB key has inside it both a quaternion and an angle axis. When this bit is set the angle/axis is derived from the quaternion instead of vice/versa.

Bezier specific key flags:

BEZKEY_CONSTVELOCITY

This key is interpolated using arclength as the interpolation parameter.

BEZKEY_XBROKEN

BEZKEY_YBROKEN

BEZKEY_ZBROKEN

Indicates if the tangent handles are locked together. Broken means not locked.

The following macros may be used to test and set the tangent locks:

TangentsLocked(f,j);

SetTangentLick(f,j,l);

The following macros may be used to access the hybrid tangent types:

GetInTanType(f);

GetOutTanType(f);

SetINTanType(f,t);

SetOutTanType(f,t);

Methods:

Prototype:

IKey();

Remarks:

Constructor. The time and flags are set to zero.