c4d.CTrack

This is the animation track base class. Contains CCurve that contain CKeys. A BaseList2D can host a CTrack object. This can be the position, rotation or custom value track. These tracks contain a CCurve which contains CKeys.

Definition

class c4d.CTrack

• CTrack.__init__()

• CTrack.GetDescriptionID()
• CTrack.SetDescriptionID()

• CTrack.GetObject()
• CTrack.GetTrackCategory()
• CTrack.GetCurve()

• CTrack.GetBefore()
• CTrack.GetAfter()

• CTrack.SetBefore()
• CTrack.SetAfter()

• CTrack.FlushData()

• CTrack.GetValue()
• CTrack.Remap()
• CTrack.FillKey()

• CTrack.GetHeight()
• CTrack.GetUnit()

• CTrack.GetTLHeight()
• CTrack.SetTLHeight()

Inheritance

• c4d.BaseList2D

  • c4d.CTrack

Members

CTrack.__init__(bl, id)

Allocates a track object.

Parameters:

• bl (BaseList2D) – Object to allocate the track for.
• id (DescID) – Description ID to allocate the track for.

For instance a position track will be allocated like this:

tr=c4d.CTrack(op, c4d.DescID(c4d.DescLevel(c4d.ID_BASEOBJECT_POSITION, c4d.DTYPE_VECTOR, 0), c4d.DescLevel(c4d.VECTOR_X, c4d.DTYPE_REAL, 0)))

A track of type int will be allocated like this:

tr=c4d.CTrack(op, c4d.DescID(c4d.DescLevel(c4d.ID_BASEOBJECT_VISIBILITY_EDITOR, c4d.DTYPE_LONG, 0, )))

For a plugin and special tracks you pass the ID:

tr=c4d.CTrack(op,c4d.DescLevel(ID, ID, 0))

IDs for CINEMA’s special tracks are:

CTpla	PLA track.
CTsound	Sound track.
CTmorph	Morph track.
CTtime	Time track.

CTrack.GetDescriptionID()

Retrieve the description ID of this track.

Return type:DescID Returns:The description ID.

CTrack.SetDescriptionID(object, id)

Set the description ID of this track.

Parameters:

• object (BaseList2D) – Object for the new description ID.
• id (DescID) – New description ID.

Return type:

bool

Returns:

True if successful, otherwise False.

CTrack.GetCurve()

Get a curve of this track.

Return type:CCurve Returns:The curve of this track.

CTrack.GetTrackCategory()

Get a curve of this track.

Return type:int Returns:Track category

CTRACK_CATEGORY_VALUE	Value track.
CTRACK_CATEGORY_DATA	Data track.
CTRACK_CATEGORY_PLUGIN	Plugin track.

CTrack.GetObject()

Get the host object of this track.

Return type:BaseList2D Returns:The host object or None.

CTrack.GetBefore()

Get the pre track loop type of this track.

Return type:int Returns:Loop type:

CLOOP_OFF	No loop.
CLOOP_CONSTANT	Constant
CLOOP_CONTINUE	Continue.
CLOOP_REPEAT	Repeat.
CLOOP_OFFSETREPEAT	Offset repeat
CLOOP_OSCILLATE	Oscillate

CTrack.GetAfter()

Get the pre track loop type of this track.

Return type:int Returns:Loop type:

CLOOP_OFF	No loop.
CLOOP_CONSTANT	Constant
CLOOP_CONTINUE	Continue.
CLOOP_REPEAT	Repeat.
CLOOP_OFFSETREPEAT	Offset repeat
CLOOP_OSCILLATE	Oscillate

CTrack.SetBefore(type)

Set the pre track loop type of this track.

Parameters:type (int) –

Loop type:

CLOOP_OFF	No loop.
CLOOP_CONSTANT	Constant
CLOOP_CONTINUE	Continue.
CLOOP_REPEAT	Repeat.
CLOOP_OFFSETREPEAT	Offset repeat
CLOOP_OSCILLATE	Oscillate

CTrack.SetAfter(type)

Set the post track loop type of this track.

Parameters:type (int) –

Loop type:

CLOOP_OFF	No loop.
CLOOP_CONSTANT	Constant
CLOOP_CONTINUE	Continue.
CLOOP_REPEAT	Repeat.
CLOOP_OFFSETREPEAT	Offset repeat
CLOOP_OSCILLATE	Oscillate

CTrack.FlushData()

Clears the data of the track itself, for example removes time curves, pre/post loop type, etc.

CTrack.GetValue(doc, time, fps)

Retrieve the value of this track at time.

Parameters:

• doc (BaseDocument) – The document.
• time (BaseTime) – The time.
• fps (int) – The number of frames per second.

Return type:

float

Returns:

The value.

CTrack.Remap()

Remaps time.

Parameters:time (BaseTime) – The time. Return type:dict{ret_time: float, ret_cycle: int} Returns:The output time and cycle or None if time could not be remapped.

CTrack.FillKey(doc, bl, key)

Fills key with default values.

Parameters:

• doc (BaseDocument) – The document.
• bl (BaseList2D) – The object of the key to fill.
• key (CKey) – The key to fill.

Return type:

bool

Returns:

True if successful, otherwise False.

CTrack.GetHeight()

Get the height of the track.

Return type:int Returns:The height in pixels.

CTrack.GetUnit()

Get the unit and step of the track.

Return type:tuple(int, float) Returns:The unit and the step. The units:

UNIT_NONE	No units.
UNIT_KM	Kilometers.
UNIT_M	Meter.
UNIT_CM	Centimeter.
UNIT_MM	Millimeter.
UNIT_UM	Micrometer.
UNIT_NM	Nanometer.
UNIT_MILE	Mile.
UNIT_YARD	Yards.
UNIT_FEET	Feet.
UNIT_INCH	Inches.

CTrack.GetTLHeight(id)

Get the height of the mini f-curves in the timeline.

Parameters:id (int) – 0-3 for one of the four timelines. Return type:int Returns:The height of the mini f-curve in pixels.

CTrack.SetTLHeight(id, size)

Get the height of the track.

Parameters:

• id (int) – 0-3 for one of the four timelines.
• size (int) – The new size of the mini f-curve in pixels.