Timeline Marker

Detailed Description

Macros
#define	C4D_TLMARKER_LIBRARY_ID

Functions
BaseList2D *	GetFirstMarker (BaseDocument *doc)
const BaseList2D *	GetFirstMarker (const BaseDocument *doc)
BaseList2D *	AddMarker (BaseDocument *doc, BaseList2D *pPred, BaseTime time, String name, maxon::Color color=maxon::Color(), BaseTime length=BaseTime(), LayerObject *obj=nullptr)

Macro Definition Documentation

C4D_TLMARKER_LIBRARY_ID

#define C4D_TLMARKER_LIBRARY_ID

Timeline marker library ID.

Function Documentation

GetFirstMarker() [1/2]

BaseList2D* cinema::GetFirstMarker

(

BaseDocument *

doc

)

Retrieves the first timeline marker of the document.

Parameters

[in]

doc

The document. The caller owns the pointed document.

Returns

The first timeline marker. Cinema 4D owns the pointed marker.

GetFirstMarker() [2/2]

const BaseList2D* cinema::GetFirstMarker

(

const BaseDocument *

doc

)

Retrieves the first timeline marker of the document.

Parameters

[in]

doc

The document. The caller owns the pointed document.

Returns

The first timeline marker. Cinema 4D owns the pointed marker.

AddMarker()

BaseList2D* cinema::AddMarker	(	BaseDocument *	doc,
		BaseList2D *	pPred,
		BaseTime	time,
		String	name,
		maxon::Color	color = maxon::Color(),
		BaseTime	length = BaseTime(),
		LayerObject *	obj = nullptr
	)

Inserts a timeline marker into the document at a given time.
Optionally an insertion point pPred in the timeline marker list can be specified, giving the marker before the wanted insertion point.

Parameters

[in]	doc	The document. The caller owns the pointed document.
[in]	pPred	The optional timeline marker to use as list insertion point. The caller owns the pointed marker.
[in]	time	The time position of the timeline marker.
[in]	name	The name of the timeline marker.
[in]	color	The color of the timeline marker.
[in]	length	The length of the timeline marker.

Returns

The added timeline marker, or nullptr if insertion failed.