What was New in R18

The Python API in R18 brings important additions and more C++ API coverage. It also carries some API changes and fixes several issues.

In R18.020

New Features Support

• MoGraph Weight Paintbrush: The new function c4d.modules.mograph.GeGetMoDataWeights() supports the weights workflow

• Vertex Colors: The new c4d.VertexColorTag class allows to access the Vertex Color tag and its data

• Color Chooser: The new module c4d.modules.colorchooser is a new API for the Color Chooser swatches

• Substance Engine: The new module c4d.modules.substance provides functions to handle Substance shaders and graphs

• Object Tracker: The new module c4d.modules.motiontracker allows to retrieve object tracking data

• Animation: Quaternion Rotation Mode new methods/parameters in c4d.BaseObject, c4d.CKey, c4d.CCurve and c4d.CTrack

• c4d.Vector4d class allows to manipulate four-dimensional vectors (e.g. RGB colors with alpha value for Vertex Colors)

• Draw HUD text to the viewport with the new methods BaseDraw.DrawHUDText() and BaseDraw.DrawMultipleHUDText()

API Parity

Here are the additions in R18 for the ongoing effort on parity with the C++ API:

• Dynamic Descriptions: NodeData.GetDDescription()/NodeData.GetDParameter()/NodeData.SetDParameter() and enhanced c4d.Description class

• BodyPaint 3D UV commands: c4d.modules.bodypaint.CallUVCommand() and c4d.modules.bodypaint.GetActiveUVSet()/c4d.modules.bodypaint.FreeActiveUVSet()

• Texture Baking: c4d.utils.InitBakeTexture()/c4d.utils.BakeTexture()

• c4d.plugins.ObjectData Automated Handle Interface: GetHandle()/SetHandle()/GetHandleCount()

• Custom GUIs: c4d.gui.BaseCustomGui class is no longer empty and now provides the same methods as in C++ (e.g. BaseCustomGui.GetData()/BaseCustomGui.SetData())

• Miscellaneous: c4d.InExcludeData missing methods, c4d.modules.mograph.GeGetMoDataSelection()

New Plugins and Scripts Examples

• Plugins:

  • Dynamic Description Parameters: Py-DynamicParametersObject

  • Texture Baking and Threads: Py-TextureBaker

• Scripts:

  • MoGraph Weights and Selection: GeGetMoDataSelection.py, GeGetMoDataWeights.py

  • Vertex Colors: VertexColorTag_PointMode.py and VertexColorTag_PolygonMode.py

  • BodyPaint 3D UV Commands: CallUVCommand.py

  • Descriptions: CheckDescID.py, CreatePopupMenu.py, GetSubDescriptionWithData.py

API Changes

• Removed ReflectionLayer.name, ReflectionLayer.layerID and ReflectionLayer.flags attributes

  Instead use new methods ReflectionLayer.GetName()/SetName(), ReflectionLayer.GetLayerID() and ReflectionLayer.GetFlags()/SetFlags()

• FalloffData.Draw() return value changed from bool to DRAWRESULT. Returning a bool is still supported for backward compatibility

• ID_MODELING_KNIFE_TOOL was removed

Fixes

• HyperFile.WriteFloat32() writes wrong value and corrupts stack

• c4d.modules.render.InitRenderStruct not correctly initialized with a document

• BaseList2D.SetLayerObject() parameter layer can be None

• TextureTag.GetMaterial() can now be passed parameter ignoredoc. The parameter is optional and by default True for backward compatibility

• Freeze after raised AttributeError in GeDialog.Message() when message BFM_WEIGHTS_CHANGED was received

• SplineHelp.GetLineObject() crashes if not initialized with SPLINEHELPFLAGS_RETAINLINEOBJECT

In R18.039

API Additions

• The new class c4d.VoronoiFracture allows to access and create Voronoi fracture objects

• GeSetMoDataSelection() and GeSetMoDataWeights() set MoGraph clones selection and weights

• c4d.utils.RadToDeg() and c4d.utils.DegToRad() functions have been added. These functions should be used instead of c4d.utils.Deg() and c4d.utils.Rad()

Fixes

• XPresso Python node Activation port not working

• c4d.modules.bodypaint.CallUVCommand() does not change UV data

• Drag&Drop in dialogs and user areas does not handle commands

• TakeData.GetTakeSelection() is broken

New Scripts Examples

• MoGraph Weights and Selection: GeSetMoDataSelection.py, GeSetMoDataWeights.py

• c4d.VoronoiFracture: VoronoiFracture.py

Documentation Changes

• Added missing documentation for the following class, functions and methods:

  • c4d.gui.TreeViewFunctions

  • c4d.utils: DisjointMesh(), FitCurve(), CheckDisplayFilter(), CalculateVisiblePoints(), GenerateUVW(), GetBBox(), FormatNumber(), StringToNumber()

  • BaseDrawHelp.GetDisplay()

  • GeDialog.GetItemDim()

• Updated information for PolygonObject.GetNgonEdgesCompact()

• Py-DoubleCircle and Py-RoundedTube examples:

  • Removed implementation of MoveHandle() and DetectHandle()

  • Fixed to use the c4d.plugins.ObjectData Automated Handle Interface functions GetHandle()/SetHandle()/GetHandleCount()

In R18.057

API Additions

• The addition of GvNode.OperatorSetData() allows to simulate dragging onto an XPresso node

• The parameters dirty and trans have been added to BaseObject.GetHierarchyClone()/BaseObject.GetAndCheckHierarchyClone()

  Also the functions no longer return only None when the cloned object is None. It has been changed to always return a dictionary with clone and dirty keys

  With these changes BaseObject.GetHierarchyClone()/BaseObject.GetAndCheckHierarchyClone() have the same behavior as their C++ API counterparts

Fixes

• MessageData timer fires too often

• c4d.Cast() returns a copy of a BaseContainer instead of a reference

• Cannot set RELAXUV_EDGESEL_POINTER for CallUVCommand() settings

• c4d.GenerateTexturePath() freezes if called with a NetRenderService and/or a BaseThread

• BaseDraw.DrawPoints() vc and vn optional parameters can be None

• DescID.IsPartOf() cmp parameter cannot be None

• Wrong index range check in UVWTag.CpySlow()

• Description.GetParameterI() crashes

API Changelist

See API Changelist R18 page.