API Changelist R18

Note

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

New in version R18.057.

Here is the list of all the API additions and changes in the R18 Python API:

R18.011

Modules

• c4d.modules.colorchooser

Types

• c4d.modules.colorchooser.ColorSwatchData
• c4d.modules.colorchooser.ColorSwatchGroup

• c4d.modules.bodypaint.TempUVHandle

Methods

• ColorSwatchData.LoadGlobalGroup()
• ColorSwatchData.SaveGlobalGroup()
• ColorSwatchData.LoadDefaultGlobalGroup()
• ColorSwatchData.SaveDefaultGlobalGroup()
• ColorSwatchData.GetGlobalGroup()
• ColorSwatchData.SetGlobalGroup()
• ColorSwatchData.Load()
• ColorSwatchData.Save()
• ColorSwatchData.LoadPresetByName()
• ColorSwatchData.LoadPresetByURL()
• ColorSwatchData.SavePresetByName()
• ColorSwatchData.SavePresetByURL()
• ColorSwatchData.Merge()
• ColorSwatchData.CopyFrom()
• ColorSwatchData.GetGroupCount()
• ColorSwatchData.GetGroupAtIndex()
• ColorSwatchData.SetGroupAtIndex()
• ColorSwatchData.AddGroup()
• ColorSwatchData.InsertGroup()
• ColorSwatchData.RemoveGroup()
• ColorSwatchData.RemoveSelectedItems()
• ColorSwatchData.Reset()

• ColorSwatchGroup.Merge()
• ColorSwatchGroup.CopyFrom()
• ColorSwatchGroup.GetName()
• ColorSwatchGroup.SetName()
• ColorSwatchGroup.GetColorCount()
• ColorSwatchGroup.GetColor()
• ColorSwatchGroup.GetColors()
• ColorSwatchGroup.SetColor()
• ColorSwatchGroup.AddColor()
• ColorSwatchGroup.AddColors()
• ColorSwatchGroup.Reset()
• ColorSwatchGroup.RemoveColor()
• ColorSwatchGroup.RemoveSelectedColors()
• ColorSwatchGroup.HasDuplicatedColors()
• ColorSwatchGroup.RemoveDuplicatedColors()
• ColorSwatchGroup.InvertSelection()
• ColorSwatchGroup.SelectColor()
• ColorSwatchGroup.IsColorSelected()
• ColorSwatchGroup.SelectGroup()
• ColorSwatchGroup.IsGroupSelected()
• ColorSwatchGroup.SortColors()

• PolygonObject.GetPolygonR()
• PolygonObject.GetPolygonW()

• Description.LoadDescription()
• Description.GetParameter()
• Description.GetParameterI()
• Description.SetParameter()
• Description.CreatePopupMenu()
• Description.CheckDescID()
• Description.GetSubDescriptionWithData()
• Description.GetSingleDescID()

• NodeData.GetDDescription()
• NodeData.GetDParameter()
• NodeData.SetDParameter()
• NodeData.TranslateDescID()
• NodeData.IsDocumentRelated()
• NodeData.GetBubbleHelp()

• ToolData.GetDDescription()
• ToolData.GetDParameter()
• ToolData.SetDParameter()
• ToolData.GetDEnabling()
• ToolData.TranslateDescID()

• ObjectData.GetHandleCount()
• ObjectData.GetHandle()
• ObjectData.SetHandle()

• BaseCustomGui.GetWidth()
• BaseCustomGui.GetHeight()
• BaseCustomGui.Redraw()
• BaseCustomGui.LayoutChanged()
• BaseCustomGui.Activate()
• BaseCustomGui.SetDefaultForResEdit()
• BaseCustomGui.SetData()
• BaseCustomGui.GetData()
• BaseCustomGui.SetLayoutMode()
• BaseCustomGui.GetLayoutMode()
• BaseCustomGui.SupportLayoutSwitch()

Functions

• c4d.modules.colorchooser.ColorRGBToString()
• c4d.modules.colorchooser.ColorHSVToString()
• c4d.modules.colorchooser.ColorComponentFloatTo8Bit()
• c4d.modules.colorchooser.ColorComponent8BitToFloat()
• c4d.modules.colorchooser.ColorFloatTo8Bit()
• c4d.modules.colorchooser.Color8BitToFloat()
• c4d.modules.colorchooser.ColorComponentFloatTo16Bit()
• c4d.modules.colorchooser.ColorComponent16BitToFloat()
• c4d.modules.colorchooser.ColorFloatTo16Bit()
• c4d.modules.colorchooser.Color16BitToFloat()
• c4d.modules.colorchooser.ColorKelvinTemperatureToRGB()
• c4d.modules.colorchooser.ColorHarmonyGetComplementary()
• c4d.modules.colorchooser.ColorHarmonyGetSplitComplementary()
• c4d.modules.colorchooser.ColorHarmonyGetTetradic()
• c4d.modules.colorchooser.ColorHarmonyGetAnalogous()
• c4d.modules.colorchooser.ColorHarmonyGetEquiangular()
• c4d.modules.colorchooser.ColorHarmonyRotateColor()
• c4d.modules.colorchooser.ColorHarmonyInterpolateColors()
• c4d.modules.colorchooser.ColorSwatchPresetExists()
• c4d.modules.colorchooser.ValidColorSwatchPreset()
• c4d.modules.colorchooser.GetColorSwatchPresetDirectory()

• c4d.modules.bodypaint.GetActiveUVSet()
• c4d.modules.bodypaint.FreeActiveUVSet()
• c4d.modules.bodypaint.CallUVCommand()

Constants

• c4d.DESCID_ROOT
• c4d.DESCID_DYNAMICSUB
• Removed ID_MODELING_KNIFE_TOOL

Miscellaneous

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

R18.020

Modules

• c4d.modules.motiontracker
• c4d.modules.substance

Types

• c4d.Vector4d

• c4d.VertexColorTag

• c4d.modules.motiontracker.MotionTrackerObject
• c4d.modules.motiontracker.MtFootageDataSdk
• c4d.modules.motiontracker.Mt2dTrackDataSdk
• c4d.modules.motiontracker.Mt2dTrackSdk
• c4d.modules.motiontracker.MtDataSdk
• c4d.modules.motiontracker.MtTrkGidSdk

Methods

• BaseObject.SetQuaternionRotationMode()
• BaseObject.IsQuaternionRotationMode()
• BaseObject.SynchronizeVectorTrackKeys()
• BaseObject.FindBestEulerAngle()
• BaseObject.EvaluateSynchronizedRotation()
• BaseObject.GetVectorTracks()
• BaseObject.GetVectorCurves()

• CKey.SetQuatInterpolation()
• CKey.GetQuatInterpolation()

• CCurve.AddKeyAdaptTangent()

• CTrack.IsSynchronized()
• CTrack.SetSynchronized()

• Vector4d.__init__()
• Vector4d.__str__()
• Vector4d.__getitem__()
• Vector4d.__setitem__()
• Vector4d.__add__()
• Vector4d.__sub__()
• Vector4d.__mul__()
• Vector4d.__eq__()
• Vector4d.__ne__()
• Vector4d.SetZero()
• Vector4d.Dot()
• Vector4d.MakeVector3()
• Vector4d.GetVector3()

• VertexColorTag.__init__()
• VertexColorTag.GetDataAddressR()
• VertexColorTag.GetDataAddressW()
• VertexColorTag.IsPerPointColor()
• VertexColorTag.SetPerPointMode()
• VertexColorTag.GetPolygon()
• VertexColorTag.SetPolygon()
• VertexColorTag.GetPoint()
• VertexColorTag.SetPoint()
• VertexColorTag.GetColor()
• VertexColorTag.SetColor()
• VertexColorTag.GetAlpha()
• VertexColorTag.SetAlpha()

• ReflectionLayer.GetLayerID()
• ReflectionLayer.GetName()
• ReflectionLayer.SetName()
• ReflectionLayer.GetFlags()
• ReflectionLayer.SetFlags()

• MotionTrackerObject.GetFootageData()
• MotionTrackerObject.Get2dTrackData()

• Mt2dTrackDataSdk.GetTrackCount
• Mt2dTrackDataSdk.GetTrackByIndex
• Mt2dTrackDataSdk.GetTrackByGid
• Mt2dTrackDataSdk.GetTrackIndices
• Mt2dTrackDataSdk.GetTrackByName

• Mt2dTrackSdk.GetName
• Mt2dTrackSdk.GetId
• Mt2dTrackSdk.GetStatus
• Mt2dTrackSdk.GetFramesWithTrackData
• Mt2dTrackSdk.GetDataForFrame
• Mt2dTrackSdk.GetDataForCurrentFrame

• MtDataSdk.GetNormalisedPosition
• MtDataSdk.GetPixelPosition
• MtDataSdk.GetCameraSpaceDirection

• MtFootageDataSdk.GetFootageName
• MtFootageDataSdk.GetFirstFrameNumber
• MtFootageDataSdk.GetLastFrameNumber
• MtFootageDataSdk.GetResolutionWidthPix
• MtFootageDataSdk.GetResolutionHeightPix
• MtFootageDataSdk.GetResolutionAspectRatio
• MtFootageDataSdk.GetImageAspectRatio
• MtFootageDataSdk.GetPixelAspectRatio
• MtFootageDataSdk.GetDownsamplingFactor

• InExcludeData.GetObjectIndex()
• InExcludeData.SetFlags()
• InExcludeData.GetFlagCount()
• InExcludeData.SetFlagCount()
• InExcludeData.GetDefaultFlag()
• InExcludeData.SetDefaultFlag()

• BaseDraw.DrawHUDText()
• BaseDraw.DrawMultipleHUDText()

• TreeViewCustomGui.SetVisibleScrollArea()

• InitRenderStruct.__init__()

• DescID.IsPartOf()

Functions

• c4d.modules.substance.ImportSubstance()
• c4d.modules.substance.CreateMaterial()
• c4d.modules.substance.CreateSubstanceShader()
• c4d.modules.substance.AssignChannelToMaterial()
• c4d.modules.substance.GetFirstSubstance()
• c4d.modules.substance.GetSubstances()
• c4d.modules.substance.InsertLastSubstance()
• c4d.modules.substance.GetSubstanceGraph()
• c4d.modules.substance.GetSubstanceInput()
• c4d.modules.substance.GetSubstanceOutput()
• c4d.modules.substance.PrefsGetMaterialModeSetting()
• c4d.modules.substance.PrefsGetPreviewSetting()
• c4d.modules.substance.MaterialUsesSubstance()
• c4d.modules.substance.GetSubstanceMosaicPreview()

• c4d.modules.mograph.GeGetMoDataSelection()
• c4d.modules.mograph.GeGetMoDataWeights()

• c4d.utils.InitBakeTexture()
• c4d.utils.BakeTexture()

• c4d.utils.QDot()
• c4d.utils.QSmoothCubic()

• c4d.modules.CheckMotionTracker()

Parameters

• The following c4d.CCurve methods now accepts 2 optional parameters bUndo and SynchronizeKeys:
  • CCurve.AddKey()
  • CCurve.InsertKey()
  • CCurve.DelKey()
  • CCurve.MoveKey()
  • CCurve.FlushKeys()

• c4d.GetMachineFeatures() New parameter type

• TextureTag.GetMaterial() New parameter ignoredoc

Attributes

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

  Replaced by new methods ReflectionLayer.GetName()/SetName(), ReflectionLayer.GetLayerID() and ReflectionLayer.GetFlags()/SetFlags()

R18.039

Types

• c4d.VoronoiFracture

Methods

• VoronoiFracture.__init__()
• VoronoiFracture.GetSourcesCount()
• VoronoiFracture.GetSource()
• VoronoiFracture.GetSourceByType()
• VoronoiFracture.RemoveSource()
• VoronoiFracture.AddPointGenerator()
• VoronoiFracture.AddSceneObject()
• VoronoiFracture.ClearSources()

Functions

• c4d.modules.mograph.GeSetMoDataSelection()
• c4d.modules.mograph.GeSetMoDataWeights()

• c4d.utils.RadToDeg()
• c4d.utils.DegToRad()

Parameters

• BaseObject.EvaluateSynchronizedRotation() New optional parameter applyRotation
• Description.GetParameter() New parameter ar
• c4d.modules.substance.CreateSubstanceShader() asset parameter can be None
• c4d.utils.InitBakeTexture() th parameter is optional

Miscellaneous

• BaseObject.EvaluateSynchronizedRotation() now returns a bool or a tuple depending on new optional parameter applyRotation

R18.057

Methods

• CAMorphNode.GetLink()
• GvNode.OperatorSetData()

Parameters

• BaseObject.GetHierarchyClone()/BaseObject.GetAndCheckHierarchyClone() New optional parameters dirty and trans
• c4d.storage.LoadDialog()/c4d.storage.SaveDialog() New optional parameter def_file
• c4d.utils.FitCurve() New optional parameter bt
• c4d.utils.StringToNumber() New optional parameter lengthunit
• BaseDraw.DrawPoints() vc and vn optional parameters can be None
• DescID.IsPartOf() cmp parameter can be a int, list or DescID

Miscellaneous

• GeDialog.AddCustomGui()/FindCustomGui() now return a BaseCustomGui when the type for a custom GUI is unknown
• BaseObject.GetHierarchyClone()/BaseObject.GetAndCheckHierarchyClone() no longer return only None when the cloned object is None. The functions always return a dictionary with clone and dirty keys
• Description.GetParameter() returns only one information container. The function was returning a tuple with two containers: one for standard parameters and one for dynamic parameters