Document

Functions
BaseDocument *	LoadDocument (const Filename &name, SCENEFILTER loadflags)
Bool	MergeDocument (BaseDocument *doc, const Filename &name, SCENEFILTER loadflags)
Bool	SaveDocument (BaseDocument *doc, const Filename &name, SAVEDOCUMENTFLAGS saveflags)
BaseList2D *	GetFirstMarker (BaseDocument *doc)
BaseList2D *	AddMarker (BaseDocument *doc, BaseList2D *pPred, BaseTime time, String name)

Detailed Description

Function Documentation

LoadDocument()

BaseDocument* cineware::LoadDocument	(	const Filename &	name,
		SCENEFILTER	loadflags
	)

Loads a document.

Parameters

[in]	name	File to load the document from.The caller owns the pointed document.
[in]	loadflags	Flags for the load.

Returns

The document that was loaded, or nullptr if it failed.

MergeDocument()

Bool cineware::MergeDocument	(	BaseDocument *	doc,
		const Filename &	name,
		SCENEFILTER	loadflags
	)

Merges the file name with the document doc.

Parameters

[in]	doc	The document to merge the loaded scene into. The caller owns the pointed document.
[in]	name	File to load the merge document from.
[in]	loadflags	Flags for the load.

Returns

Success of mering.

SaveDocument()

Bool cineware::SaveDocument	(	BaseDocument *	doc,
		const Filename &	name,
		SAVEDOCUMENTFLAGS	saveflags
	)

Saves a document to a file.

Parameters

[in]	doc	The document to save to a file. The caller owns the pointed document.
[in]	name	File to save the document to.
[in]	saveflags	Flags for the save.

Returns

Success of saving.

GetFirstMarker()

BaseList2D* cineware::GetFirstMarker

(

BaseDocument *

doc

)

Retrieves the first timeline marker of the document.

Since

17.008

Parameters

[in]

doc

The document. The caller owns the pointed document.

Returns

The first timeline marker. Cineware SDK owns the pointed marker.

AddMarker()

BaseList2D* cineware::AddMarker	(	BaseDocument *	doc,
		BaseList2D *	pPred,
		BaseTime	time,
		String	name
	)

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.

Since

17.008

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.

Returns

The added timeline marker, or nullptr if insertion failed.