#include <c4d_basedocument.h>

Inheritance diagram for BaseDocument:

[legend]

Detailed Description

This class contains the complete description of a scene.

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
	BaseDocument ()

	~BaseDocument ()

Alloc/Free/Flush
static BaseDocument *	Alloc ()

static void	Free (BaseDocument *&bl)

void	Flush ()

Target Object
static void	CopyLinearWorkflow (const BaseDocument src, BaseDocument dst, Bool isMaterialPreview)

static const OcioConverterRef &	GetBasicColorConverter ()

static const OcioConverterRef &	GetColorConverterForActiveDocument ()

BaseObject *	GetTargetObject () const

void	SetTargetObject (BaseObject *op)

maxon::Result< const maxon::UpdatableAssetRepositoryRef & >	GetSceneRepository (Bool create)

void	SetTemporaryManipulatorObject (BaseObject *temp)

BaseObject *	GetTemporaryManipulatorObject () const

maxon::DocumentModeControllerRef &	GetModeController ()

Int32	GetMode (const maxon::Id &group) const

void	SetMode (Int32 mode, const maxon::Id &group)

Filename	GetOcioConfigPath (Bool fullPath=true) const

const maxon::OcioConfig &	GetOcioConfig () const

void	GetOcioProfiles (maxon::ColorProfile &renderingColorSpace, maxon::ColorProfile &displayColorSpace, maxon::ColorProfile &viewTransform, maxon::ColorProfile &viewTransformThumbnails) const

void	GetOcioConfigAndProfiles (maxon::OcioConfig &ocioConfig, maxon::ColorProfile &renderingColorSpace, maxon::ColorProfile &displayColorSpace, maxon::ColorProfile &viewTransform, maxon::ColorProfile &viewTransformThumbnails) const

void	GetActiveOcioColorSpacesNames (maxon::CString &renderingColorSpace, maxon::CString &displayColorSpace, maxon::CString &viewTransform, maxon::CString &viewTransformThumbnails) const

const maxon::BaseArray< maxon::CString > &	GetOcioColorSpaceNames ()

const maxon::BaseArray< maxon::CString > &	GetOcioRenderingColorSpaceNames ()

const BaseContainer &	GetOcioColorSpacesPopupMenu () const

const maxon::BaseArray< maxon::CString > &	GetOcioViewTransformNames ()

const maxon::BaseArray< maxon::CString > &	GetOcioDisplayColorSpaceNames ()

maxon::CString	GetNameFromColorSpaceId (Int32 category, Int32 index) const

Int32	GetColorSpaceIdFromName (Int32 category, const maxon::CString &name) const

void	UpdateOcioColorSpaces ()

const OcioConverterRef &	GetColorConverter () const

maxon::Result< void >	PrivateSetBaseRepository (const maxon::UpdatableAssetRepositoryRef &baseRepo)

Int	GetCacheRunId () const

Bool	HasUncachedDynamics () const

Navigation
const BaseDocument *	GetNext () const

BaseDocument *	GetNext ()

const BaseDocument *	GetPred () const

BaseDocument *	GetPred ()

Data/Settings
BaseContainer	GetData (DOCUMENTSETTINGS type) const

void	SetData (DOCUMENTSETTINGS type, const BaseContainer &bc)

const BaseContainer *	GetSettingsInstance (Int32 type) const

BaseContainer *	GetSettingsInstance (Int32 type)

NetRenderDocumentContext *	GetNetRenderDocumentContext () const

void	SetNetRenderDocumentContext (NetRenderDocumentContext *context)

Object/Material/Tag/Render Data
BaseObject *	GetFirstObject () const

BaseMaterial *	GetFirstMaterial () const

RenderData *	GetFirstRenderData () const

BaseSceneHook *	GetFirstSceneHook () const

void	InsertObject (BaseObject op, BaseObject parent, BaseObject *pred, Bool checkNames=false, Bool sendNotification=true)

void	InsertMaterial (BaseMaterial mat, BaseMaterial pred=nullptr, Bool checkNames=false)

void	InsertRenderData (RenderData rd, RenderData parent, RenderData *pred)

void	InsertRenderDataLast (RenderData *rd)

BaseObject *	GetActiveObject ()

const BaseObject *	GetActiveObject () const

BaseMaterial *	GetActiveMaterial ()

const BaseMaterial *	GetActiveMaterial () const

BaseTag *	GetActiveTag ()

const BaseTag *	GetActiveTag () const

RenderData *	GetActiveRenderData ()

const RenderData *	GetActiveRenderData () const

BaseObject *	GetRealActiveObject (AtomArray help, Bool multi)

void	GetActiveObjects (AtomArray &selection, GETACTIVEOBJECTFLAGS flags) const

void	GetActivePolygonObjects (AtomArray &selection, Bool children) const

void	GetActiveObjectsFilter (AtomArray &selection, Bool children, Int32 type, Int32 instanceof) const

void	GetActiveMaterials (AtomArray &selection) const

void	GetActiveTags (AtomArray &selection) const

void	GetSelection (AtomArray &selection) const

void	SetActiveObject (BaseObject *op, Int32 mode=0)

void	SetActiveMaterial (BaseMaterial *mat, Int32 mode=0)

void	SetActiveTag (BaseTag *tag, Int32 mode=0)

void	SetActiveRenderData (RenderData *rd)

void	SetSelection (BaseList2D *bl, Int32 mode=0)

Search Object/Material
BaseObject *	SearchObject (const maxon::String &str)

BaseMaterial *	SearchMaterial (const maxon::String &str)

Changed State
Bool	GetChanged ()

void	SetChanged ()

Name/Path
Filename	GetDocumentName () const

Filename	GetDocumentPath () const

void	SetDocumentName (const Filename &fn)

void	SetDocumentPath (const Filename &path)

LOD
Float	GetLOD () const

void	SetLOD (Float lod)

Bool	GetRenderLod () const

void	SetRenderLod (Bool lod)

Time
const BaseTime &	GetTime () const

void	SetTime (const BaseTime &t)

Int32	GetFps () const

void	SetFps (Int32 fps)

BaseTime	GetMinTime () const

void	SetMinTime (const BaseTime &t)

BaseTime	GetMaxTime () const

void	SetMaxTime (const BaseTime &t)

BaseTime	GetUsedMinTime (BaseList2D *check)

BaseTime	GetUsedMaxTime (BaseList2D *check)

BaseTime	GetLoopMinTime () const

void	SetLoopMinTime (const BaseTime &t)

BaseTime	GetLoopMaxTime () const

void	SetLoopMaxTime (const BaseTime &t)

Mode/Action
Int32	GetMode () const

void	SetMode (Int32 m)

Bool	IsEditMode () const

Int32	GetAction () const

void	SetAction (Int32 a)

Undo
Bool	StartUndo ()

Bool	EndUndo ()

Bool	AddUndo (UNDOTYPE type, void *data, Bool allowFromThread=false)

Bool	AddUndo (BaseDraw *bd)

Bool	DoUndo (Bool multiple=false)

Bool	DoRedo ()

void	FlushUndoBuffer (Bool lastEntryOnly=false)

BaseList2D *	GetUndoPtr ()

BaseList2D *	FindUndoPtr (BaseList2D *bl, UNDOTYPE type)

Key
void	AutoKey (BaseList2D undo, BaseList2D op, Bool recursive, Bool pos, Bool scale, Bool rot, Bool param, Bool pla)

Bool	RecordKey (BaseList2D op, const BaseTime &time, const DescID &id, BaseList2D undo, Bool eval_attribmanager, Bool autokeying, Bool allow_linking)

void	Record ()

BaseDraw
BaseDraw *	GetActiveBaseDraw () const

BaseDraw *	GetRenderBaseDraw () const

BaseDraw *	GetBaseDraw (Int32 num) const

Int32	GetBaseDrawCount () const

void	ForceCreateBaseDraw ()

Int32	GetDrawTime ()

void	GetDefaultClippingPlanes (Float &nearPlane, Float &farPlane, const GeData *preset=nullptr) const

Pick Session
const PickSessionDataStruct *	GetPickSession () const

void	StartPickSession (PickSessionDataStruct *psd)

void	StopPickSession (Bool cancel)

Miscellaneous
void	AnimateObject (BaseList2D *op, const BaseTime &time, ANIMATEFLAGS flags)

Bool	ExecutePasses (BaseThread *bt, Bool animation, Bool expressions, Bool caches, BUILDFLAGS flags)

BaseDocument *	Polygonize (Bool keepanimation=false)

Bool	CollectSounds (BaseSound *snd, const BaseTime &from, const BaseTime &to)

BaseSceneHook *	FindSceneHook (Int32 id) const

Int32	GetSplinePlane ()

GeListHead *	GetLayerObjectRoot ()

BaseContainer	GetAllTextures (const AtomArray *ar)

BaseContainer	GetAllTextures (Bool isNet, const AtomArray *ar)

BaseObject *	GetHighest (Int32 type, Bool editor)

BaseBitmap *	GetDocPreviewBitmap ()

void	GetHighlightedObjects (AtomArray &selection) const

void	SetHighlightedObject (BaseObject *op, Int32 mode=0)

void	SetHighlightedObjects (AtomArray &selection, Int32 mode=0)

Bool	GetDefaultKey (CKey *pKey, Bool &bOverdub) const

void	SetDefaultKey (CKey *pKey, Bool bOverdub)

void	SetTrackDefaultInterpolationMode (CURVEINTERPOLATION_MODE mode)

CURVEINTERPOLATION_MODE	GetTrackDefaultInterpolationMode () const

Bool	IsCacheBuilt (Bool force=false)

Bool	IsAxisEnabled () const

BaseObject *	GetHelperAxis ()

Bool	HandleSelectedTextureFilename (BaseChannel bc, const Filename &fn, Filename resfilename, Bool undo, GEMB_R *already_answered)

Bool	ReceiveMaterials (BaseObject op, AtomArray mat, Bool clearfirst)

Bool	ReceiveNewTexture (BaseObject op, const Filename &filename, Bool sdown, GEMB_R already_answered)

void	SendInfo (Int32 type, Int32 format, const Filename &fn, BaseList2D *bl, Bool hooks_only)

void	RecordZero ()

void	RecordNoEvent ()

void	SetRewind (Int32 flags=0)

Take Data
TakeData *	GetTakeData () const

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

◆ BaseDocument()

BaseDocument ( )

private

◆ ~BaseDocument()

~BaseDocument ( )

private

Member Function Documentation

◆ Alloc()

static BaseDocument* Alloc ( )

static

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

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

◆ Free()

static void Free ( BaseDocument *& bl )

static

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

Parameters

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

◆ Flush()

void Flush ( )

Empties the document; deletes and frees all resources used.

◆ GetNext() [1/2]

const BaseDocument* GetNext ( ) const

Gets the next document in the list. Convenience version of GeListNode::GetNext() returning a pointer to a BaseDocument.

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

◆ GetNext() [2/2]

BaseDocument* GetNext ( )

Gets the next document in the list. Convenience version of GeListNode::GetNext() returning a pointer to a BaseDocument.

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

◆ GetPred() [1/2]

const BaseDocument* GetPred ( ) const

Gets the previous document in the list. Convenience version of GeListNode::GetNext() returning a pointer to a BaseDocument.

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

◆ GetPred() [2/2]

BaseDocument* GetPred ( )

Gets the previous document in the list. Convenience version of GeListNode::GetNext() returning a pointer to a BaseDocument.

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

◆ GetData()

BaseContainer GetData ( DOCUMENTSETTINGS type ) const

Gets the container settings of the specified type.

Parameters

[in] type Selects the type of settings to get for the document: DOCUMENTSETTINGS

Returns: The settings for the document.

◆ SetData()

void SetData	(	DOCUMENTSETTINGS	type,
		const BaseContainer &	bc
	)

Merges the container for the settings of the specified type.

Parameters

[in]	type	Selects the type of settings to merge for the document: DOCUMENTSETTINGS
[in]	bc	The container to take the new settings from.

◆ GetSettingsInstance() [1/2]

const BaseContainer* GetSettingsInstance ( Int32 type ) const

Gets a pointer to the container settings of the specified type. Changes to the pointed container are reflected in the document so it is not needed to call SetData() manually.

Parameters

[in] type Selects the type of settings to get for the document: DOCUMENTSETTINGS

Returns: The pointer to the settings container. The document owns the pointed container.

◆ GetSettingsInstance() [2/2]

BaseContainer* GetSettingsInstance ( Int32 type )

◆ GetNetRenderDocumentContext()

NetRenderDocumentContext* GetNetRenderDocumentContext ( ) const

Retrieves a context on a client during a NET rendering.

Since: R16

Returns: The information about the current NET rendering. Cinema 4D owns the pointed structure.

◆ SetNetRenderDocumentContext()

void SetNetRenderDocumentContext ( NetRenderDocumentContext * context )

Sets the current context on a client during a NET rendering.

Since: R16

Parameters

[in] context The information about the current NET rendering. The caller owns the pointed structure.

◆ GetFirstObject()

BaseObject* GetFirstObject ( ) const

Gets the first object of the document. The other objects in the document can be accessed with BaseObject::GetNext(), BaseObject::GetPred(), BaseObject::GetDown() etc.

Returns: The first object of the document, or nullptr if there are no objects in the document. The document owns the pointed object.

◆ GetFirstMaterial()

BaseMaterial* GetFirstMaterial ( ) const

Gets the first material of the document. The other materials in the document can be accessed with BaseMaterial::GetNext() and BaseMaterial::GetPred().

Returns: The first material of the document, or nullptr if there are no materials in the document. The document owns the pointed material.

◆ GetFirstRenderData()

RenderData* GetFirstRenderData ( ) const

Gets the first render data or options of the document. The other render settings in the document can be accessed by using the base class list functions, RenderData::GetNext(), RenderData::GetPred(), RenderData::GetDown() etc.

Returns: The first render data of the document, or nullptr if there are no render data associated with the document. The document owns the pointed render data.

◆ GetFirstSceneHook()

BaseSceneHook* GetFirstSceneHook ( ) const

Gets the first scene hook of the document.

Returns: The first scene hook of the document.

◆ InsertObject()

void InsertObject	(	BaseObject *	op,
		BaseObject *	parent,
		BaseObject *	pred,
		Bool	checkNames = `false`,
		Bool	sendNotification = `true`
	)

Inserts the object into the document's object hierarchy.
Optionally the insertion position can either be specified by the parent parameter, inserting the object as the first child of the specified parent, or by the pred parameter, inserting the object below the specified pred object.
If neither is given, the object is inserted at the top of the hierarchy.

Note: If both parent and pred are provided then pred has precedence.

Parameters

[in]	op	The object to insert into the document. The document takes over the ownership of the pointed object.
[in]	parent	An optional parent object in the document to insert the object as a child of. Can be nullptr. The caller owns the pointed object.
[in]	pred	An optional object in the document to use as insertion point. The caller owns the pointed object.
[in]	checkNames	If true, it avoids duplicated names by prepending an incremental number to the name when needed.
[in]	sendNotification	True to send MSG_DOCUMENTINFO_TYPE_OBJECT_INSERT notification all scenehook (default). False to prevent doing this.

◆ InsertMaterial()

void InsertMaterial	(	BaseMaterial *	mat,
		BaseMaterial *	pred = `nullptr`,
		Bool	checkNames = `false`
	)

Inserts the material into the document's material list.
Optionally the insertion position can be specified by the pred parameter, giving the material before (just to the left of) the wanted position. Otherwise the material is inserted at the first position in the list.

Parameters

[in]	mat	The material to insert into the document. The document takes over the ownership of the pointed material.
[in]	pred	An optional material in the document to use as insertion point. The caller owns the pointed material.
[in]	checkNames	If true, it avoids duplicated names by prepending an incremental number to the name when needed.

◆ InsertRenderData()

void InsertRenderData	(	RenderData *	rd,
		RenderData *	parent,
		RenderData *	pred
	)

Inserts the render data into the document's render settings hierarchy.
Optionally the insertion position can either be specified by the parent parameter, inserting the render data as the first child of the specified parent, or by the pred parameter, inserting the render data below the specified pred render data.
If neither is given, the render data is inserted at the top of the hierarchy.

Parameters

[in]	rd	The render data to insert. The document takes over the ownership of the pointed render data.
[in]	parent	An optional parent to insert the render data as a child of. The caller owns the pointed render data.
[in]	pred	An optional render data of the document to use as insertion point. The caller owns the pointed render data.

◆ InsertRenderDataLast()

void InsertRenderDataLast ( RenderData * rd )

Inserts the render data as last child into the document's render data list.

Parameters

[in] rd The render data to insert. The document takes over the ownership of the pointed render data.

◆ GetActiveObject() [1/2]

BaseObject* GetActiveObject ( )

Gets the active object in the document. This is the object the user has selected in the Object Manager.

Returns: The active object, or nullptr if no object is active. The document owns the pointed object.

◆ GetActiveObject() [2/2]

const BaseObject* GetActiveObject ( ) const

Gets the active object in the document. This is the object the user has selected in the Object Manager.

Returns: The active object, or nullptr if no object is active. The document owns the pointed object.

◆ GetActiveMaterial() [1/2]

BaseMaterial* GetActiveMaterial ( )

Gets the active material in the document. This is the material the user has selected in the Material Manager.

Returns: The active material, or nullptr if no material is active or multiple are selected. The document owns the pointed material.

◆ GetActiveMaterial() [2/2]

const BaseMaterial* GetActiveMaterial ( ) const

Gets the active material in the document. This is the material the user has selected in the Material Manager.

Returns: The active material, or nullptr if no material is active or multiple are selected. The document owns the pointed material.

◆ GetActiveTag() [1/2]

BaseTag* GetActiveTag ( )

Gets the active tag in the document. This is the tag the user has selected in the Object Manager.

Note: Call GetActiveTags() to get multiple selections.

Returns: The active tag, or nullptr if no tag is active. The document owns the pointed tag.

◆ GetActiveTag() [2/2]

const BaseTag* GetActiveTag ( ) const

Gets the active tag in the document. This is the tag the user has selected in the Object Manager.

Note: Call GetActiveTags() to get multiple selections.

Returns: The active tag, or nullptr if no tag is active. The document owns the pointed tag.

◆ GetActiveRenderData() [1/2]

RenderData* GetActiveRenderData ( )

Gets the active render data for the document. These are the settings used for rendering the document.

Returns: The active rendering settings. The document owns the pointed render data.

◆ GetActiveRenderData() [2/2]

const RenderData* GetActiveRenderData ( ) const

Gets the active render data for the document. These are the settings used for rendering the document.

Returns: The active rendering settings. The document owns the pointed render data.

◆ GetRealActiveObject()

BaseObject* GetRealActiveObject	(	AtomArray *	help,
		Bool *	multi
	)

Gets the active object or the dummy axis if multiple objects are selected.

Parameters

[in]	help	Can be set to nullptr or for speedup purposes pass an array of active objects. The caller owns the pointed atom array.
[out]	multi	Assigned true if multiple objects are selected. Can be nullptr.

Returns: The active object or the dummy axis if multiple objects are selected and nullptr if no object is selected. The document owns the pointed object.

◆ GetActiveObjects()

void GetActiveObjects	(	AtomArray &	selection,
		GETACTIVEOBJECTFLAGS	flags
	)		const

Gets the active object multi-selection and optionally the selection order and/or children.

Parameters

[out]	selection	Filled with the selected objects.
[in]	flags	Flags: GETACTIVEOBJECTFLAGS

◆ GetActivePolygonObjects()

void GetActivePolygonObjects	(	AtomArray &	selection,
		Bool	children
	)		const

Gets the subset of polygon objects in the active object multi-selection.

Parameters

[out]	selection	Filled with the selected polygon objects.
[in]	children	If true then children are also added to selection, provided that they are selected. Otherwise only the topmost parent in each chain is added.

◆ GetActiveObjectsFilter()

void GetActiveObjectsFilter	(	AtomArray &	selection,
		Bool	children,
		Int32	type,
		Int32	instanceof
	)		const

Gets the active object multi-selection and removes objects that do not match the filter given by type and instanceof.

Parameters

[out]	selection	Filled with the selected objects.
[in]	children	If true then children are also added to selection, provided that they are selected. Otherwise only the topmost parent in each chain is added.
[in]	type	Checked against C4DAtom::GetType(). Pass NOTOK to ignore the test.
[in]	instanceof	Checked against C4DAtom::IsInstanceOf(). Pass NOTOK to ignore the test.

◆ GetActiveMaterials()

void GetActiveMaterials ( AtomArray & selection ) const

Gets the active material multi-selection.

Parameters

[out] selection Filled with the selected materials.

◆ GetActiveTags()

void GetActiveTags ( AtomArray & selection ) const

Gets the active tag multi-selection.

Parameters

[out] selection Filled with the selected tags.

◆ GetSelection()

void GetSelection ( AtomArray & selection ) const

Gets the active selection. This function deals with both objects and tags.

Parameters

[out] selection Filled with the objects and tags selection.

◆ SetActiveObject()

void SetActiveObject	(	BaseObject *	op,
		Int32	mode = `0`
	)

Modifies the current object multi-selection with op depending on mode.

Parameters

[in]	op	The object to use. Must be in the document already. The document owns the pointed object.
[in]	mode	The selection mode: SELECTION

◆ SetActiveMaterial()

void SetActiveMaterial	(	BaseMaterial *	mat,
		Int32	mode = `0`
	)

Modifies the current material multi-selection with mat depending on mode.

Parameters

[in]	mat	The material within the document that you want to make active. Must be in the document already. The document owns the pointed material.
[in]	mode	The selection mode: SELECTION

◆ SetActiveTag()

void SetActiveTag	(	BaseTag *	tag,
		Int32	mode = `0`
	)

Modifies the current tag multi-selection with tag depending on mode.

Note: This method also activates the object the tag is attached to if it was not previously activated.

Parameters

[in]	tag	The tag to make active. Must be in the document already. The document owns the pointed tag.
[in]	mode	The selection mode: SELECTION

◆ SetActiveRenderData()

void SetActiveRenderData ( RenderData * rd )

Sets the active render data for the document. These are the settings that are used for rendering.

Parameters

[in] rd The render data to make active. Must be in the document already. The document owns the pointed render data.

◆ SetSelection()

void SetSelection	(	BaseList2D *	bl,
		Int32	mode = `0`
	)

Sets the active selection. This function deals with both objects, tags and materials.

Parameters

[in]	bl	The baselist object within the document that you want to make active. Must be in the document already. The document owns the pointed base list object.
[in]	mode	The selection mode: SELECTION

◆ SearchObject()

BaseObject* SearchObject ( const maxon::String & str )

Searches for an object with the case sensitive name given.

Parameters

[in] str The case sensitive name of the object to search for.

Returns: The found object, or nullptr if no object was found. The document owns the pointed object.

◆ SearchMaterial()

BaseMaterial* SearchMaterial ( const maxon::String & str )

Searches for a material with the case sensitive name given.

Parameters

[in] str The case sensitive name of the material to search for.

Returns: The found material, or nullptr of no material was found. The document owns the pointed material.

◆ GetChanged()

Bool GetChanged ( )

Checks if the document has been changed since it was last saved.

Returns: true if the document was changed, otherwise false.

◆ SetChanged()

void SetChanged ( )

Sets the changed state of the document to reflect it has been modified.

◆ GetDocumentName()

Filename GetDocumentName ( ) const

Gets the name of the document.

Returns: The name of the file for the document.

◆ GetDocumentPath()

Filename GetDocumentPath ( ) const

Gets the path of the document.

Returns: The path of the file for the document. If the document has not been saved then the path is empty.

◆ SetDocumentName()

void SetDocumentName ( const Filename & fn )

Sets the name of the document.

Parameters

[in] fn The new name for the document's file. Must contain the name part only.

◆ SetDocumentPath()

void SetDocumentPath ( const Filename & path )

Sets the path of the document.

Parameters

[in] path The new path for the document's file. Must contain the path part only.

◆ GetLOD()

Float GetLOD ( ) const

Gets the Level of Detail for the document.

Returns

The Level of Detail for the document.
The default values are:

Low = 0.25
Medium = 0.5
High = 1.0

◆ SetLOD()

void SetLOD ( Float lod )

Sets the Level of Detail for the document.

Parameters

[in]

lod

The Level of Detail to set for the document. The default values are:

Low = 0.25
Medium = 0.5
High = 1.0

◆ GetRenderLod()

Bool GetRenderLod ( ) const

Checks if the Level of Detail for rendering should be used in the editor.

Returns: true if using the render LOD, otherwise false.

◆ SetRenderLod()

void SetRenderLod ( Bool lod )

Sets if the the Level of Detail for rendering should be used in the editor.

Parameters

[in] lod true if the render LOD should be used, otherwise false.

◆ GetTime()

const BaseTime& GetTime ( ) const

Gets the current time for the document's Timeline.
Here is how to get the current frame with GetTime():

Int32 fps = doc.GetFps();
BaseTime time = doc->GetTime();
frame = time.GetFrame(fps);

See also: GetFps()

Returns: The current time of the Timeline.

◆ SetTime()

void SetTime ( const BaseTime & t )

Sets the current time for the document's Timeline.

See also: GetTime()

Warning: This method only changes the document time, it does not start a redraw and/or animation/expressions. This is done using a combination of the following functions: ExecutePasses(), DrawViews() and EventAdd().

Parameters

[in] t The new current time of the Timeline.

◆ GetFps()

Int32 GetFps ( ) const

Gets the number of frames per second (FPS).

Note: The framerate defined in the render settings is independent from the document framerate.
In the viewport, and for a render in the viewport, it will return the project's setting FrameRate.
Rendering elsewhere, it will return the RenderData FrameRate setting.

Returns: The number of frames per second.

◆ SetFps()

void SetFps ( Int32 fps )

Sets the number of frames per second (FPS).

Parameters

[in] fps The new number of frames per second.

◆ GetMinTime()

BaseTime GetMinTime ( ) const

Gets the starting time for the Timeline in the document.

Returns: The starting time of the document's Timeline.

◆ SetMinTime()

void SetMinTime ( const BaseTime & t )

Sets the starting time for the Timeline in the document.

Parameters

[in] t The new starting time of the document's Timeline.

◆ GetMaxTime()

BaseTime GetMaxTime ( ) const

Gets the ending time for for the Timeline in the document.

Returns: The ending time of the document's Timeline.

◆ SetMaxTime()

void SetMaxTime ( const BaseTime & t )

Sets the ending time for the Timeline in the document.

See also: BaseTime for conversion of FPS or other time units.; GetFps()

Parameters

[in] t The new ending time of the document's Timeline.

◆ GetUsedMinTime()

BaseTime GetUsedMinTime ( BaseList2D * check )

Gets the lower bound of the range of time used by all sequences, tracks, keys etc. Optionally the calculation is done only for the given object check.

Note: Though the check parameter supports all kinds of nodes, the test when check==nullptr is only done for objects.

Parameters

[in] check An object to check or nullptr to check the document's objects.

Returns: The minimal used time in the document.

◆ GetUsedMaxTime()

BaseTime GetUsedMaxTime ( BaseList2D * check )

Gets the upper bound of the range of time used by all sequences, tracks, keys etc. Optionally the calculation is done only for the given object check.

Note: Though the check parameter supports all kinds of nodes, the test when check==nullptr is only done for objects.

Parameters

[in] check An object to check or nullptr to check the document's objects.

Returns: The maximum used time in the document.

◆ GetLoopMinTime()

BaseTime GetLoopMinTime ( ) const

Gets the time of the left boundary of the document's loop or preview range.

Returns: The starting time for the document's loop range.

◆ SetLoopMinTime()

void SetLoopMinTime ( const BaseTime & t )

Sets the time of the left boundary of the document's loop or preview range.

Parameters

[in] t The new starting time for the document's loop range.

◆ GetLoopMaxTime()

BaseTime GetLoopMaxTime ( ) const

Gets the time of the right boundary of the document's loop or preview range.

Returns: The ending time for the document's loop range.

◆ SetLoopMaxTime()

void SetLoopMaxTime ( const BaseTime & t )

Sets the time of the right boundary of the document's loop or preview range.

Parameters

[in] t The new ending time for the document's loop range.

◆ GetMode() [1/2]

Int32 GetMode ( ) const

Gets the main editor mode.

Returns: The values for the editor mode are: EditorModes

◆ SetMode() [1/2]

void SetMode ( Int32 m )

Sets the main editor mode.

Parameters

[in] m The values for the editor mode are: EditorModes

◆ IsEditMode()

Bool IsEditMode ( ) const

Checks if the editor is in editable mode. It basically checks if GetMode() is Mpoints, Medges or Mpolygons.

Returns: true if the editor is in point/edge/poly editing mode, otherwise false.

◆ GetAction()

Int32 GetAction ( ) const

Gets the current action tool in the editor.

Returns: The return values are ID_MODELING_MOVE, ID_MODELING_SCALE, ID_MODELING_ROTATE etc.

◆ SetAction()

void SetAction ( Int32 a )

Sets the current action tool in the editor.

Parameters

[in] a The values are ID_MODELING_MOVE, ID_MODELING_SCALE, ID_MODELING_ROTATE etc.

◆ StartUndo()

Bool StartUndo ( )

Tells Cinema 4D to start building a list of undos into a single undo action for the user. This must be paired with an EndUndo().

Note: Before calling StartUndo() in an asynchronous situation, do not forget to call StopAllThreads()

Returns: true if the undo list was successfully started, otherwise false.

◆ EndUndo()

Bool EndUndo ( )

Ends the building of multiple undo actions into a single user undo. This must be paired with StartUndo().

Returns: true if the undo list was successfully finished, otherwise false.

◆ AddUndo() [1/2]

Bool AddUndo	(	UNDOTYPE	type,
		void *	data,
		Bool	allowFromThread = `false`
	)

Adds an undo type to the list of undo operations started with StartUndo().

Note: AddUndo() always has to be called before a change is made.
In the case of the creation of a new object the call is done afterwards, after insertion into the document/object/track/sequence but before calling subsequent functions like SetActiveObject() which creates another undo:
BaseTag* tag = UVWTag::Alloc();

op->InsertTag(tag);

doc->AddUndo(UNDOTYPE::NEWOBJ, tag);

BaseTag
Definition: c4d_basetag.h:52

UVWTag::Alloc
static UVWTag * Alloc(Int32 count)

UNDOTYPE::NEWOBJ
@ NEWOBJ
A new object, material, tag, or other classic API node instance has been inserted into the document....

op
PyObject * op
Definition: object.h:520

Parameters

[in]	type	The values for the undo type are: UNDOTYPE
[in]	data	The object the undo has been added for.
[in]	allowFromThread	If an undo is added from a thread this is not executed. (As a safety measure, because normally this does not make any sense.) For explicit cases where a thread has to call AddUndo() (the view redraw and everything else is blocked) this can be set to true.

Returns: true if the change was successfully added to the undo list, otherwise false.

◆ AddUndo() [2/2]

Bool AddUndo ( BaseDraw * bd )

Adds an undo for a BaseDraw to the list of undo operations started with StartUndo().

Parameters

[in] bd The base draw to add the change to the undo list.

Returns: true if the change for the base draw was successfully added to the undo list, otherwise false.

◆ DoUndo()

Bool DoUndo ( Bool multiple = false )

Perform an undo operation, same as the user doing Undo from within Cinema 4D's interface.

Parameters

[in] multiple This parameter only matters if DoUndo() is called between AddUndo() and EndUndo().
If multiple is true then all the AddUndo() steps will be undone. Otherwise only the last AddUndo() step will be undone.
In addition if multiple is set then EndUndo() will be invoked internally so if further undos are to be created after this point StartUndo() must be called afterwards.
If EndUndo() has been called then all steps are always undone regardless of this setting.

Returns: true if the undo list was successfully undone, otherwise false.

◆ DoRedo()

Bool DoRedo ( )

Performs a redo operation (undo the last undo).

Note: DoRedo() must always be called after EndUndo().

Returns: true if the last undo was successfully undone, otherwise false.

◆ FlushUndoBuffer()

void FlushUndoBuffer ( Bool lastEntryOnly = false )

Flushes the complete undo + redo buffer.

Warning: Only call when absolutely needed.

Parameters

[in] lastEntryOnly If true only the last or currently ongoing undo is removed, e.g. when an operation failed. Otherwises flushes the complete undo and redo buffer.

◆ GetUndoPtr()

BaseList2D* GetUndoPtr ( )

Gets the element (object, tag, material, etc.) of the last undo action.
E.g. if you have added a BaseObject undo you can retrieve the object by calling GetUndoPtr() but always be sure to check the type of the result first.

Returns: The last undo element. The document owns the pointed element.

◆ FindUndoPtr()

BaseList2D* FindUndoPtr	(	BaseList2D *	bl,
		UNDOTYPE	type
	)

Finds the last undo state of the Cinema 4D element bl (object, tag, material, etc.) for the specified undo type.
For instance here is how to retrieve the pre-undo object after a change has been made:

BaseObject* preundo = (BaseObject*)doc->FindUndoPtr(op, UNDOTYPE::CHANGE);

BaseObject

Definition: c4d_baseobject.h:248

UNDOTYPE::CHANGE

@ CHANGE

Any change to an object, including hierarchy modifications, modification in positioning,...

Parameters

[in]	bl	The element to obtain the last undo action.
[in]	type	The undo type to check: UNDOTYPE

Returns: The last undo state of the element.The document owns the pointed element.

◆ AutoKey()

void AutoKey	(	BaseList2D *	undo,
		BaseList2D *	op,
		Bool	recursive,
		Bool	pos,
		Bool	scale,
		Bool	rot,
		Bool	param,
		Bool	pla
	)

Compares the object chain op to object chain undo and sets keyframes for all the changes.

Parameters

[in]	undo	The object chain to compare to. The caller owns the pointed object chain.
[in,out]	op	The object chain to add the keys to. The caller owns the pointed object chain.
[in]	recursive	If true then the function applies to all children of op as well. The hierarchy of op and undo must match.
[in]	pos	If true keyframes are added for differences in position.
[in]	scale	If true keyframes are added for differences in scale.
[in]	rot	If true keyframes are added for differences in rotation.
[in]	param	If true keyframes are added for differences in parameters.
[in]	pla	If true keyframes are added as PLA for differences in point positions.

◆ RecordKey()

Bool RecordKey	(	BaseList2D *	op,
		const BaseTime &	time,
		const DescID &	id,
		BaseList2D *	undo,
		Bool	eval_attribmanager,
		Bool	autokeying,
		Bool	allow_linking
	)

Records a key for op at time.

Parameters

[in,out]	op	The object to record.
[in]	time	The time to record.
[in]	id	The description ID to record.
[in]	undo	The object in op in the old state. This is necessary e.g. for auto-keyframing so that Cinema 4D can compare values. Usually this is the object from the undo buffer. To record keys without auto-keyframing then nullptr can be passed.
[in]	eval_attribmanager	If true Attribute Manager is evaluated.
[in]	autokeying	If true auto-keyframing is used and undo needs to be passed for comparison.
[in]	allow_linking	If true and a Y key will be generated in auto-keyframing, then automatically the X and Z components will be completed. If false then only the Y key will be generated.

Returns: true if the key was successfully recorded, otherwise false.

◆ Record()

void Record ( )

Records the active objects.

Note: Same as pushing the "Record Active Objects" button in the user interface.

◆ GetActiveBaseDraw()

BaseDraw* GetActiveBaseDraw ( ) const

Gets the activate BaseDraw in the editor.

Returns: The active view in the editor or nullptr if there is no active view. The document owns the pointed view.

◆ GetRenderBaseDraw()

BaseDraw* GetRenderBaseDraw ( ) const

Gets the BaseDraw the user has chosen as Render View in the editor (see View menu in Cinema 4D).

Returns: The render view in the editor or nullptr if there is no render view. The document owns the pointed view.

◆ GetBaseDraw()

BaseDraw* GetBaseDraw ( Int32 num ) const

Gets the BaseDraw from one of the editor views.

Parameters

[in] num If there are multiple views this selects the view. 0 <= num < GetBaseDrawCount()

Returns: The requested view in the editor, or nullptr if it is not available. The document owns the pointed view.

◆ GetBaseDrawCount()

Int32 GetBaseDrawCount ( ) const

Gets the number of views in the editor.

Note: While this function may sound trivial and cheap, internally it is not. For performance reasons, it is not recommended to use this function inside a loop or inside a loop condition.

Returns: The BaseDraw count in the editor.

◆ ForceCreateBaseDraw()

void ForceCreateBaseDraw ( )

Call this method to Make sure that GetBaseDraw(0) is accessible. This is only important in import filters where, at the time, there are no valid drawing views.

◆ GetDrawTime()

Int32 GetDrawTime ( )

Gets the editor redraw time.

Returns: The editor redraw time.

◆ GetDefaultClippingPlanes()

void GetDefaultClippingPlanes	(	Float &	nearPlane,
		Float &	farPlane,
		const GeData *	preset = `nullptr`
	)		const

Gets the default clipping planes for the document.

Parameters

[out]	nearPlane	Near plane.
[out]	farPlane	Far plane.
[in]	preset	If this is not nullptr, it must be an Int32 value which is any of the DOCUMENT_CLIPPING_PRESET_* constants.

◆ GetPickSession()

const PickSessionDataStruct* GetPickSession ( ) const

Gets the data structure of the current pick session.

Returns: The data structure of the current pick session, or nullptr if there is none. The document owns the pointed pick session data.

◆ StartPickSession()

void StartPickSession ( PickSessionDataStruct * psd )

Starts a pick session.

Parameters

[in] psd The initialized data structure for the pick session. The caller owns the pointed pick session data.

◆ StopPickSession()

void StopPickSession ( Bool cancel )

Ends the pick session. For instance after filling the pick session array.

Parameters

[in] cancel Pass true to cancel a pick session, for instance if an error occurred. Pass false if the pick session is ended regularly.

◆ AnimateObject()

void AnimateObject	(	BaseList2D *	op,
		const BaseTime &	time,
		ANIMATEFLAGS	flags
	)

Animates the object op in the document at the given time.

Note: Does not take expressions into account.

Parameters

[in]	op	The object to animate. The caller owns the pointed object.
[in]	time	The time at which op is animated.
[in]	flags	The animate flags: ANIMATEFLAGS

◆ ExecutePasses()

Bool ExecutePasses	(	BaseThread *	bt,
		Bool	animation,
		Bool	expressions,
		Bool	caches,
		BUILDFLAGS	flags
	)

Animates the current frame of the document. Send an update message using EventAdd() to update the editor afterwards.

Parameters

[in]	bt	The thread can either be nullptr (for the main Cinema 4D thread) or if you are within your own thread then you pass it. The caller owns the pointed thread.
[in]	animation	If true animations are evaluated.
[in]	expressions	If true expressions are evaluated.
[in]	caches	If true caches are evaluated.
[in]	flags	The build flags: BUILDFLAGS

Returns: true if the passes were executed successfully, otherwise false.

◆ Polygonize()

BaseDocument* Polygonize ( Bool keepanimation = false )

Makes a clone of the document and turns all objects into polygon based objects.

Parameters

[in] keepanimation If true the animation is kept on the objects.

Returns: The cloned polygon based document or nullptr if it failed. The caller owns the pointed document.

◆ CollectSounds()

Bool CollectSounds	(	BaseSound *	snd,
		const BaseTime &	from,
		const BaseTime &	to
	)

Collects all enabled soundtracks and calculates the downmix of the tracks. The result is stored in snd.

Parameters

[out]	snd	The downmix of the collected soundtracks. The caller owns the pointed sound.
[in]	from	The starting time of for the downmix.
[in]	to	The ending time for the downmix.

Returns: true if collecting all the document's sounds was successful, otherwise false.

◆ FindSceneHook()

BaseSceneHook* FindSceneHook ( Int32 id ) const

Finds a scene hook by ID.

Parameters

[in] id The scene hook ID.

Returns: The found scene hook, or nullptr if there is no scene hook with the searched id. The document owns the pointed scene hook.

◆ GetSplinePlane()

Int32 GetSplinePlane ( )

Gets the plane in which the splines are created, such as XY plane.

Returns: The values for the spline planes are: PRIM_PLANE_XY, PRIM_PLANE_ZY and PRIM_PLANE_XZ.

◆ GetLayerObjectRoot()

GeListHead* GetLayerObjectRoot ( )

Gets the list of layers in the document.

Returns: The head of the list of the document's layers. The document owns the pointed list head.

◆ GetAllTextures() [1/2]

BaseContainer GetAllTextures ( const AtomArray * ar )

Gets all used textures for the objects in ar.

Parameters

[in] ar An atom array. If nullptr, all used textures in the document will be returned.

Returns: A container with all textures filename.

◆ GetAllTextures() [2/2]

BaseContainer GetAllTextures	(	Bool	isNet,
		const AtomArray *	ar
	)

Gets all used textures for the objects in ar.

Note: If isNet is passed true then the function only delivers the textures of the current take. Set the parameter to false to get all.

Parameters

[in]	isNet	Pass true to retrieve the textures used in the current NET rendering.
[in]	ar	An atom array to get the textures for. If nullptr, all used textures in the document will be returned.

Returns: A container with all textures filename.

◆ GetHighest()

BaseObject* GetHighest	(	Int32	type,
		Bool	editor
	)

Gets the first object in the Object Manager hierarchy of the specified type. It searches objects that are not deactivated in the Object Manager (set to red).

Parameters

[in]	type	The object type to search for.
[in]	editor	true will search using the editor dot in the Object Manager, false will use the render dot.

Returns: The first object of the requested type or nullptr if no object was found. The document owns the pointed object.

◆ GetDocPreviewBitmap()

BaseBitmap* GetDocPreviewBitmap ( )

Gets the preview bitmap of the document.

Returns: The preview bitmap of the document. The document owns the pointed bitmap.

◆ GetHighlightedObjects()

void GetHighlightedObjects ( AtomArray & selection ) const

Private.

◆ SetHighlightedObject()

void SetHighlightedObject	(	BaseObject *	op,
		Int32	mode = `0`
	)

Private.

◆ SetHighlightedObjects()

void SetHighlightedObjects	(	AtomArray &	selection,
		Int32	mode = `0`
	)

Private.

◆ GetDefaultKey()

Bool GetDefaultKey	(	CKey *	pKey,
		Bool &	bOverdub
	)		const

Gets the document's default keying settings.

Parameters

[in]	pKey	Assigned the default keying settings. Cinema 4D owns the pointed key.
[in]	bOverdub	Assigned the document's default overdub.

Returns: true if the document's default keying settings were retrieved successfully, otherwise false.

◆ SetDefaultKey()

void SetDefaultKey	(	CKey *	pKey,
		Bool	bOverdub
	)

Sets the document's default keying settings.

Parameters

[in]	pKey	The new default keying settings. Cinema 4D owns the pointed key.
[in]	bOverdub	The new document's default overdub. If a keyframe already exists, the existing keyframe's interpolation type will be maintained when a new keyframe is recorded (only the Value Key will be overwritten).

◆ SetTrackDefaultInterpolationMode()

void SetTrackDefaultInterpolationMode ( CURVEINTERPOLATION_MODE mode )

Sets the track default interpolation mode.

Parameters

[in] mode Interpolation mode.

◆ GetTrackDefaultInterpolationMode()

CURVEINTERPOLATION_MODE GetTrackDefaultInterpolationMode ( ) const

Gets the track default interpolation mode.

Returns: Interpolation mode.

◆ IsCacheBuilt()

Bool IsCacheBuilt ( Bool force = false )

Private.

◆ IsAxisEnabled()

Bool IsAxisEnabled ( ) const

Checks the state of the object axis modifier.

Returns: true if the object axis modifier is enabled, otherwise false.

◆ GetHelperAxis()

BaseObject* GetHelperAxis ( )

Gets the helper axis for the current multi-selection.

Returns: The axis object. The document owns the pointed object.

◆ HandleSelectedTextureFilename()

Bool HandleSelectedTextureFilename	(	BaseChannel *	bc,
		const Filename &	fn,
		Filename *	resfilename,
		Bool	undo,
		GEMB_R *	already_answered
	)

Private.

◆ ReceiveMaterials()

Bool ReceiveMaterials	(	BaseObject *	op,
		AtomArray *	mat,
		Bool	clearfirst
	)

Private.

◆ ReceiveNewTexture()

Bool ReceiveNewTexture	(	BaseObject *	op,
		const Filename &	filename,
		Bool	sdown,
		GEMB_R *	already_answered
	)

Private.

◆ SendInfo()

void SendInfo	(	Int32	type,
		Int32	format,
		const Filename &	fn,
		BaseList2D *	bl,
		Bool	hooks_only
	)

Sends MSG_DOCUMENTINFO messages.

Parameters

[in]	type	The document info message type: MSG_DOCUMENTINFO_TYPE
[in]	format	The file format: (Set for load, merge and before/after save only. Otherwise NOTOK.) FORMAT_FILES
[in]	fn	The document filename.

Note: This is not always the same as the filename returned by BaseDocument::GetDocumentPath().
e.g. for MSG_DOCUMENTINFO_TYPE_SAVE_BEFORE BaseDocument::GetDocumentPath() still contains the old path whereas fn designates the real file.

Parameters

[in]	bl	The object/tag/material that got inserted. It is used if type is of one of the following values: MSG_DOCUMENTINFO_TYPE_OBJECT_INSERT MSG_DOCUMENTINFO_TYPE_TAG_INSERT MSG_DOCUMENTINFO_TYPE_MATERIAL_INSERT
[in]	hooks_only	If true the message is sent to scene hooks only.

◆ RecordZero()

void RecordZero ( )

Private.

◆ RecordNoEvent()

void RecordNoEvent ( )

markPrivate

◆ SetRewind()

void SetRewind ( Int32 flags = 0 )

In NodeData::SetDParameter() some operators, objects etc. can call doc->SetRewind() so that Cinema 4D rewinds the whole document (from time 0 to current time) when the next event EVMSG_CHANGE or DrawViews() is processed.

Parameters

[in] flags Not used.

◆ GetTakeData()

TakeData* GetTakeData ( ) const

Gets the take data for the document.

Since: R17.032

Returns: The take data. The document owns the pointed take data.

◆ GetTargetObject()

BaseObject* GetTargetObject ( ) const

Gets target object within a multi-selection.

Since: R17.032

Note: This is the last object selected and is used by commands such as Spline Boolean in order to allow the user to control which object will be used as the target for the command.
The target object displays in the Object Manager as highlighted.

Returns: The target object, or nullptr if it fails or there is no selection.

◆ SetTargetObject()

void SetTargetObject ( BaseObject * op )

Sets target object within a multi-selection.

Since: R17.032

Note: Implies selection of an object if it is not currently selected, adding it to the existing selection.
Moves the object to the very end of the list when calling BaseDocument::GetActiveObjects(GETACTIVEOBJECTFLAGS::SELECTIONORDER).

Parameters

[in] op The object to set as the target.

◆ GetSceneRepository()

maxon::Result<const maxon::UpdatableAssetRepositoryRef&> GetSceneRepository ( Bool create )

Returns the SceneRepository description.

Parameters

[in] create True to create if not existing.

Returns: Reference to a repository on success.

◆ SetTemporaryManipulatorObject()

void SetTemporaryManipulatorObject ( BaseObject * temp )

@markprivate @Since R20.000

◆ GetTemporaryManipulatorObject()

BaseObject* GetTemporaryManipulatorObject ( ) const

@markprivate

Since: R20.000

◆ GetModeController()

maxon::DocumentModeControllerRef& GetModeController ( )

@markprivate

Since: S22.000

◆ GetMode() [2/2]

Int32 GetMode ( const maxon::Id & group ) const

@markprivate

Since: S22.000

◆ SetMode() [2/2]

void SetMode	(	Int32	mode,
		const maxon::Id &	group
	)

@markprivate

Since: S22.000

◆ GetOcioConfigPath()

Filename GetOcioConfigPath ( Bool fullPath = true ) const

Gets the path of the OCIO coniguration file.

Since: R2023.000 If fullPath is set to true, the full path is returned, otherwise the string that is entered in the document settings. If the path is set to "$OCIO" by the user, the path is taken from the environment variable "OCIO".

Parameters

[in] fullPath True, if the full path should be returned.

Returns: OCIO config path.

◆ GetOcioConfig()

const maxon::OcioConfig& GetOcioConfig ( ) const

Gets the OCIO configuration.

Since: R2023.200 @markprivate

Returns: OCIO config.

◆ GetOcioProfiles()

void GetOcioProfiles	(	maxon::ColorProfile &	renderingColorSpace,
		maxon::ColorProfile &	displayColorSpace,
		maxon::ColorProfile &	viewTransform,
		maxon::ColorProfile &	viewTransformThumbnails
	)		const

Gets the OCIO color profiles.

Since: R2023.200

Parameters

[out]	renderingColorSpace	Rendering color space.
[out]	displayColorSpace	Display color space.
[out]	viewTransform	View transform for rendering.
[out]	viewTransformThumbnails	View transform for thumbnails.

◆ GetOcioConfigAndProfiles()

void GetOcioConfigAndProfiles	(	maxon::OcioConfig &	ocioConfig,
		maxon::ColorProfile &	renderingColorSpace,
		maxon::ColorProfile &	displayColorSpace,
		maxon::ColorProfile &	viewTransform,
		maxon::ColorProfile &	viewTransformThumbnails
	)		const

Gets the OCIO configuration and the according color profiles.

Since: R2023.000 @markprivate

Parameters

[out]	ocioConfig	OCIO config.
[out]	renderingColorSpace	Rendering color space.
[out]	displayColorSpace	Display color space.
[out]	viewTransform	View transform for rendering.
[out]	viewTransformThumbnails	View transform for thumbnails.

◆ GetActiveOcioColorSpacesNames()

void GetActiveOcioColorSpacesNames	(	maxon::CString &	renderingColorSpace,
		maxon::CString &	displayColorSpace,
		maxon::CString &	viewTransform,
		maxon::CString &	viewTransformThumbnails
	)		const

Gets the name of the OCIO color spaces.

Since: R2023.000

Parameters

[out]	renderingColorSpace	Rendering color space name.
[out]	displayColorSpace	Display color space name.
[out]	viewTransform	View transform for rendering name.
[out]	viewTransformThumbnails	View transform for thumbnails name.

◆ GetOcioColorSpaceNames()

const maxon::BaseArray<maxon::CString>& GetOcioColorSpaceNames ( )

Since: R2023.100

Returns: An array containing the names of the color spaces.

◆ GetOcioRenderingColorSpaceNames()

const maxon::BaseArray<maxon::CString>& GetOcioRenderingColorSpaceNames ( )

Since: R2023.100

Returns: An array containing the names of the rendering color spaces.

◆ GetOcioColorSpacesPopupMenu()

const BaseContainer& GetOcioColorSpacesPopupMenu ( ) const

Since: R2023.200

Returns: A BaseContainer containing the names of all color spaces.

◆ GetOcioViewTransformNames()

const maxon::BaseArray<maxon::CString>& GetOcioViewTransformNames ( )

Since: R2023.100

Returns: An array containing the names of the view transforms.

◆ GetOcioDisplayColorSpaceNames()

const maxon::BaseArray<maxon::CString>& GetOcioDisplayColorSpaceNames ( )

Since: R2023.100

Returns: An array containing the names of the display color spaces.

◆ GetNameFromColorSpaceId()

maxon::CString GetNameFromColorSpaceId	(	Int32	category,
		Int32	index
	)		const

Since: R2023.000 category must be one of these values: DOCUMENT_OCIO_INPUT_COLORSPACE, DOCUMENT_OCIO_RENDER_COLORSPACE, DOCUMENT_OCIO_VIEW_TRANSFORM, DOCUMENT_OCIO_VIEW_TRANSFORM_THUMBNAILS or DOCUMENT_OCIO_DISPLAY_COLORSPACE.

Parameters

[in]	category	Category.
[in]	index	Index within the list that is specified by category.

Returns: An array containg the names of the display color spaces.

◆ GetColorSpaceIdFromName()

Int32 GetColorSpaceIdFromName	(	Int32	category,
		const maxon::CString &	name
	)		const

Since: R2023.000 category must be one of these values: DOCUMENT_OCIO_INPUT_COLORSPACE, DOCUMENT_OCIO_RENDER_COLORSPACE, DOCUMENT_OCIO_VIEW_TRANSFORM, DOCUMENT_OCIO_VIEW_TRANSFORM_THUMBNAILS or DOCUMENT_OCIO_DISPLAY_COLORSPACE.

Parameters

[in]	category	Category.
[in]	name	Name of a color space within the list that is specified by category.

Returns: An array containg the names of the display color spaces.

◆ CopyLinearWorkflow()

static void CopyLinearWorkflow	(	const BaseDocument *	src,
		BaseDocument *	dst,
		Bool	isMaterialPreview
	)

static

Copies the settings for linear workflow and OCIO configurations to another document.

Since: 2023.000

Parameters

[in]	src	Document from where the settings are read. If this is nullptr, the settings are taken from the active document.
[in]	dst	Document in which the settings should be copied.
[in]	isMaterialPreview	Must be set to true, if the document is a preview render document.

◆ UpdateOcioColorSpaces()

void UpdateOcioColorSpaces ( )

Updates the OCIO spaces that are stored internally in the document. Should be called after CopyLinearWorkflow.

◆ GetColorConverter()

const OcioConverterRef& GetColorConverter ( ) const

Returns a converter to convert colors along the OCIO conversion paths defined by the settings of this document.

The returned value is never nullptr. If OCIO is not active or if there was an error to create the OCIO converter a dummy is returned.

Returns: The color converter that belongs to the document.

◆ GetBasicColorConverter()

static const OcioConverterRef& GetBasicColorConverter ( )

static

Returns a fallback converter that can be used instead of a document specific OCIO converter in case of errors.

Returns: The dummy color converter.

◆ GetColorConverterForActiveDocument()

static const OcioConverterRef& GetColorConverterForActiveDocument ( )

static

Returns a converter to convert colors along the OCIO conversion paths defined by the currently active document.

Returns: The converter for the active document or the dummy converter if there is no active document.

◆ PrivateSetBaseRepository()

maxon::Result<void> PrivateSetBaseRepository ( const maxon::UpdatableAssetRepositoryRef & baseRepo )

PrivateSetBaseRepository is a private functions to add a base asset repository base to the current document document. This can be used for preview renderings to connect the textures/nodes from the local scene repository.

Parameters

[in] baseRepo repository to set as base in the current scene repository.

Returns: OK on success.

◆ GetCacheRunId()

Int GetCacheRunId ( ) const

Returns the current build run id (for cache building). This id increases for every cache build run of the document. This value is used in maxon::MemoizationCacheInterface.

◆ HasUncachedDynamics()

Bool HasUncachedDynamics ( ) const

Checks if the scene contains uncached dynamics. Even the scene contains i.e. cloth, rope or dynamics objects/tags this function still return false when all objects are cached.

Returns: True if dynamics that are not cached are present, otherwise false.

Detailed Description

Private Member Functions

Alloc/Free/Flush

Target Object

Navigation

Data/Settings

Object/Material/Tag/Render Data

Search Object/Material

Changed State

Name/Path

LOD

Time

Mode/Action

Undo

Key

BaseDraw

Pick Session

Miscellaneous

Take Data

Additional Inherited Members

Constructor & Destructor Documentation

◆ BaseDocument()

◆ ~BaseDocument()

Member Function Documentation

◆ Alloc()

◆ Free()

◆ Flush()

◆ GetNext() [1/2]

◆ GetNext() [2/2]

◆ GetPred() [1/2]

◆ GetPred() [2/2]

◆ GetData()

◆ SetData()

◆ GetSettingsInstance() [1/2]

◆ GetSettingsInstance() [2/2]

◆ GetNetRenderDocumentContext()

◆ SetNetRenderDocumentContext()

◆ GetFirstObject()

◆ GetFirstMaterial()

◆ GetFirstRenderData()

◆ GetFirstSceneHook()

◆ InsertObject()

◆ InsertMaterial()

◆ InsertRenderData()

◆ InsertRenderDataLast()

◆ GetActiveObject() [1/2]

◆ GetActiveObject() [2/2]

◆ GetActiveMaterial() [1/2]

◆ GetActiveMaterial() [2/2]

◆ GetActiveTag() [1/2]

◆ GetActiveTag() [2/2]

◆ GetActiveRenderData() [1/2]

◆ GetActiveRenderData() [2/2]

◆ GetRealActiveObject()

◆ GetActiveObjects()

◆ GetActivePolygonObjects()

◆ GetActiveObjectsFilter()

◆ GetActiveMaterials()

◆ GetActiveTags()

◆ GetSelection()

◆ SetActiveObject()

◆ SetActiveMaterial()

◆ SetActiveTag()

◆ SetActiveRenderData()

◆ SetSelection()

◆ SearchObject()

◆ SearchMaterial()

◆ GetChanged()

◆ SetChanged()

◆ GetDocumentName()

◆ GetDocumentPath()

◆ SetDocumentName()

◆ SetDocumentPath()

◆ GetLOD()

◆ SetLOD()

◆ GetRenderLod()

◆ SetRenderLod()

◆ GetTime()

◆ SetTime()

◆ GetFps()