API Changelist R20

Note

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

New in version R20.

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

R20

Modules

• c4d.modules.volume

Types

• c4d.InstanceObject

• c4d.FieldList

• c4d.modules.mograph.FieldCallerStack
• c4d.modules.mograph.FieldInfo
• c4d.modules.mograph.FieldInput
• c4d.modules.mograph.FieldLayer
• c4d.modules.mograph.FieldObject
• c4d.modules.mograph.FieldOutput
• c4d.modules.mograph.FieldOutputBlock

• c4d.modules.volume.VolumeBuilder
• c4d.modules.volume.VolumeObject

Functions

• c4d.GetGlobalTexturePaths()
• c4d.SetGlobalTexturePaths()

• c4d.WriteConsole()

• c4d.bitmaps.GetImageSettingsDictionary()
• c4d.bitmaps.SetImageSettingsDictionary()

• c4d.modules.volume.SendVolumeCommand()

Methods

• Gradient.DistributeKnots()

• Vector4d.NormalizeW()

Changes

Symbols

Symbols value with the name 0 were renamed to NONE. For instance, DESCFLAGS_SET_0 was changed to DESCFLAGS_SET_NONE.

For compatibility reason, DESCFLAGS_SET_0 keep working but please update your symbols to the new format.

• Updated OBJECT.
• Updated MDDIRTY.
• Updated DESCRIPTION CUSTOMGUISETTINGS.
• Updated DATETIME CUSTOMGUISETTINGS.
• Updated GRADIENTPROPERTY CUSTOMGUISETTINGS with R20.
• Updated LINKBOX CUSTOMGUISETTINGS with R20.
• Updated SPLINECONTROL with R20.
• Updated FORMAT Export with R20.
  • Removed FORMAT_XMLIMPORT
  • Removed FORMAT_XMLEXPORT
• Updated MSG_DOCUMENTINFO_TYPE with R20.
• Updated REFLECTION FRESNEL with R20.
• Added REFLECTION FRESNEL METAL.
• Added REFLECTION FRESNEL DIELECTRIC.
• Updated COLOR with R20.
• Updated DESC with R20.
• Updated PLUGINFLAG with R20.
• Updated SCRIPTMODE with R20.
• Updated IDENTIFYFILE with R20.
• Updated FILESELECTTYPE with R20.
• Updated EVMSG with R20.
• Updated GEDATATYPE with R20.
• Updated HOTKEYFLAGS with R20.
• Updated COLORMODE with R20.
• Updated MCOMMAND with R20.
• Updated BITMAPBUTTON with R20.
• Updated TREEVIEW with R20.
• Updated LV with R20.
• Updated INSERT with R20.
• Updated SPLINECONTROL with R20.
• Updated DTYPE with R20.
• Updated USERAREAFLAGS with R20.
• Updated CAMORPH_MODE with R20.
• Updated Object Types.
  • Added Oobjecttracker
  • Added Ofield
  • Added Fieldremapper
  • Added Ovolume
  • Added Ovolumegroup
  • Added Ovolumebuilder
  • Added Ovolumeloader
  • Added Ovolumemesher
  • Added Ovolumefilter
• Updated Tag Types:
  • Removed Tcoffeeexpression
  • Added Tmeshattribute

Color Chooser

• c4d.modules.colorchooser.ColorSwatchData

  • Removed:
    • ColorSwatchData.LoadGlobalGroup
    • ColorSwatchData.SaveGlobalGroup
    • ColorSwatchData.LoadDefaultGlobalGroup
    • ColorSwatchData.SaveDefaultGlobalGroup
    • ColorSwatchData.GetGlobalGroup
    • ColorSwatchData.SetGlobalGroup
  • globalColors parameter added to ColorSwatchData.Load()/Save()
  • category parameter added to:
    • ColorSwatchData.GetGroupCount()
    • ColorSwatchData.GetGroupAtIndex()
    • ColorSwatchData.SetGroupAtIndex()
    • ColorSwatchData.AddGroup()
    • ColorSwatchData.InsertGroup()
    • ColorSwatchData.RemoveGroup()

• c4d.modules.colorchooser.ColorSwatchGroup

  • colors parameter changed to maxon.BaseArray(maxon.ColorA) for ColorSwatchGroup.__init__()/AddColors()
  • color parameter changed to maxon.ColorA for ColorSwatchGroup.SetColor()/AddColor()
  • ColorSwatchGroup.GetColor() changed to return a maxon.ColorA
  • ColorSwatchGroup.GetColors() changed to return a maxon.BaseArray(maxon.ColorA)

Parameter

• New optional parameter doc for C4D_Falloff.GetDirty()

• New parameters mouseX, mouseY and ua for TreeViewFunctions.HeaderClick()

• VolumeData.CalcArea() new parameter ignoreLightColor
• VolumeData.IlluminateSurfacePoint() fixed parsing for parameter cosine_cutoff

Removed

• BaseDocument.SearchObjectInc()/SearchMaterialInc()

• c4d.threading.GeProcessBackgroundThreads

Deprecated

• c4d.GetGlobalTexturePath()/SetGlobalTexturePath()

R20.028 - SP1 Hotfix 1

This hotfix for Cinema 4D R20 SP1 did not change any API functionality.

R20.030 - SP1 Hotfix 2

This hotfix for Cinema 4D R20 SP1 did not change any API functionality.

R20.057 - SP2

Symbols

Few symbols were added in this release:

• FORMAT Export:

  1. FORMAT_ABCIMPORT: Alembic import.
  2. FORMAT_ABCEXPORT: Alembic export.
  3. FORMAT_DAE14IMPORT: Collada 14 import.
  4. FORMAT_DAE14EXPORT: Collada 14 export.
  5. FORMAT_DAE15IMPORT: Collada 15 import.
  6. FORMAT_DAE15EXPORT: Collada 15 export.

  doc = c4d.documents.GetActiveDocument()
  filePath = storage.LoadDialog(title="Save File for Alembic Export", flags=c4d.FILESELECT_SAVE, force_suffix="abc")
  if filePath is None:
      return
  
  c4d.documents.SaveDocument(doc, filePath, c4d.SAVEDOCUMENTFLAGS_DONTADDTORECENTLIST, c4d.FORMAT_ABCEXPORT)
  

• DESCRIPTION CUSTOMGUISETTINGS:

  1. DESCRIPTION_HIDE_EMPTY_GROUPS

R20.059 - SP2 Hotfix 1

This hotfix for Cinema 4D R20 SP2 did not change any API functionality.