BaseSequence

Description

An animation sequence base class.

Definition

class BaseSequence : BaseList2D
{
public:
  [BaseTrack] GetTrack();

  [BaseKey] GetFirstKey();
  [TimeKey] GetFirstTimeKey();

  [bool] InsertKey([BaseKey] key);
  [bool] InsertTimeKey([TimeKey] key);

  [BaseTime] GetT1();
  [BaseTime] GetT2();
  [BaseTime] GetT3();

  [bool] GetSoft();
  [bool] GetLeftInfluence();
  [bool] GetRightInfluence();

  [int] GetTimeMode();
  [float] GetV0();
  [float] GetS0();

  [BaseTime] GetLeft();
  [BaseTime] GetRight();

  [bool] SetT1([BaseTime] t);
  [bool] SetT2([BaseTime] t);
  [bool] SetT3([BaseTime] t);

  [bool] SetSoft([bool] s);
  [bool] SetLeftInfluence([bool] l);
  [bool] SetRightInfluence([bool] r);

  [bool] SetTimeMode([int] mode);
  [bool] SetV0([float] v0);
  [bool] SetS0([float] s0);
  
  [BaseContainer] GetContainer();
  [bool] SetContainer([BaseContainer] bc);  
    
  [bool] CopyTo([BaseSequence] dest);
  [BaseSequence] GetClone();
}

Explanation

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

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

Members

GetTrack()

[BaseTrack] GetTrack();

Returns the track that the sequence is attached to, or NULL if the sequence is loose.

GetFirstKey()

[BaseKey] GetFirstKey();

Returns the first key of the sequence, or NULL if there are no keys.

GetFirstTimeKey()

[TimeKey] GetFirstTimeKey();

Returns the first time curve key of the sequence, or NULL if there is no time curve.

InsertKey( key )

[bool] InsertKey([BaseKey] key);

Inserts key into the sequence at the time specified in the BaseKey class. Returns TRUE if successful.

InsertTimeKey( key )

[bool] InsertTimeKey([TimeKey] key);

Inserts key into the sequence's time curve at the x time specified in the TimeKey class. Return TRUE if successful.

GetT1()

[BaseTime] GetT1();

Returns the start time of the sequence.

GetT2()

[BaseTime] GetT2();

Returns the end time of the sequence excluding loops.

GetT3()

[BaseTime] GetT3();

Returns the end time of the sequence including loops.

GetSoft()

[bool] GetSoft();

Returns the state of the sequence's soft option.

GetLeftInfluence()

[bool] GetLeftInfluence();

Returns the state of the sequence's left influence option.

GetRightInfluence()

[bool] GetRightInfluence();

Returns the state of the sequence's right influence option.

GetTimeMode()

[int] GetTimeMode();

Returns the mode of the sequence's time curve. Possible values are:

Value Meaning

0 Position

1 Velocity

2 Acceleration

GetV0()

[float] GetV0();

Returns the velocity integration constant of the sequence's time curve.

GetS0()

[float] GetS0();

Returns the position integration constant of the sequence's time curve.

GetLeft()

[BaseTime] GetLeft();

Returns the time of the first key of the sequence. If there are no keys, the start time of the sequence will be returned.

GetRight()

[BaseTime] GetRight();

Returns the time of the last key of the sequence. If there are no keys, the end time of the sequence will be returned.

SetT1( t )

[bool] SetT1([BaseTime] t);

Sets the start time of the sequence to t. Returns TRUE if successful.

SetT2( t )

[bool] SetT2([BaseTime] t);

Sets the end time of the sequence, excluding loops, to t. Returns TRUE if successful.

SetT3( t )

[bool] SetT3([BaseTime] t);

Sets the end time of the sequence, including loops, to t. Returns TRUE if successful.

SetSoft( s )

[bool] SetSoft([bool] s);

Sets the sequence's soft option to s. Returns TRUE if successful.

SetLeftInfluence( l )

[bool] SetLeftInfluence([bool] l);

Sets the sequence's left influence option to l. Returns TRUE if successful.

SetRightInfluence( r )

[bool] SetRightInfluence([bool] r);

Sets the sequence's right influence option to l. Returns TRUE if successful.

SetTimeMode( mode )

[bool] SetTimeMode([int] mode);

Sets the mode of the sequence's time curve to mode. Possible values are:

Value Meaning

0 Position

1 Velocity

2 Acceleration

Returns TRUE if successful.

SetV0( v0 )

[bool] SetV0([float] v0);

Sets the velocity integration constant of the sequence's time curve to v0. Returns TRUE if successful.

SetS0( s0 )

[bool] SetS0([float] s0);

Sets the position integration constant of the sequence's time curve to v0. Returns TRUE if successful.

GetContainer()

[BaseContainer] GetContainer();

Returns the sequence's container.

SetContainer( bc )

[bool] SetContainer([BaseContainer] bc);

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

CopyTo( dest )

[bool] CopyTo([BaseSequence] dest);

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

GetClone()

[BaseSequence] GetClone();

Returns a clone of the sequence.