#include <c4d_canimation.h>

Inheritance diagram for CTrack:

[legend]

Detailed Description

Represents an animation track.
Contains curves holding keys.
Example: Creating Align to Spline tag and adding track with 2 keys:

// Add align to spline tag to object
BaseTag* tag = op->MakeTag(Taligntospline);
if (tag)
{
  // Allocate track for align to spline tag
  CTrack* track = CTrack::Alloc(tag, ConstDescID(DescLevel(ALIGNTOSPLINETAG_POSITION)));
  if (track)
  {
    // Add track to align to spline tag
    tag->InsertTrackSorted(track);
 
    // Get track curve
    CCurve* curve = track->GetCurve();
    if (curve!=nullptr)
    {
      // Add first key
      CKey* key = curve->AddKey(BaseTime(0.0));
      key->SetValue(curve, 0.0);
      // Add second key
      key = curve->AddKey(BaseTime(1.0));
      key->SetValue(curve, 0.9);
    }
  }
}

Note: Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Private Member Functions
	CTrack ()

	~CTrack ()

Alloc/Free
static CTrack *	Alloc (BaseList2D *bl, const DescID &id)

static void	Free (CTrack *&bl)

Navigation
CTrack *	GetNext () const

CTrack *	GetPred () const

Description ID
const DescID &	GetDescriptionID () const

Bool	SetDescriptionID (BaseList2D *object, const DescID &id)

Before/After Loop
CLOOP	GetBefore () const

void	SetBefore (CLOOP type)

CLOOP	GetAfter () const

void	SetAfter (CLOOP type)

Time Track
CTrack *	GetTimeTrack (BaseDocument *doc)

void	SetTimeTrack (CTrack *track)

Miscellaneous
Bool	AnimateTrack (const BaseDocument doc, BaseList2D op, const BaseTime &tt, ANIMATEFLAGS flags, Bool chg, void data=nullptr)

Bool	Animate (const CAnimInfo info, Bool chg, void *data=nullptr)

Bool	Draw (GeClipMap *map, const BaseTime &clip_left, const BaseTime &clip_right) const

Bool	FillKey (BaseDocument doc, BaseList2D bl, CKey *key)

void	FlushData ()

CCurve *	GetCurve (CCURVE type=CCURVE::CURVE, Bool bCreate=true)

const CCurve *	GetCurve (CCURVE type=CCURVE::CURVE) const

Int32	GetTrackCategory () const

const BaseList2D *	GetObject () const

BaseList2D *	GetObject ()

Float	GetValue (const BaseDocument *doc, const BaseTime &time) const

Int32	GetUnit (Float *step)

const BaseContainer *	GetParameterDescription (BaseContainer &temp) const

Int32	GuiMessage (const BaseContainer &msg, BaseContainer &result)

Bool	Remap (Float64 time, Float64 ret_time, Int32 ret_cycle) const

Bool	TrackInformation (BaseDocument doc, CKey key, maxon::String *str, Bool set)

CURVEINTERPOLATION_MODE	GetEvaluationMode () const

void	SetEvaluationMode (CURVEINTERPOLATION_MODE mode)

height
Int32	GetHeight () const

Int32	GetTLHeight (Int32 id) const

void	SetTLHeight (Int32 id, Int32 size)

Synchronization
Bool	IsSynchronized () const

void	SetSynchronized (Bool synch)

Additional Inherited Members
Public Member Functions inherited from BaseList2D
void	SetBit (Int32 mask)

Bool	GetBit (Int32 mask) const

void	DelBit (Int32 mask)

void	ToggleBit (Int32 mask)

Int32	GetAllBits () const

void	SetAllBits (Int32 bits)

void	SetBitEx (Int32 mask, Int32 flags)

const Char *	GetViewportRenderId (VIEWPORT_RENDER_ID typeId) const

BaseList2D *	GetNext ()

const BaseList2D *	GetNext () const

BaseList2D *	GetPred ()

const BaseList2D *	GetPred () const

BaseContainer	GetData ()

void	SetData (const BaseContainer &bc, Bool add=true)

const BaseContainer &	GetDataInstanceRef () const

BaseContainer &	GetDataInstanceRef ()

const BaseContainer *	GetDataInstance () const

BaseContainer *	GetDataInstance ()

String	GetName () const

void	SetName (const maxon::String &name, Bool setDirty=true)

String	GetBubbleHelp ()

Bool	TransferGoal (BaseList2D *dst, Bool undolink)

Bool	TransferMarker (BaseList2D *dst) const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	Scale (Float scale)

Bool	Edit ()

void	GetIcon (IconData *dat)

GeListHead *	GetNLARoot (Bool create)

BaseList2D *	AnimationLayerRemap (BaseObject **layer=nullptr)

String	GetTypeName () const

const BaseList2D *	GetMain () const

BaseList2D *	GetMain ()

void	InsertTrackSorted (CTrack *track)

Bool	AddEventNotification (BaseList2D bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer data)

Bool	RemoveEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	FindEventNotification (const BaseDocument doc, BaseList2D bl, NOTIFY_EVENT eventid)

Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)

DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const

GeListHead *	GetOverrideRoot (Bool create)

BaseOverride *	GetFirstOverride ()

GeListHead *	GetShaderRepositoryRoot (Bool create)

GeListHead *	GetHiddenShaderRoot (Bool create)

maxon::NimbusForwardRef	GetNimbusRef (const maxon::Id &spaceId) const

maxon::Result< maxon::NimbusForwardRef >	PrivateGetOrCreateNimbusRef (const maxon::Id &spaceId)

void	RemoveNimbusRef (const maxon::Id &spaceId)

maxon::Result< maxon::HashMap< maxon::Id, maxon::NimbusForwardRef > >	GetAllNimbusRefs () const

Bool	IsNodeBased () const

maxon::Result< Bool >	GetAccessedObjects (METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsRec (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, Bool withSiblings, Bool withChildren, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfChildren (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< Bool >	GetAccessedObjectsOfFirstChildHierarchy (ACCESSED_OBJECTS_MASK read, ACCESSED_OBJECTS_MASK write, METHOD_ID method, AccessedObjectsCallback &access) const

maxon::Result< maxon::GenericData >	GroupChanges ()

void	GetMarkerStampEx (UInt32 l1, UInt32 l2)

const GeMarker &	GetMarker () const

void	SetMarker (const GeMarker &m)

Bool	AddUniqueID (Int32 appid, const Char *const mem, Int bytes)

Bool	FindUniqueID (Int32 appid, const Char *&mem, Int &bytes) const

Int32	GetUniqueIDCount () const

Bool	GetUniqueIDIndex (Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const

Bool	SetAnimatedParameter (const CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)

Bool	GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags) const

BaseShader *	GetFirstShader () const

void	InsertShader (BaseShader shader, BaseShader pred=nullptr)

void	ClearKeyframeSelection ()

Bool	FindKeyframeSelection (const DescID &id)

Bool	SetKeyframeSelection (const DescID &id, Bool selection)

Bool	KeyframeSelectionContent ()

LayerObject *	GetLayerObject (const BaseDocument *doc)

const LayerObject *	GetLayerObject (const BaseDocument *doc) const

Bool	SetLayerObject (const LayerObject *layer)

const LayerData *	GetLayerData (const BaseDocument *doc, Bool rawdata=false) const

Bool	SetLayerData (BaseDocument *doc, const LayerData &data)

GeListHead *	GetCTrackRoot (Bool create)

const GeListHead *	GetCTrackRoot () const

const CTrack *	GetFirstCTrack () const

CTrack *	GetFirstCTrack ()

const CTrack *	FindCTrack (const DescID &id) const

CTrack *	FindCTrack (const DescID &id)

Public Member Functions inherited from GeListNode
GeListNode *	GetNext ()

const GeListNode *	GetNext () const

GeListNode *	GetPred ()

const GeListNode *	GetPred () const

GeListNode *	GetDown ()

const GeListNode *	GetDown () const

GeListNode *	GetUp ()

const GeListNode *	GetUp () const

GeListNode *	GetDownLast ()

const GeListNode *	GetDownLast () const

void	InsertBefore (GeListNode *bl)

void	InsertAfter (GeListNode *bl)

void	InsertUnder (GeListNode *bl)

void	InsertUnderLast (GeListNode *bl)

void	Remove ()

void	FlushChilds ()

void	MoveChildrenTo (GeListNode *dest)

GeListHead *	GetListHead ()

const GeListHead *	GetListHead () const

Int32	GetNodeID (Int32 index=0) const

template<typename CAST >
const CAST *	GetNodeData (Int32 index=0) const

template<typename CAST >
CAST *	GetNodeData (Int32 index=0)

void	SetCustomData (GeListNode *node)

GeListNode *	GetCustomData ()

const GeListNode *	GetCustomData () const

const BaseDocument *	GetDocument () const

BaseDocument *	GetDocument ()

maxon::Result< Bool >	GetBranchInfo (const maxon::ValueReceiver< const BranchInfo & > &info, GETBRANCHINFO flags) const

Bool	IsDocumentRelated () const

Int32	GetInfo () const

Bool	GetNBit (NBIT bit) const

UInt32	GetNBitMask (Int32 index) const

Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)

Public Member Functions inherited from C4DAtomGoal
Bool	HasLinks () const

Public Member Functions inherited from C4DAtom
Int32	GetType () const

Int32	GetRealType () const

Int32	GetDiskType () const

Bool	IsInstanceOf (Int32 id) const

Int32	GetClassification () const

Bool	Message (Int32 type, void *data=nullptr)

Bool	MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)

C4DAtom *	GetClone (COPYFLAGS flags, AliasTrans *trn) const

Bool	CopyTo (C4DAtom dst, COPYFLAGS flags, AliasTrans trn) const

Bool	Read (HyperFile *hf, Int32 id, Int32 level)

Bool	Write (HyperFile *hf) const

Bool	ReadObject (HyperFile *hf, Bool readheader)

Bool	WriteObject (HyperFile *hf) const

Bool	GetDescription (Description *description, DESCFLAGS_DESC flags) const

Bool	GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags) const

Bool	SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)

DynamicDescription *	GetDynamicDescriptionWritable ()

const DynamicDescription *	GetDynamicDescription () const

Bool	CopyDynamicDescriptionFrom (const BaseList2D *src)

Bool	GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc) const

Bool	TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)

UInt32	GetDirty (DIRTYFLAGS flags) const

void	SetDirty (DIRTYFLAGS flags)

UInt32	GetHDirty (HDIRTYFLAGS mask) const

void	SetHDirty (HDIRTYFLAGS mask)

Static Public Member Functions inherited from BaseList2D
static BaseList2D *	Alloc (Int32 type)

static void	Free (BaseList2D *&bl)

Static Public Attributes inherited from BaseList2D
static const Int32	SETBIT_FLAG_NODIRTY

static const Int32	SETBIT_FLAG_REMOVE

Constructor & Destructor Documentation

◆ CTrack()

CTrack ( )

private

◆ ~CTrack()

~CTrack ( )

private

Member Function Documentation

◆ Alloc()

static CTrack* Alloc	(	BaseList2D *	bl,
		const DescID &	id
	)

static

Allocates a track. Destroy the allocated track with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in]	bl	The object to allocate the track for.
[in]	id	The description ID to allocate the track for. For instance a position track is allocated with: CTrack::Alloc(op, ConstDescID(DescLevel(ID_BASEOBJECT_POSITION, DTYPE_VECTOR, 0), DescLevel(VECTOR_X, DTYPE_REAL, 0))) DTYPE_VECTOR @ DTYPE_VECTOR Vector Definition: lib_description.h:70 DTYPE_REAL @ DTYPE_REAL Float Definition: lib_description.h:68 VECTOR_X @ VECTOR_X X component. Definition: lib_description.h:279 A track of type LONG is allocated with: CTrack::Alloc(op, DescLevel(ID_BASEOBJECT_VISIBILITY_EDITOR, DTYPE_LONG, 0)) DTYPE_LONG @ DTYPE_LONG Int32 Definition: lib_description.h:67 ID_BASEOBJECT_VISIBILITY_EDITOR @ ID_BASEOBJECT_VISIBILITY_EDITOR Definition: obase.h:10 Plugin and special tracks are allocated passing the ID: CTrack::Alloc(op, DescLevel(ID, ID, 0)) IDs for Cinema 4D's special tracks are: TrackTypes

Returns: The allocated track, or nullptr if the allocation failed.

◆ Free()

static void Free ( CTrack *& bl )

static

Destructs tracks allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in] bl The track to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆ GetNext()

CTrack* GetNext ( ) const

Gets the next track in the list. Convenience version of GeListNode::GetNext()

Returns: The next track, or nullptr if there is none. Cinema 4D owns the pointed track.

◆ GetPred()

CTrack* GetPred ( ) const

Gets the previous track in the list. Convenience version of GeListNode::GetPred()

Returns: The previous track, or nullptr if there is none. Cinema 4D owns the pointed track.

◆ GetDescriptionID()

const DescID& GetDescriptionID ( ) const

Gets the description ID of the track.

Returns: The description ID.

◆ SetDescriptionID()

Bool SetDescriptionID	(	BaseList2D *	object,
		const DescID &	id
	)

Sets the description ID of the track.

Parameters

[in]	object	The object for the track. The caller owns the pointed object.
[in]	id	The description ID of the track to set.

Returns: true if successful, otherwise false.

◆ GetBefore()

CLOOP GetBefore ( ) const

Gets the pre-track loop type.

Returns: The before loop type.

◆ SetBefore()

void SetBefore ( CLOOP type )

Sets the pre-track loop type.

Parameters

[in] type The before loop type to set.

◆ GetAfter()

CLOOP GetAfter ( ) const

Gets the post-track loop type.

Returns: The after loop type.

◆ SetAfter()

void SetAfter ( CLOOP type )

Sets the post-track loop type.

Parameters

[in] type The after loop type to set.

◆ GetTimeTrack()

CTrack* GetTimeTrack ( BaseDocument * doc )

Gets the time track.

Parameters

[in] doc The document for the operation.

Returns: The time track.

◆ SetTimeTrack()

void SetTimeTrack ( CTrack * track )

Sets the time track.

Parameters

[in] track The time track to set.

◆ AnimateTrack()

Bool AnimateTrack	(	const BaseDocument *	doc,
		BaseList2D *	op,
		const BaseTime &	tt,
		ANIMATEFLAGS	flags,
		Bool *	chg,
		void *	data = `nullptr`
	)

Internal.

◆ Animate()

Bool Animate	(	const CAnimInfo *	info,
		Bool *	chg,
		void *	data = `nullptr`
	)

Internal.

◆ Draw()

Bool Draw	(	GeClipMap *	map,
		const BaseTime &	clip_left,
		const BaseTime &	clip_right
	)		const

Draws the track into a clip map, if drawing is supported.

Parameters

[out]	map	The clip map to draw into. The caller owns the pointed clip map.
[in]	clip_left	The left clipping.
[in]	clip_right	The right clipping.

Returns: true if the track was drawn, otherwise false.

◆ FillKey()

Bool FillKey	(	BaseDocument *	doc,
		BaseList2D *	bl,
		CKey *	key
	)

Fills key with default values.

Parameters

[in]	doc	The document. The caller owns the pointed document.
[in]	bl	The base list of the key to fill. The caller owns the pointed object.
[out]	key	The key to fill. The caller owns the pointed key.

Returns: true if key was filled, otherwise false.

◆ FlushData()

void FlushData ( )

Flushes the data.

Note: Empties and resets sequence data but not the keys.

◆ GetCurve() [1/2]

CCurve* GetCurve	(	CCURVE	type = `CCURVE::CURVE`,
		Bool	bCreate = `true`
	)

Gets a curve of the track.

Parameters

[in]	type	The curve type: CCURVE
[in]	bCreate	If true a curve is created if none exists.

Returns: The curve. Can be nullptr if type is something else than CCURVE::CURVE.

◆ GetCurve() [2/2]

const CCurve* GetCurve ( CCURVE type = CCURVE::CURVE ) const

Gets a curve of the track.

Parameters

[in] type The curve type: CCURVE

Returns: The curve. Can be nullptr if type is something else than CCURVE::CURVE.

◆ GetTrackCategory()

Int32 GetTrackCategory ( ) const

Gets the track category.

Returns: The track category: CTRACK_CATEGORY.

◆ GetObject() [1/2]

const BaseList2D* GetObject ( ) const

Gets the host object of the track.

Returns: The host object, or nullptr.

◆ GetObject() [2/2]

BaseList2D* GetObject ( )

Gets the host object of the track.

Returns: The host object, or nullptr.

◆ GetValue()

Float GetValue	(	const BaseDocument *	doc,
		const BaseTime &	time
	)		const

Gets the value of the track at time.

Parameters

[in]	doc	The document for the track.
[in]	time	The time.

Returns: The track value.

◆ GetUnit()

Int32 GetUnit ( Float * step )

Gets the unit and step of the track.

Parameters

[out] step Assigned the step.

Returns: The unit: UNIT

◆ GetParameterDescription()

const BaseContainer* GetParameterDescription ( BaseContainer & temp ) const

Private.

◆ GuiMessage()

Int32 GuiMessage	(	const BaseContainer &	msg,
		BaseContainer &	result
	)

Sends a GUI message to the track.

See also: The article GUI Messages for more information.

Parameters

[in]	msg	The GUI message container.
[out]	result	The result container.

Returns: The result.

◆ Remap()

Bool Remap	(	Float64	time,
		Float64 *	ret_time,
		Int32 *	ret_cycle
	)		const

Remaps time.

Parameters

[in]	time	The input time.
[out]	ret_time	The output time.
[out]	ret_cycle	The output cycle.

Returns: true if time was remapped, otherwise false.

◆ TrackInformation()

Bool TrackInformation	(	BaseDocument *	doc,
		CKey *	key,
		maxon::String *	str,
		Bool	set
	)

Gets or sets track information at the current time, or at key if specified.
The information in str is displayed in tooltips etc.

Parameters

[in]	doc	The document. The caller owns the pointed document.
[in]	key	The optional key. The caller owns the pointed key.
[in,out]	str	The information string to get or set. The caller owns the pointed string.
[in]	set	If true the information is set, otherwise it is retrieved.

Returns: true if track information was retrieved or set, otherwise false.

◆ GetHeight()

Int32 GetHeight ( ) const

Gets the height of the track.

Returns: The height of the track in pixels.

◆ GetTLHeight()

Int32 GetTLHeight ( Int32 id ) const

Gets the height of the mini F-Curves in the Timeline.

Parameters

[in] id Pass a value between 0-3 for one of the four Timelines.

Returns: The height of the mini F-curve in pixels.

◆ SetTLHeight()

void SetTLHeight	(	Int32	id,
		Int32	size
	)

Sets the height of the mini F-Curves in the Timeline.

Parameters

[in]	id	Pass a value between 0-3 for one of the four Timelines.
[in]	size	The new size of the mini F-Curves in pixels.

◆ IsSynchronized()

Bool IsSynchronized ( ) const

Checks if keys are synchronized with other Component tracks (Vector Track only).

Since: R18

Returns: true if track is synchronized, otherwise false.

◆ SetSynchronized()

void SetSynchronized ( Bool synch )

Sets synchronization between component Track (Vector Track only).

Since: R18

Parameters

[in] synch true if Track needs to be synchronized, otherwise false.

◆ GetEvaluationMode()

CURVEINTERPOLATION_MODE GetEvaluationMode ( ) const

Gets evaluation mode.

Since: S24

Returns: interpolation mode.

◆ SetEvaluationMode()

void SetEvaluationMode ( CURVEINTERPOLATION_MODE mode )

Sets evaluation mode.

Since: S24

Parameters

[in] mode curve interpolation mode.

Detailed Description

Private Member Functions

Alloc/Free

Navigation

Description ID

Before/After Loop

Time Track

Miscellaneous

height

Synchronization

Additional Inherited Members

Constructor & Destructor Documentation

◆ CTrack()

◆ ~CTrack()

Member Function Documentation

◆ Alloc()

◆ Free()

◆ GetNext()

◆ GetPred()

◆ GetDescriptionID()

◆ SetDescriptionID()

◆ GetBefore()

◆ SetBefore()

◆ GetAfter()

◆ SetAfter()

◆ GetTimeTrack()

◆ SetTimeTrack()

◆ AnimateTrack()

◆ Animate()

◆ Draw()

◆ FillKey()

◆ FlushData()

◆ GetCurve() [1/2]

◆ GetCurve() [2/2]

◆ GetTrackCategory()

◆ GetObject() [1/2]

◆ GetObject() [2/2]

◆ GetValue()

◆ GetUnit()

◆ GetParameterDescription()

◆ GuiMessage()

◆ Remap()

◆ TrackInformation()

◆ GetHeight()

◆ GetTLHeight()

◆ SetTLHeight()

◆ IsSynchronized()

◆ SetSynchronized()

◆ GetEvaluationMode()

◆ SetEvaluationMode()