就业培训     下载中心     Wiki     联络 登录   注册

---

// define render settings RenderData * const rdata = virtualDoc-> GetActiveRenderData (); if (rdata == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); BaseContainer renderSettings = rdata-> GetData (); renderSettings. SetFloat ( RDATA_XRES , width); renderSettings. SetFloat ( RDATA_YRES , height);

// render the document const RENDERFLAGS flags = RENDERFLAGS::NODOCUMENTCLONE ; const RENDERRESULT res = RenderDocument (virtualDoc, renderSettings, nullptr , nullptr , bitmap, flags, nullptr ); if (res != RENDERRESULT::OK ) return maxon::UnknownError( MAXON_SOURCE_LOCATION );

// show result ShowBitmap (bitmap);

Access

Cinema 4D can handle multiple open scenes in a document list:

• GetActiveDocument() ：返回 BaseDocument that is currently displayed in the editor.
• GetFirstDocument() : Returns the first BaseDocument of the list of open documents.

To navigate the document list GetNext() and GetPred() can be used:

• BaseDocument::GetNext() : Returns the next document in the list.
• BaseDocument::GetPred() : Returns the previous document in the list.

// use GeMarker to compare identity of the BaseDocuments if (docMarker. IsEqual (activeDocMarker)) { ApplicationOutput ( "Document: " + document-> GetDocumentName (). GetString () + " *" ); } else { ApplicationOutput ( "Document: " + document-> GetDocumentName (). GetString ()); } document = document-> GetNext (); }

注意

GetActiveDocument() and GetFirstDocument() only work in Cinema 4D versions that have an active document (not in Team Render Client, Command Line etc.). Use GetActiveDocument() only in combination with dialogs etc. but NEVER in NodeData based plugins or expressions.

GeListNode::GetDocument() returns the BaseDocument that hosts a given entity. Use this method to access the document in a NodeData based plugin and all functions that are part of the execution or drawing pipeline. But never forget to check for nullptr , as there are situations where elements are not part of any document at all.

Allocation/Deallocation

A BaseDocument can be created with the usual tools:

• BaseDocument::Alloc() : Creates a new BaseDocument .
• BaseDocument::Free() : Deletes the given BaseDocument .

AutoAlloc can be used to handle a temporary document. A new document can be added to the document list:

• InsertBaseDocument() : Inserts the given BaseDocument into the document list of Cinema 4D .
• SetActiveDocument() : Sets the given document as the active document.
• CloseAllDocuments() : Closes all documents of the document list.

// create new document BaseDocument * const newDocument = BaseDocument::Alloc (); if (newDocument == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// insert document as the active document. InsertBaseDocument (newDocument); SetActiveDocument (newDocument);

// set document file name newDocument-> SetDocumentName ( "new_document.c4d" );

// update Cinema EventAdd ();

注意

BaseDocuments can also be created by loading Cinema 4D files. See Disc I/O below.

Destroy

A dynamically created BaseDocument should be destroyed with BaseDocument::Free() . To remove a BaseDocument from the document list use KillDocument() .

• KillDocument() : Removes the given BaseDocument safely from the document list and frees all of its resources.
• BaseDocument::Flush() : Clears the BaseDocument .

拷贝

BaseDocument is based on C4DAtom and can be cloned using C4DAtom::GetClone() :

预览图像

When a scene is saved the current editor image is saved with the BaseDocument to create a thumbnail preview image.

• BaseDocument::GetDocPreviewBitmap() : Returns the preview image of the BaseDocument .

特性

数据

Multiple settings are stored inside the BaseDocument . The different types of settings are defined in DOCUMENTSETTINGS , the parameter IDs in ddoc.h .

• BaseDocument::GetData(DOCUMENTSETTINGS) : Returns a BaseContainer with selected settings.
• BaseDocument::SetData() : Merges the given BaseContainer with the document's settings.
• BaseDocument::GetSettingsInstance() : Returns a pointer to the BaseContainer with the selected settings.

// set new settings BaseContainer settings; 设置。 SetBool ( DOCUMENT_USEGENERATORS , !useGenerators); doc-> SetData ( DOCUMENTSETTINGS::GENERAL , settings);

and

注意

BaseDocument::GetSettingsInstance() won't work with DOCUMENTSETTINGS::GENERAL .

对象

A BaseDocument hosts multiple BaseObject based scene objects. These objects are organized in an object tree.

• BaseDocument::GetFirstObject() : Returns the first BaseObject of the scene.
• BaseDocument::InsertObject() : Inserts a BaseObject into the scene.
• BaseDocument::SearchObject() : Searches for a BaseObject with the given name.

注意

使用 BaseDocument::InsertObject() will trigger the message MSG_DOCUMENTINFO_TYPE_OBJECT_INSERT .

另请参阅 BaseObject Manual .

In some cases multiple instances of a certain object class can be inserted into the scene but only one instance will be used (e.g. the Sky object). This is typically the "highest" instance.

• BaseDocument::GetHighest() : Typically used to get the only useful instance of an object type.

材质

A BaseDocument hosts multiple BaseMaterial based materials. These materials are stored in a list and can be applied to objects in the scene.

• BaseDocument::GetFirstMaterial() : Returns the first BaseMaterial in the list.
• BaseDocument::InsertMaterial() : Inserts a BaseMaterial into the list.
• BaseDocument::SearchMaterial() : Searches for a BaseMaterial with the given name.

另请参阅 BaseMaterial Manual

// search material BaseMaterial * const material = doc-> SearchMaterial ( "Green" _s); if (material) { ApplicationOutput ( "Found \"Green\"" _s); return maxon::OK ; }

// create material BaseMaterial * const greenMaterial = BaseMaterial::Alloc ( Mmaterial ); if (greenMaterial == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION ); greenMaterial-> SetName ( "Green" _s);

// insert material into the document doc-> InsertMaterial (greenMaterial);

选择

Inside a scene multiple objects, materials or tags can be selected.

• BaseDocument::GetSelection() : Fills the given AtomArray with the selected objects and tags.
• BaseDocument::SetSelection() : Adds the given element to the current selection or starts a new selection.

// check if the given C4DAtom is a BaseList2D element const Bool validElement = element != nullptr ; if (validElement && element-> IsInstanceOf ( Tbaselist2d )) { BaseList2D * baseList2D = static_cast< BaseList2D * > (element); ApplicationOutput (baseList2D-> GetName () + " (" + baseList2D-> GetTypeName () + ")" ); } else { return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); } }

Object selections can be managed separately:

• BaseDocument::GetActiveObject() : Returns the currently selected BaseObject .
• BaseDocument::GetActiveObjects() : Returns the current multi-selection of BaseObject 对象。
• BaseDocument::GetActivePolygonObjects() : Returns the currently selected polygon objects.
• BaseDocument::GetActiveObjectsFilter() : Returns the currently selected BaseObjects that match the given filters.
• BaseDocument::GetRealActiveObject() : Returns the "real" active object. Either the active object, the helper axis of a multi-selection or the position of a workplane in workplane mode.
• BaseDocument::SetActiveObject() : Adds or removes the given BaseObject to the selection or starts a new selection.
• BaseDocument::GetTargetObject() : Returns the target object (the last selected object).
• BaseDocument::SetTargetObject() Sets the given object as the target object.

注意

To get the position of the anchor of an object multi-selection one can use BaseDocument::GetHelperAxis() .

To correctly add objects to the selection of active objects with BaseDocument::SetActiveObject() one must update internal caches by calling BaseDocument::GetActiveObject() after an object was added to the selection.

// get all selected null objects AutoAlloc<AtomArray> selection; if (selection == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION ); doc-> GetActiveObjectsFilter (selection, true , Onull , NOTOK ); const Int32 cnt = selection-> GetCount (); if (cnt == 0) return maxon::IllegalArgumentError( MAXON_SOURCE_LOCATION );

// clear object selection doc-> SetActiveObject ( nullptr ); for ( Int32 i = 0; i < cnt; ++i) { C4DAtom * element = selection-> GetIndex (i); const BaseObject * const nullobject = static_cast< BaseObject * > (element); if (nullobject == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION );

// create a cube BaseObject * const cube = BaseObject::Alloc ( Ocube ); if (cube == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION ); const 矩阵 nullMg = nullobject-> GetMg (); cube-> SetMg (nullMg); doc-> InsertObject (cube, nullptr , nullptr ); doc-> SetActiveObject (cube, SELECTION_ADD ); }

材质 selections can be managed separately, too:

• BaseDocument::GetActiveMaterial() : Returns the currently selected BaseMaterial .
• BaseDocument::GetActiveMaterials() : Returns the current multi-selection of BaseMaterial 对象。
• BaseDocument::SetActiveMaterial() : Adds or removes the given BaseMaterial to the selection or starts a new selection.

// get texture tag BaseTag * const tag = object ->GetTag( Ttexture ); if (tag == nullptr ) return maxon::IllegalArgumentError( MAXON_SOURCE_LOCATION );

// get material TextureTag * const ttag = static_cast< TextureTag * > (tag); BaseMaterial * const material = ttag-> GetMaterial ();

// set active material if (material != nullptr ) doc-> SetActiveMaterial (material, SELECTION_NEW );

Finally tag selections can be managed:

• BaseDocument::GetActiveTag() : Returns the currently selected BaseTag .
• BaseDocument::GetActiveTags() : Returns the current multi-selection of BaseTag 对象。
• BaseDocument::SetActiveTag() : Adds or removes the given BaseTag to the selection or starts a new selection.

// get all selected tags AutoAlloc<AtomArray> tags; if (tags == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION ); doc-> GetActiveTags (tags); const Int32 cnt = tags-> GetCount (); if (cnt == 0) return maxon::IllegalArgumentError( MAXON_SOURCE_LOCATION ); for ( Int32 i = 0; i < cnt; i++) { C4DAtom * const tag = tags-> GetIndex (i); if (tag == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION );

// check if texture tag if (tag-> GetType () == Ttexture ) { // set material TextureTag * ttag = static_cast< TextureTag * > (tag); ttag-> SetMaterial (material); } }

RenderData

RenderData objects represent the render settings stored in a document. They allow access to the actual settings, multipass objects and post effects.

• BaseDocument::GetActiveRenderData() : Returns the active RenderData .
• BaseDocument::SetActiveRenderData() : Sets the given RenderData as the active one.
• BaseDocument::GetFirstRenderData() : Returns the first RenderData .
• BaseDocument::InsertRenderData() : Adds the given RenderData object to the document.
• BaseDocument::InsertRenderDataLast() : Adds the given RenderData object to the document at last position.

另请参阅 RenderData Manual .

Scene Hooks

Scene hooks are used to add additional data to the document or to influence the execution pipeline. These scene hooks are stored in the document:

• BaseDocument::FindSceneHook() : Returns the instance of the scene hook with the given ID that is stored in the document.

// gets the dynamics scene hook BaseSceneHook * const dynamicsHook = doc-> FindSceneHook (180000100); if (dynamicsHook == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); BaseContainer & bc = dynamicsHook-> GetDataInstanceRef (); bc. SetBool ( WORLD_ENABLED , false );

层

Layers are used to organize a document. A layer is represented by a LayerObject and these LayerObject objects are organized in a tree:

• BaseDocument::GetLayerObjectRoot() ：返回 GeListHead root object of the layer tree.

另请参阅 Layer Manual .

Takes

Takes allow to handle multiple versions of a scene within the same document. The takes of a document are stored in a TakeData object:

• BaseDocument::GetTakeData() ：返回 TakeData object storing the takes of the document.

见 Take System Overview

Changed Mode

The change status of a document indicates that the scene was changed after the last time it was saved. The status is displayed with a little star (*) in the application title bar.

• BaseDocument::GetChanged() : Returns true if the scene was changed.
• BaseDocument::SetChanged() : Sets the scene as changed.

// check dirty state of the document if (activeDoc-> GetChanged () == false ) KillDocument (activeDoc);

Document Name and Path

A document is presented in the application using its filename. Because of this the name of the document cannot be obtained with BaseList2D::GetName() that returns a String and not a Filename .

• BaseDocument::GetDocumentName() : Returns the document name (filename including suffix).
• BaseDocument::GetDocumentPath() : Returns the document's save path.
• BaseDocument::SetDocumentName() : Sets the document's name.
• BaseDocument::SetDocumentPath() : Sets the document's save path.

// check if the suffix is defined if (suffix. IsPopulated ()) { if (suffix == "c4d" ) ApplicationOutput ( "Cinema 4D File" _s); else ApplicationOutput ( "Filetype: " + suffix); } else { ApplicationOutput ( "unsaved document" _s); }

Level of Detail

The level of detail defines how detailed certain objects are displayed in the editor. This is typically used in custom ObjectData based generators.

• BaseDocument::GetLOD() : Returns the document LOD value.
• BaseDocument::SetLOD() : Sets the document LOD value.
• BaseDocument::GetRenderLod() : Returns true if the render LOD should be applied in the editor.
• BaseDocument::SetRenderLod() : Defines if the render LOD should be applied in the editor.
• CalcLOD() : Helper function to modify a user chosen subdivision value.

// check if the document uses render LOD in the editor if (doc-> GetRenderLod () == false ) { RenderData * const renderData = doc-> GetActiveRenderData (); if (renderData == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); const BaseContainer bc = renderData-> GetDataInstanceRef (); const Float lod = bc. GetFloat ( RDATA_LOD );

// set new LOD doc-> SetLOD (lod); }

注意

The LOD buttons in the editor represent the values 25%, 50% and 100%.

时间

The current timeline position of a document and the timeline size is defined using BaseTime 对象。

注意

Setting the current time will not animate the document. See paragraph 动画 below.

Current time:

• BaseDocument::GetTime() : Returns a BaseTime storing the current time.
• BaseDocument::SetTime() : Sets the current time of the document using a BaseTime 对象。
• SetDocumentTime() : Sets the given document's time.

// animate document doc-> ExecutePasses ( nullptr , true , true , true , BUILDFLAGS::NONE );

Framerate:

• BaseDocument::GetFps() : Returns the document's framerate.
• BaseDocument::SetFps() : Sets the document's framerate.

注意

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.

Timeline dimensions:

• BaseDocument::GetMinTime() : Returns the start time of the document's timeline.
• BaseDocument::SetMinTime() : Sets the start time of the document's timeline.
• BaseDocument::GetMaxTime() : Returns the end time of the document's timeline.
• BaseDocument::SetMaxTime() : Sets the end time of the document's timeline.

Used Time:

• BaseDocument::GetUsedMinTime() : Returns the lower bound of used time for the whole document or the given object.
• BaseDocument::GetUsedMaxTime() : Returns the upper bound of the used time for the whole document or the given object.

Loop Preview:

• BaseDocument::GetLoopMinTime() : Returns the lower bound of the document's loop preview.
• BaseDocument::SetLoopMinTime() : Sets the lower bound of the document's loop preview.
• BaseDocument::GetLoopMaxTime() : Returns the upper bound of the document's loop preview.
• BaseDocument::SetLoopMaxTime() : Sets the lower bound of the document's loop preview.

// current loop duration const BaseTime loopDuration = doc-> GetLoopMaxTime () - doc-> GetLoopMinTime ();

// move loop to the start doc-> SetLoopMinTime (minTime); doc-> SetLoopMaxTime (minTime + loopDuration);

模式

A document can be in different modes defining which elements should be edited (objects, points, edges, etc.).

• BaseDocument::GetMode() : Returns the current mode.
• BaseDocument::SetMode() : Sets the current mode.
• BaseDocument::IsEditMode() : Checks if the current mode is Mpoints , Medges or Mpolygons .
• BaseDocument::IsAxisEnabled() : Returns true if the axis modifier is enabled and the axis should be edited.

// check tag type switch (tag-> GetType ()) { case Tpointselection : doc-> SetMode ( Mpoints ); break ; case Tpolygonselection : doc-> SetMode ( Mpolygons ); break ; case Tedgeselection : doc-> SetMode ( Medges ); break ; }

Active Tool

The currently active tool is stored in the document.

• BaseDocument::GetAction() : Returns the ID of the currently used tool.
• BaseDocument::SetAction() : Sets the currently used tool.
• GetToolData() ：返回 BaseContainer storing the settings of the tool of the given ID.

注意

To edit the settings of the Move/Scale/Rotate tools the actual plugin instance has to be accessed with FindPlugin() .

Axis and Plane

The helper axis represents the position of the handles used to move a multi-selection.

• BaseDocument::GetHelperAxis() : Returns a BaseObject representing the helper axis.

// check if model mode if (doc-> GetMode () != Mmodel ) return maxon::IllegalArgumentError( MAXON_SOURCE_LOCATION );

// get helper object and matrix const BaseObject * const helperAxis = doc-> GetHelperAxis (); if (helperAxis == nullptr ) return maxon::IllegalArgumentError( MAXON_SOURCE_LOCATION ); const 矩阵 matrix = helperAxis-> GetMg ();

// create null object BaseObject * const nullObject = BaseObject::Alloc ( Onull ); if (nullObject == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION ); doc-> InsertObject (nullObject, nullptr , nullptr ); nullObject-> SetMg (matrix);

// make selected object child of the new null for ( Int32 i = 0; i < objectCnt; ++i) { C4DAtom * element = selection-> GetIndex (i); BaseObject * const baseObject = static_cast< BaseObject * > (element); if (baseObject == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); const 矩阵 position = baseObject-> GetMg (); baseObject-> 移除 (); doc-> InsertObject (baseObject, nullObject, nullptr ); baseObject-> SetMg (position); }

• BaseDocument::GetSplinePlane() : Returns the plane that should be used for new splines. Depends on the currently selected editor window.

Editor Windows

An editor window is represented by a BaseDraw object. Such a BaseDraw object allows access to the currently used camera. The render view is the editor window used to define the camera that will be used while rendering the final image.

• BaseDocument::GetActiveBaseDraw() ：返回 BaseDraw of the currently active editor window.
• BaseDocument::GetRenderBaseDraw() ：返回 BaseDraw that should be used as the render view. This function should be used in NodeData based plugins.
• BaseDocument::GetBaseDrawCount() : Returns the number of current editor windows.
• BaseDocument::GetBaseDraw() ：返回 BaseDraw with the given index.
• BaseDocument::ForceCreateBaseDraw() : Called to enforce at least one BaseDraw is available.
• BaseDocument::GetDrawTime() : Returns the editor redraw time.

另请参阅 BaseView / BaseDraw Manual .

// move active object into the camera view const 矩阵 cameraMatrix = cameraObject-> GetMg (); 矩阵 targetPosition = activeObject-> GetMg (); targetPosition. off = cameraMatrix. off + (900.0 * cameraMatrix. sqmat . v3 ); activeObject-> SetMg (targetPosition);

Net Context

If the document is currently handled inside a Team Render context can be checked using the net render context:

• BaseDocument::GetNetRenderDocumentContext() : Returns a NetRenderDocumentContext object during NET rendering.
• BaseDocument::SetNetRenderDocumentContext() : Only used internally.

Functionality

动画

Scene elements can be animated by setting keyframes with specific values at a specific time. The BaseDocument class offers functions to create such keyframes:

• BaseDocument::RecordKey() : Creates a key at the given time for the given parameter.
• BaseDocument::AutoKey() : Creates keys automatically if auto key mode is enabled.
• BaseDocument::Record() : Creates keyframes for all selected objects. Parameters must be added to the keyframe selection.

// edit the object cubeObject-> SetParameter ( DescID ( PRIM_CUBE_SUBX ), 10, DESCFLAGS_SET::NONE ); cubeObject-> SetParameter ( DescID ( PRIM_CUBE_SUBY ), 10, DESCFLAGS_SET::NONE ); cubeObject-> SetParameter ( DescID ( PRIM_CUBE_SUBZ ), 10, DESCFLAGS_SET::NONE );

// create auto keys if "Auto Key" is enabled. doc-> AutoKey (undoObject, cubeObject, true , true , true , true , true , true ); BaseObject::Free (undoObject);

另请参阅 Animation Tracks .

To apply keyframe animation, expressions, generators and deformers the document has to be animated.

• BaseDocument::AnimateObject() : Animates the given object at the given frame.
• BaseDocument::ExecutePasses() : Animates the whole document. One might have to call BaseDocument::ExecutePasses() multiple times to fully animate up to a given frame.
• RunAnimation() : Controls the animation of the given document.

// save current frame const BaseTime originalTime = doc-> GetTime (); for ( Int32 i = 0; i < 30; ++i) { BaseTime time(i, doc-> GetFps ()); doc-> SetTime (time); doc-> ExecutePasses ( nullptr , true , true , true , BUILDFLAGS::INTERNALRENDERER ); BaseObject * const cube = doc-> SearchObject ( "Cube" _s); if (cube) { const 向量 position = cube-> GetMg (). off ; ApplicationOutput ( "Cube Position: " + String::VectorToString (position)); } }

// reset frame doc-> SetTime (originalTime);

When a new keyframe is created a default template is used. This template can be edited:

• BaseDocument::GetDefaultKey() : Returns the default key template.
• BaseDocument::SetDefaultKey() : Sets the default key template.

// new keys should use linear interpolation key-> SetInterpolation ( nullptr , CINTERPOLATION::LINEAR ); doc-> SetDefaultKey (key, overdub);

The result of simulations is often iterative: The current frame depends on the results of previous calculations. To calculate the state of a particle simulation at a certain frame all frames before that have to be calculated:

• BaseDocument::SetRewind() : The document will be animated from frame 0 to the current frame when an update event EVMSG_CHANGE is triggered. Typically triggered in NodeData::SetDParameter() . During this rewind no caches are build.
• BIT_DOCUMENT_CHECKREWIND : Will cause the document to animate from 0 if the current time is earlier than the last execution time.

// access PARTICLEOBJECT_STOP parameter DescID particleStopID( PARTICLEOBJECT_STOP ); if (particleEmitter->GetParameter(particleStopID, data, DESCFLAGS_GET::NONE ) == false ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); const BaseTime endTime = data. GetTime (); doc-> SetTime (endTime); doc-> SetRewind ();

Undo

The undo system of Cinema 4D allows to store operations in undo actions that can be executed to undo and redo user interaction.

• BaseDocument::StartUndo() : Starts an undo action. Must be paired with BaseDocument::EndUndo() .
• BaseDocument::AddUndo() : Adds an undo operation to the current action.
• BaseDocument::GetUndoPtr() : Returns the pointer to the element of the last operation.
• BaseDocument::FindUndoPtr() : Returns the pointer to the element of the last operation of the given undo type.
• BaseDocument::EndUndo() : Ends an undo action.

另请参阅 Undo System Manual .

Undo actions can be executed:

• BaseDocument::DoUndo() : Performs the undo action.
• BaseDocument::DoRedo() : Performs the redo action.
• BaseDocument::FlushUndoBuffer() : Flushes the undo buffer.

Pick Session

A pick session can be used to select multiple objects.

• BaseDocument::GetPickSession() : Gets the data structure of the current pick session.
• BaseDocument::StartPickSession() : Starts a pick session.
• BaseDocument::StopPickSession() : Ends the pick session.

见 PickSessionDataStruct .

Send Messages

• BaseDocument::SendInfo() : sends a MSG_DOCUMENTINFO message to all document elements. This is typically not needed for plugins.

Convert and Export

The objects of a BaseDocument can be converted to polygon objects and associated sounds and textures can be collected:

• BaseDocument::Polygonize() : Returns a copy of the document in which all objects are converted to polygon objects. The source code is available in c4d_basedocument.cpp .
• BaseDocument::CollectSounds() : Creates a downmix of all sounds of the document's sound mix.
• BaseDocument::GetAllTextures() : Sends the MSG_GETALLASSETS message to collect the assets of the given selection or the whole document.
• GetAllAssets() : Retrieves all assets from a document.

// loop through elements of the BaseContainer while (browse.GetNext(& id , &data)) { // check if the found element is a Filename if (data != nullptr ) { if (data-> GetType () == DA_FILENAME ) ApplicationOutput ( "Texture: " + data-> GetFilename (). GetString ()); } }

• IsolateObjects() : Creates a new document that contains only copies of the given objects and their materials.

Disc I/O

A BaseDocument can be created by reading if from a file on disc. It is possible to load *.c4d files and supported import file formats.

• LoadFile() : Used to load a file. A loaded Cinema 4D file will be automatically added to the document list.

  注意

  LoadFile() does not work with a Filename in Memory Read Mode, in this case use LoadDocument() instead.

• LoadDocument() : Will load a given Cinema 4D file into a BaseDocument object. Do not forget to set the scene filter flags.
• MergeDocument() : Loads and merges the given Cinema 4D file into the given BaseDocument .

The list of recently opened scene files is accessed with:

• GetRecentDocumentsList() : Returns the list of recently opened scene files.

// check if the Filename references a "c4d" file if (filename.CheckSuffix( "c4d" _s)) { BaseDocument * loadedDoc = LoadDocument (filename, SCENEFILTER::NONE , nullptr ); if (loadedDoc == nullptr ) return maxon::IoError( MAXON_SOURCE_LOCATION , MaxonConvert (filename, MAXONCONVERTMODE::NONE ), "Could not load document." _s); const Int32 fps = loadedDoc-> GetFps (); const Int32 startFrame = loadedDoc-> GetMinTime (). GetFrame (fps); const Int32 endFrame = loadedDoc-> GetMaxTime (). GetFrame (fps); BaseDocument::Free (loadedDoc);

// convert to String to print the data to the console const String fileStr = filename.GetString(); const String startFrameStr = String::IntToString (startFrame); const String endFrameStr = String::IntToString (endFrame);

// print to console ApplicationOutput ( "Document " + fileStr + ": " + startFrameStr + " - " + endFrameStr); }

• SaveDocument() : Saves the document to a Cinema 4D file or to a supported export file format.
• SaveProject() : Saves the document like the "Save Project with Assets" command.

渲染

A BaseDocument can be rendered independently from the GUI and the Picture Viewer into a BaseBitmap (见 BaseBitmap Manual ).

• RenderDocument() : Renders the given BaseDocument using the given render settings.

// auto free the loaded document AutoFree<BaseDocument> docFree; docFree. 赋值 (loadedDoc); RenderData * const rdata = loadedDoc-> GetActiveRenderData (); if (rdata == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); BaseContainer renderSettings = rdata-> GetData ();

// just render one frame const BaseTime startFrame = renderSettings. GetTime ( RDATA_FRAMEFROM , BaseTime ()); renderSettings. SetTime ( RDATA_FRAMETO , startFrame);

// prepare target bitmap AutoAlloc<BaseBitmap> bitmap; if (bitmap == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION ); const Int32 width = renderSettings. GetInt32 ( RDATA_XRES ); const Int32 height = renderSettings. GetInt32 ( RDATA_YRES ); const IMAGERESULT imageRes = bitmap-> Init (width, height); if (imageRes != IMAGERESULT::OK ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// render the image const RENDERFLAGS renderFlags = RENDERFLAGS::NODOCUMENTCLONE ; const RENDERRESULT res = RenderDocument (loadedDoc, renderSettings, nullptr , nullptr , bitmap, renderFlags, nullptr ); if (res != RENDERRESULT::OK ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION );

// show result ShowBitmap (bitmap);

Messages

On certain events (load, save, render,...) a MSG_DOCUMENTINFO message is sent to elements contained in a document.

• MSG_DOCUMENTINFO : The message that is sent.
• DocumentInfoData : The data that is sent with that message.

// switch message sub-type switch (msg-> type ) { case MSG_DOCUMENTINFO_TYPE_LOAD : { BaseObject * const op = static_cast< BaseObject * > (node); if (!op) return false ; BaseContainer & bc = op-> GetDataInstanceRef (); bc. SetInt32 (NEW_PARAMETER, bc. GetInt32 (OLD_PARAMETER)); ApplicationOutput ( "document is loaded" _s); break ; } } break ; }

Futher document related messages:

• MSG_MULTI_DOCUMENTCLONED : The document has been cloned. This happens for example when the document is rendered in the Picture Viewer.
• MSG_MULTI_DOCUMENTIMPORTED : The document has been imported.

延伸阅读

• Scene Data Overview
• Take System Overview
• Layer Manual
• Undo System Manual
• RenderData Manual
• BaseObject Manual
• BaseMaterial Manual
• BaseView / BaseDraw Manual
• BaseBitmap Manual