BaseKey

Description

An animation key base class.

Definition

class BaseKey : BaseList2D
{
public:
  [BaseSequence] GetSequence();
  
  [BaseTime] GetTime();
  [bool] SetTime([BaseTime] time);
  
  [BaseContainer] GetContainer();
  [bool] SetContainer([BaseContainer] bc);
  
  [bool] CopyTo([BaseKey] dest);
  [BaseKey] GetClone();
}

Explanation

This is the animation key base class that all other animation keys are derived from.

Note: At the moment there's no way to allocate new keys with C.O.F.F.E.E..

Members

GetSequence()

[BaseSequence] GetSequence();

Returns the parent sequence of the key. If the key hasn't yet been attached to or has been removed from its sequence, NULL is returned.

GetTime()

[BaseTime] GetTime();

Returns the time of the key as a BaseTime object. This is the absolute time in the document, not relative to the sequence.

SetTime( time )

[bool] SetTime([BaseTime] time);

Sets the time of the key to time. Returns TRUE if successful.

GetContainer()

[BaseContainer] GetContainer();

Returns the key's container.

SetContainer( bc )

[bool] SetContainer([BaseContainer] bc);

Sets the key's container to bc. Returns TRUE if successful.

CopyTo( dest )

[bool] CopyTo([BaseKey] dest);

Copies the basekey to the specified destination. Returns TRUE if successful.

GetClone()

[BaseKey] GetClone();

Returns a clone of the basekey object that isn't attached to a sequence.