What is New

Note

New additions to the CINEMA 4D Python SDK are marked like this throughout the documentation:

New in version R13.058.

Important New Features in R13

• MoGraph access : New module c4d.modules.mograph.
• Shader API : New module c4d.modules.render and plugin data class ShaderData.

In R13.058

Additions:

• BaseContainer.GetClone()
• BaseView.PW_S(), BaseView.WP_S(), BaseView.PW_W(), BaseView.WP_W(), BaseView.ProjectPointOnLine(), BaseView.ProjectPointOnPlane()
• HandleInfo.radius, HandleInfo.center, HandleInfo.CalculateNewPosition()

Miscellaneous changes:

• Gradient.InvertKnots() now returns a bool.
• BaseSelect.SelectAll() now works as expected.

Changes in the documentation:

• Handles are now working in the examples : see Py-DoubleCircle, Py-RoundedTube and Py-SpherifyModifier.
• New example added for TagData plugins : Py-LookAtCamera.
• Information on getting the generator in a Python effector.
• New section in RenderData : Rounding of Floating Point Values.
• New section in Plugin Structure about C4DPL_RELOADPYTHONPLUGINS message : Python Plugins Reloading.
• Cleanup (typos and small fixes) and missing functions/methods parameters documentation added.

You can also read the changelog for R13.058 here.

In R13.051

MemoryFileStruct is now accepted by these functions:

• BaseBitmap.InitWith()
• GeClipMap.InitWith()
• ColorProfile.OpenProfileFromFile()
• ColorProfile.WriteProfileToFile()
• LoadFile()
• LoadDocument()
• MergeDocument()
• SaveDocument()

These functions were implemented in past releases but were not documented:

• GeGetMovieInfo() and GeIdentifyFile()
• MoData.GetFalloffs(), MoData.GetCurrentIndex() and MoData.GetBlendID()
• BaseObject.GetAndCheckHierarchyClone() and BaseObject.GetHierarchyClone()

In R13.029

MemoryFileStruct is now accepted by these functions:

• BaseBitmap.Save()
• MovieLoader.Open()
• MovieSaver.Open()
• SaveShortcutSet()
• LoadShortcutSet()
• GeGetMovieInfo()
• GeIdentifyFile()
• ReadHyperFile()
• WriteHyperFile()

Several changes in the render module:

• Added optional argument of type BaseVolumeData for ChannelData constructor.
• Added VolumeData.GetWeights(), VolumeData.CalcVisibleLight() and VolumeData.GetSmoothedNormal().

• Gradient.InitRender() and BaseShader.InitRender() now take an InitRenderStruct parameter.

Methods added:

• ShaderData.FreeRender()
• BaseContainer.GetContainerInstance()
• NodeData.GetDEnabling(), NodeData.IsInstanceOf() and NodeData.GetDocument()

• Added function ActiveObjectManager_SetObject().

In R13.016

Here is a list of all the new modules, classes, methods and functions in the Python SDK for CINEMA 4D R13.016:

New Modules

• c4d.modules.mograph
• c4d.modules.render

• c4d.threading

New Classes

c4d

• BaseShader

• HandleInfo

• New custom data type classes:

  • FontData
  • UnitScaleData
  • LayerSet

• New tag classes:

  • NormalTag
  • PointTag
  • PolygonTag
  • SegmentTag
  • TangentTag

c4d.gui

• New custom GUI classes exposed:

  • BitmapButtonCustomGui
  • QuickTabCustomGui
  • TreeViewCustomGui

c4d.modules.mograph

• FalloffDataData
• MoData

c4d.modules.render

• BaseVolumeData
• VolumeData
• ChannelData
• Ray
• InitRenderStruct

c4d.plugins

• New plugin data classes:

  • FalloffData
  • ShaderData

c4d.storage

• MemoryFileStruct

c4d.threading

• BaseThread
• C4DThread

New Methods

c4d

• BaseContainer

  • BaseContainer.GetDirty()

• DescID

  • DescID.Write()
  • DescID.Read()

• Matrix

  • Matrix.Mul()
  • Matrix.MulV()

• BaseSelect

  • BaseSelect.Write()
  • BaseSelect.Read()
  • BaseSelect.GetLastElement()

• C4DAtom

  • C4DAtom.__call__()
  • C4DAtom.MultiMessage()
  • C4DAtom.Write()
  • C4DAtom.Read()
  • C4DAtom.WriteObject()
  • C4DAtom.ReadObject()

• BaseList2D

  • BaseList2D.__str__()
  • BaseList2D.GetData()
  • BaseList2D.SetData()

• PolygonObject

  • PolygonObject.GetPolygon()
  • PolygonObject.GetSelectedEdges()
  • PolygonObject.SetSelectedEdges()
  • PolygonObject.GetSelectedNgons()
  • PolygonObject.GetHiddenNgons()
  • PolygonObject.ValidateEdgeSelection()
  • PolygonObject.GetEdgeSelection()
  • PolygonObject.GetNgonEdgesCompact()

• BaseDraw

  • BaseDraw.SetPointSize()
  • BaseDraw.ConvertColor()
  • BaseDraw.ConvertColorReverse()
  • BaseDraw.SetDepth()

• BaseMaterial

  • BaseMaterial.GetRenderInfo()

• SplineData

  • SplineData.SetKnot()
  • SplineData.MakePointBuffer()
  • SplineData.MakeLinearSplineLinear()
  • SplineData.MakeLinearSplineBezier()
  • SplineData.MakeSquareSpline()
  • SplineData.MakeCubicSpline()
  • SplineData.MakeRootSpline()
  • SplineData.MakeInversSpline()
  • SplineData.MakeSinSpline()
  • SplineData.MakeAbsCosSpline()
  • SplineData.MakeUserSpline()
  • SplineData.SetZero()
  • SplineData.InitDefaultFlag()
  • SplineData.AdaptRange()

c4d.bitmaps

• GeClipMap

  • GeClipMap.SetFont()
  • GeClipMap.GetFont()

c4d.documents

• BaseDocument

  • BaseDocument.GetActiveObjectsFilter()
  • BaseDocument.SetRewind()
  • BaseDocument.ForceCreateBaseDraw()
  • BaseDocument.FindSceneHook()

c4d.gui

• SplineCustomGui

  • SplineCustomGui.SetGridLineCountH()
  • SplineCustomGui.SetGridLineCountV()
  • SplineCustomGui.GetGridLineCountH()
  • SplineCustomGui.GetGridLineCountV()
  • SplineCustomGui.GetScreenPosition()

• HtmlViewerCustomGui

  • HtmlViewerCustomGui.SetURLCallback()

• GeUserArea

  • GeUserArea.DrawGetFontBaseLine()
  • GeUserArea.DrawSetTextRotation()

• GeUserArea

  • GeDialog.FindCustomGui()
  • GeDialog.AddRadioGroup()
  • GeDialog.AddRadioButton()
  • GeDialog.AddRadioText()
  • GeDialog.SetMultiLinePos()
  • GeDialog.SetMultiLineMode()
  • GeDialog.AddDlgGroup()

c4d.modules.hair

• HairLibrary

  • HairLibrary.GetPolyPointST()

c4d.plugins

• BaseDrawHelp

  • BaseDrawHelp.GetViewSchedulerFlags()

• NodeData

  • NodeData.Read()
  • NodeData.Write()
  • NodeData.CopyTo()
  • NodeData.GetDocument()
  • NodeData.IsInstanceOf()
  • NodeData.GetDEnabling()

• BitmapLoaderData

  • BitmapLoaderData.GetSaver()
  • BitmapLoaderData.GetInformation()

• BitmapLoaderData

  • BitmapSaverData.GetMaxAlphas()
  • BitmapSaverData.GetMaxResolution()

• CommandData

  • CommandData.ExecuteOptionID()
  • CommandData.GetState()

• TagData

  • TagData.AddToExecution()

c4d.utils

• ViewportSelect

  • ViewportSelect.GetNearestPoint()
  • ViewportSelect.GetNearestPolygon()
  • ViewportSelect.GetNearestEdge()

New Functions

c4d

• GePluginMessage()
• GetObjectType()

c4d.documents

• GetFirstMarker()
• AddMarker()

c4d.gui

• GetMenuResource()
• SearchMenuResource()
• SearchPluginMenuResource()
• SearchPluginSubMenuResource()
• UpdateMenus()
• GeGetScreenDimensions()
• ActiveObjectManager_SetObject()

c4d.modules.bodypaint

• SendPainterCommand()

c4d.modules.graphview

• GetMaster()

c4d.modules.mograph

• GeGetMoData()
• GetMoDataDefault()
• GetMoDataDefaultType()

c4d.plugins

• New register plugin data functions:

  • RegisterFalloffPlugin()
  • RegisterShaderPlugin()
  • RegisterNodePlugin()
  • RegisterManagerInformation()

c4d.storage

• GeGetPythonPath() renamed GeGetPluginPath()
• WriteHyperFile()
• ReadHyperFile()

c4d.threading

• GeThreadLock()
• GeThreadUnlock()
• GeIsMainThread()
• GeGetCPUCount()
• GeGetCurrentThreadId()
• IdentifyThread()
• GeGetCurrentThread()
• GeCheckBackgroundThreadsRunning()
• GeStopBackgroundThreads()
• GeProcessBackgroundThreads()

c4d.utils

• TransformColor()
• CalculateTranslationScale()

Changelogs

• Changelog for R13.
• Changelog for R12.