API Changelist R21

Note

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

New in version R21.

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

R21

Additions

Types

• c4d.IconData added.

• c4d.CustomIconSettings added.

Functions

• c4d.IsTrial() added.

• c4d.IsLiteVersion() added.

• c4d.IsEducation() added.

• c4d.IsNFR() added.

• c4d.GeGetCinemaInfo() added.

• c4d.ExportLicenses() added.

• c4d.GetGeneralLicensingInformation() added.

• c4d.documents.GetRecentDocumentsList() added.

• c4d.gui.GetInterfaceIconEx() added.

• c4d.plugins.RegisterToken() added.

• c4d.plugins.RegisterHiddenToken() added.

Methods

• FieldLayer.AddMask() added.

• FieldLayer.RemoveMask() added.

• FieldLayer.GetMaskHead() added.

• FieldOutput.SetRotation() added.

• FieldOutputBlock.SetRotation() added.

• FieldOutput._pivot added.

• FieldOutputBlock._pivot added.

• BaseList2D.GetIconEx() added.

• c4d.gui.GetInterfaceIconEx() added.

• CAWeightMgr.GetAutoWeightDictionary() added.

• CAWeightMgr.SetAutoWeightDictionary() added.

• CAWeightMgr.GetAutoWeightAlgoIndex() added.

• CAWeightMgr.GetAutoWeightAlgoId() added.

• maxon.frameworks.volume.VolumeToolsInterface.CreateFromFile() added.

• maxon.frameworks.volume.VolumeToolsInterface.MixVectorVolumes() added.

• maxon.frameworks.volume.VolumeInterface.GetMinMaxValues() added.

Changes

• c4d.GeGetSystemInfo() was changed. See R21 Version and License.

• BaseList2D.GetLayerData(): xref added to the dictionary.

• BaseList2D.SetLayerData(): xref added to the dictionary.

• CAWeightTag.GetWeightMap() added.

• CAWeightTag.SetWeightMap() added.

• SplineData.MakeLinearSplineLinear(): lPoints argument is now optional.

• SplineData.MakeLinearSplineBezier(): lPoints argument is now optional.

• SplineData.MakeSquareSpline(): lPoints argument is now optional.

• SplineData.MakeCubicSpline(): lPoints argument is now optional.

• SplineData.MakeRootSpline(): lPoints argument is now optional.

• SplineData.MakeInversSpline(): lPoints argument is now optional.

• SplineData.MakeSinSpline(): lPoints argument is now optional.

• SplineData.MakeAbsCosSpline(): lPoints argument is now optional.

• SplineData.MakeUserSpline(): lPoints argument is now optional.

• GeDialog.AddComboBox(): allowfiltering optional parameter added.

• SubDialog.AddComboBox(): allowfiltering optional parameter added.

• BaseDraw.DrawPolygonObject(): parent and col optional parameter added.

• BaseDraw.DrawObject(): col optional parameter added.

• BitmapButtonCustomGui.SetImage() added support of IconData as input type for obj picture.

• c4d.GeGetVersionType() return value modified to respect the unification of Cinema 4D.

• c4d.GeGetSerialInfo() return modified in order to reflect the new license scheme.

• c4d.documents.GetAllAssets(), returns information about node space.

See - R21 Fixes

Symbols

• ASSETDATA_FLAG_NODOCUMENT added.

• BORDER_TEXT_DOTTED added.

• SCROLLGROUP_BORDERINb added.

• SCROLLGROUP_BORDERINb added.

• Tuserdata added.

• Tcacheproxytag added.

• Tcacheproxytagpolyselection added.

• Tcacheproxytagpointselection added.

• Tcacheproxytagedgeselection added.

• VIEWCOLOR_FIELDGIZMO_COLOR1 added.

• VIEWCOLOR_FIELDGIZMO_COLOR2 added.

• VIEWCOLOR_FIELDGIZMO_FALLOFF1 added.

• VIEWCOLOR_FIELDGIZMO_FALLOFF2 added.

• VIEWCOLOR_UVGIZMO_NORMAL added.

• VIEWCOLOR_UVGIZMO_CANDIDATE added.

• VIEWCOLOR_UVGIZMO_IN_MOTION added.

• VIEWCOLOR_UVGIZMO_ANCHOR_SNAPPED added.

• VIEWCOLOR_UV_AXIS_U added.

• VIEWCOLOR_UV_AXIS_V added.

• VIEWCOLOR_JOINT added.

• VIEWCOLOR_HANDLES added.

• BMP_EMBOSSED removed, replaced by BMP_GRAYEDOUT.

Removed because icon management changed.

• ANNOTATIONTAG_COLORICON removed.

• LIGHT_ICONCOL removed.

• NULLOBJECT_ICONCOL removed.

• NULLOBJECT_ICONCOL_DUMMY removed.

• TMORPHCAM_INFOTEXT removed.

• CADIMPORT_LOD_STATICTEXT removed.

• CADIMPORT_SOURCE_MESH_STATICTEXT removed.

• COLOR_PV_FULLBG removed.

• COLOR_PV_FULLELE removed.

• COLOR_PV_FULLTXT removed.

• DESCRIPTIONPROPERTY_CONNECTIONSTATE removed.

• DESCRIPTIONRESOURCE_FLWIMPORT removed.

• DESCRIPTIONRESOURCE_OVOLUMEGROUP removed.

• DESCRIPTIONRESOURCE_VPPREVIEWSOFTWARE removed.

• DESC_NODEISLINKEDPORT removed.

• DRAWBEZIER_BX removed.

• DRAWBEZIER_BY removed.

• DRAWBEZIER_CX removed.

• DRAWBEZIER_CY removed.

• DRAWBEZIER_DX removed.

• DRAWBEZIER_DY removed.

• FORMAT_LWOIMPORT removed.

• FORMAT_LWSIMPORT removed.

• LWIMPORTFILTER_GROUP removed.

• LWIMPORTFILTER_LIGHTS removed.

• LWIMPORTFILTER_SCALE removed.

• LWIMPORTFILTER_SPLITOBJECTS removed.

• LWIMPORTFILTER_TEXTURES removed.

• ID_CA_JOINT_OBJECT_ICONCOL removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT_ALLOW_NULL removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT_DISTANCE_RATIO removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT_FALLOFF removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT_JOINTS removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT_MODE_DISTANCE removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT_MODE_VISIBLE removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT_SELECTED_VERTICES removed.

• ID_CA_WEIGHT_MGR_AUTOWEIGHT_VISIBILITY_RATIO removed.

• ID_CA_WEIGHT_MGR_HANDLER_LINK removed.

• FIELDLAYER_FLAG_SKIPWITHDEFAULTOUTPUTS removed.

• FIELDOBJECT_FLAG_SKIPWITHDEFAULTOUTPUTS removed.

• FIELDSAMPLE_FLAG_ALL removed, use c4d.FIELDSAMPLE_FLAG_VALUE | c4d.FIELDSAMPLE_FLAG_DIRECTION | c4d.FIELDSAMPLE_FLAG_COLOR.

• FIELD_REMAP_DIRECTION removed.

• FIELD_REMAP_NORMALDIRECTION removed.

Removed since volume filter have been reworked.

• ID_VOLUMEFILTER_FOG_RESHAPE_TYPE removed.

• ID_VOLUMEFILTER_GLOBALFILTERTYPE removed.

• ID_VOLUMEFILTER_GLOBALFILTERTYPE_RESHAPE removed.

• ID_VOLUMEFILTER_GLOBALFILTERTYPE_SMOOTH removed.

• ID_VOLUMEFILTER_SDF_RESHAPE_TYPE removed.

• ID_VOLUMEFILTER_SDF_TYPE_DIALATE_ERODE removed.

• ID_VOLUMEFILTER_SDF_TYPE_GAUSSIAN removed.

• ID_VOLUMEFILTER_SDF_TYPE_LAPLACIANFLOW removed.

• ID_VOLUMEFILTER_SDF_TYPE_MEANCURVATURE removed.

• ID_VOLUMEFILTER_SDF_TYPE_MEANVALUE removed.

• ID_VOLUMEFILTER_SDF_TYPE_MEDIANVALUE removed.

• ID_VOLUMEFILTER_SDF_TYPE_OPEN_CLOSE removed.

• ID_VOLUMEFILTER_TYPE_GAUSSIAN removed.

• ID_VOLUMEFILTER_TYPE_MEANVALUE removed.

• ID_VOLUMEFILTER_TYPE_MEDIANVALUE removed.

• ID_VOLUMEFILTER_TYPE_OFFSET removed.

• ID_VOLUMEFILTER_TYPE_REMAP removed.

• ID_VOLUMEFILTER_TYPE_SPLINEREMAP removed.

Removed since volume were replaced by volume set.

• Ovolumegroup removed.

• ID_VOLUMEGROUP_DETACH removed.

• ID_VOLUMEGROUP_FILELINK removed.

• ID_VOLUMEGROUP_PATH removed.

• ID_VOLUMEGROUP_PATH_ABSOLUTE removed.

• ID_VOLUMEGROUP_RELOAD removed.

• ID_VOLUMEGROUP_SAVE removed.

• ID_VOLUMEGROUP_STATS_STRING removed.

• ID_VOLUMEGROUP_VOLUMESLIST removed.

Removed because Serial structure changed

• SERIALINFO_CINEMA4D removed.

• SERIALINFO_MULTILICENSE removed.

• SERIALINFO_RLMLICENSE removed.

Removed because analytics changed.

• PREF_COMMUNICATION_METRICS_ENABLE_CHECKBOX removed.

• PREF_COMMUNICATION_METRICS_ENABLE_COMMANDS_CHECKBOX removed.

• PREF_COMMUNICATION_METRICS_ENABLE_PREFERENCES_CHECKBOX removed.

• PREF_COMMUNICATION_METRICS_ENABLE_SYSTEM_INFO_CHECKBOX removed.

• WPREF_COMMUNICATION_METRICS_ENABLE removed.

• WPREF_COMMUNICATION_METRICS_ENABLE_COMMANDS removed.

• WPREF_COMMUNICATION_METRICS_ENABLE_PREFERENCES removed.

• WPREF_COMMUNICATION_METRICS_ENABLE_SYSTEM_INFO removed.

Removed because software render engine was removed.

• RDATA_RENDERENGINE_PREVIEWSOFTWARE removed.

• DRAWPORT_TYPE_SOFTWARE removed.

• VP_GPURENDERER_RENDERMODE_DIRECT_ILLUMINATION_NO_SHADOW removed.

• VP_GPURENDERER_RESOLUTION_MIN_PREVIEW removed.

• VP_PREVIEWSOFTWARE_ANTIALIASING removed.

• VP_PREVIEWSOFTWARE_ANTIALIASING_NONE removed.

• VP_PREVIEWSOFTWARE_DUMMY removed.

• VP_PREVIEWSOFTWARE_ENHANCEDOPENGL removed.

• VP_PREVIEWSOFTWARE_NOISE removed.

• VP_PREVIEWSOFTWARE_POSTEFFECT removed.

• VP_PREVIEWSOFTWARE_REFLECTIONS removed.

• VP_PREVIEWSOFTWARE_SHADOW removed.

• VP_PREVIEWSOFTWARE_SSAO removed.

• VP_PREVIEWSOFTWARE_TESSELLATION removed.

• VP_PREVIEWSOFTWARE_TRANSPARENCY removed.

• PREF_OPENGL_HARDWARE removed.

• MACHINEFEATURESTYPE_SOFTWARE_OGL removed.

• WPREF_HW_OPENGL removed.

• WPREF_OPENGL_TEMP removed.

Removed because GeGetSystemInfo was changed.

• SYSTEMINFO_0 removed.

• SYSTEMINFO_CINERENDER removed.

• SYSTEMINFO_CINEWARE removed.

• SYSTEMINFO_COMMANDLINE removed.

• SYSTEMINFO_CPYTHON removed.

• SYSTEMINFO_CPYTHON3 removed.

• SYSTEMINFO_LITE removed.

• SYSTEMINFO_LITE_ACTIVE removed.

• SYSTEMINFO_NONE removed.

• SYSTEMINFO_OPENGL removed.

• SYSTEMINFO_SAVABLEDEMO removed.

• SYSTEMINFO_SAVABLEDEMO_ACTIVE removed.

• SYSTEMINFO_STUDENT removed.

Removed because version management changed.

• VERSIONTYPE_BODYPAINT removed

• VERSIONTYPE_BROADCAST removed

• VERSIONTYPE_INSTALLER removed

• VERSIONTYPE_LICENSESERVER removed

• VERSIONTYPE_NET_CLIENT removed

• VERSIONTYPE_NET_SERVER_3 removed

• VERSIONTYPE_NET_SERVER_UNLIMITED removed

• VERSIONTYPE_PRIME removed

• VERSIONTYPE_STUDIO removed

• VERSIONTYPE_VISUALIZE removed

Deprecated

There is no method marked as deprecated in the R21 release.

Removed

• CAWeightMgr.AutoWeight(): allowNull optional parameter removed.

R21 SP1

Methods

• Added HyperFile.GetFilterFlags().

Symbols

• Added c4d.RENDERFLAGS_RENDERQUEUEERRORS.

• Added c4d.IN_EXCLUDE_FLAG_NO_RESIZABLE.

• Replaced PREFS_PRI with PREFS. Impacted functions: c4d.plugins.RegisterPreferencePlugin() and c4d.PrefsLib_OpenDialog().

Changes

• maxon.Object renamed maxon.ObjectInterface().

R21 SP2

This Service pack for Cinema 4D R21 did not change any API functionality.