Python SDK example for Cinema 4D 2024.2.0

Author: maxon-madam

plugins/py-custom_icon_r21/py-custom_icon_r21.pyp

@@ -22,11 +22,12 @@ PLUGIN_ID = 1053134
 
 class CustomIconObjectData(c4d.plugins.ObjectData):
 
-    def Init(self, node):
+    def Init(self, node, isCloneInit=False):
         """Called by Cinema 4D to initialize the instance.
 
         Args:
             node (c4d.GeListNode): The instance of the ObjectData.
+            isCloneInit (bool): True if the object data is a copy of another one.
 
         Returns:
             bool: True on success, otherwise False.
@@ -43,10 +44,6 @@ class CustomIconObjectData(c4d.plugins.ObjectData):
         # Defines the custom color mode used with the previously created BaseContainer already filled
         iconSettings.SetContainer(0, iconSpecialModes)
 
-        # Since we are going to use our custom MSG_GETCUSTOMICONS code,
-        # set this to True so parent object (e.g. BaseObject) will ignore MSG_GETCUSTOMICONS messages.
-        iconSettings.SetBool(c4d.ID_ICONCHOOSER_SETTINGS_PARENT_IGNORE, True)
-
         #  Sets icon settings container into the current Object instance data container
         node.GetDataInstance().SetContainer(c4d.ID_ICONCHOOSER_SETTINGS, iconSettings)
 
@@ -93,7 +90,7 @@ class CustomIconObjectData(c4d.plugins.ObjectData):
             settings._specialColors = arr
 
             # Fills the CustomIconSettings with the passed BaseContainer object
-            c4d.CustomIconSettings.FillCustomIconSettingsFromBaseList2D(settings, node.GetData(), node.GetType(), True)
+            c4d.CustomIconSettings.FillCustomIconSettingsFromBaseList2D(settings, node.GetDataInstance(), node.GetType(), True)
 
             # Finally fills the icon Data settings with the CustomIconSettings
             c4d.CustomIconSettings.GetCustomIcon(data, settings, True)
@@ -115,9 +112,11 @@ if __name__ == "__main__":
         raise MemoryError("Failed to initialize the BaseBitmap.")
 
     # Registers the object plugin
+    # Since we are going to use our custom MSG_GETCUSTOMICONS code,
+    # set TAG_ICONCHOOSER_PARENT_IGNORE o parent object (e.g. BaseObject) will ignore MSG_GETCUSTOMICONS messages.
     c4d.plugins.RegisterObjectPlugin(id=PLUGIN_ID,
                                      str="py-Custom Icon Object Data",
                                      g=CustomIconObjectData,
                                      description="py_custom_icon",
                                      icon=bmp,
-                                     info=c4d.OBJECT_GENERATOR)
+                                     info=c4d.OBJECT_GENERATOR | c4d.TAG_ICONCHOOSER_PARENT_IGNORE)

plugins/py-double_circle_r19/py-double_circle_r19.pyp

@@ -147,11 +147,12 @@ class DoubleCircleHelper(object):
 class DoubleCircleData(c4d.plugins.ObjectData, DoubleCircleHelper):
     """CircleObject Generator"""
 
-    def Init(self, node):
+    def Init(self, node, isCloneInit=False):
         """Called when Cinema 4D initializes the ObjectData.
 
         Args:
             node (c4d.GeListNode): The instance of the ObjectData.
+            isCloneInit (bool): True if the object data is a copy of another one.
 
         Returns:
             bool: True on success, otherwise False.
@@ -161,14 +162,15 @@ class DoubleCircleData(c4d.plugins.ObjectData, DoubleCircleHelper):
         if data is None:
             return False
 
-        # Defines default values in the BaseContainer
-        data.SetFloat(c4d.PYCIRCLEOBJECT_RAD, 200.0)
-        data.SetInt32(c4d.PRIM_PLANE, c4d.PRIM_PLANE_XY)
-        data.SetBool(c4d.PRIM_REVERSE, False)
-        data.SetInt32(c4d.SPLINEOBJECT_INTERPOLATION, c4d.SPLINEOBJECT_INTERPOLATION_ADAPTIVE)
-        data.SetInt32(c4d.SPLINEOBJECT_SUB, 8)
-        data.SetFloat(c4d.SPLINEOBJECT_ANGLE, c4d.utils.Rad(5.0))
-        data.SetFloat(c4d.SPLINEOBJECT_MAXIMUMLENGTH, 5.0)
+        if not isCloneInit:
+            # Defines default values in the BaseContainer
+            data.SetFloat(c4d.PYCIRCLEOBJECT_RAD, 200.0)
+            data.SetInt32(c4d.PRIM_PLANE, c4d.PRIM_PLANE_XY)
+            data.SetBool(c4d.PRIM_REVERSE, False)
+            data.SetInt32(c4d.SPLINEOBJECT_INTERPOLATION, c4d.SPLINEOBJECT_INTERPOLATION_ADAPTIVE)
+            data.SetInt32(c4d.SPLINEOBJECT_SUB, 8)
+            data.SetFloat(c4d.SPLINEOBJECT_ANGLE, c4d.utils.Rad(5.0))
+            data.SetFloat(c4d.SPLINEOBJECT_MAXIMUMLENGTH, 5.0)
         return True
 
     def GetContour(self, node, doc, lod, bt):

plugins/py-dynamic_parameters_object_r18/py-dynamic_parameters_object_r18.pyp

@@ -42,18 +42,20 @@ class DynamicParametersObjectData(c4d.plugins.ObjectData):
         self.parameters = []    # Dynamic parameters value
         self.randomID = 0       # Random dynamic parameter ID to disable (see GetDEnabling() below)
 
-    def Init(self, node):
+    def Init(self, node, isCloneInit=False):
         """Called by Cinema 4D on the initialization of the ObjectData, usually the place to define parameters value.
 
         Args:
             node (c4d.GeListNode): The instance of the ObjectData.
+            isCloneInit (bool): True if the object data is a copy of another one.
 
         Returns:
             bool: True if the initialization was successful, otherwise False, preventing Cinema 4D from creating the object.
         """
 
-        # Defines how many parameters the object will have
-        node[c4d.OPYDYNAMICPARAMETERSOBJECT_PARAMETERSNUMBER] = 10
+        if not isCloneInit:
+            # Defines how many parameters the object will have
+            node[c4d.OPYDYNAMICPARAMETERSOBJECT_PARAMETERSNUMBER] = 10
 
         return True
 

plugins/py-ies_meta_r12/py-ies-meta-loader.pyp

@@ -77,17 +77,23 @@ class IESMetaLoader(c4d.plugins.SceneLoaderData):
     """IESMeta Loader"""
     dialog = None
 
-    def Init(self, node):
+    def Init(self, node, isCloneInit=False):
         """
         Called when a new instance of this object is created. In this context, this allow to define
         the option by default for the SceneLoaderPlugin that will be displayed to the user.
-        
+
+        Args:
+            node (c4d.GeListNode): The instance of the SceneLoaderData.
+            isCloneInit (bool): True if the scene loader data is a copy of another one.
+
         Returns:
             bool: False if there was an error, otherwise True.
         """
         # Define the default value for the parameters.
         self.InitAttr(node, bool, IES_IMPORT_PRINT_TO_CONSOLE)
-        node[IES_IMPORT_PRINT_TO_CONSOLE] = True
+
+        if not isCloneInit:
+            node[IES_IMPORT_PRINT_TO_CONSOLE] = True
         return True
 
     def Identify(self, node, name, probe, size):

plugins/py-look_at_camera_r13/py-look_at_camera_r13.pyp

@@ -20,11 +20,12 @@ PLUGIN_ID = 1028284
 class LookAtCamera(c4d.plugins.TagData):
     """Look at Camera"""
 
-    def Init(self, node):
+    def Init(self, node, isCloneInit=False):
         """Called when Cinema 4D Initialize the TagData (used to define, default values).
 
         Args:
             node (c4d.GeListNode): The instance of the TagData.
+            isCloneInit (bool): True if the tag data is a copy of another one.
 
         Returns:
             True on success, otherwise False.

plugins/py-osffset_y_spline_r16/py-osffset_y_spline_r16.pyp

@@ -172,12 +172,22 @@ class OffsetYSpline(c4d.plugins.ObjectData):
     _childContourDirty = 0  # type: int
     _childGVODirty = -1  # type: int
 
-    def Init(self, op):
+    def Init(self, op, isCloneInit=False):
+        """Called when Cinema 4D Initialize the ObjectData (used to define, default values).
+
+        Args:
+            op: (c4d.GeListNode): The instance of the ObjectData.
+            isCloneInit (bool): True if the object data is a copy of another one.
+
+        Returns:
+            bool: True on success, otherwise False.
+        """
         if op is None:
             raise RuntimeError("Failed to retrieve op.")
 
         self.InitAttr(op, float, [c4d.PY_OFFSETYSPLINE_OFFSET])
-        op[c4d.PY_OFFSETYSPLINE_OFFSET] = 100.0
+        if not isCloneInit:
+            op[c4d.PY_OFFSETYSPLINE_OFFSET] = 100.0
 
         # Defines members variable to store the dirty state of Children Spline
         self._childContourDirty = 0

plugins/py-preference_r19/py-preference_r19.pyp

@@ -101,11 +101,12 @@ class PreferenceHelper(object):
 
 class Preference(c4d.plugins.PreferenceData, PreferenceHelper):
 
-    def Init(self, node):
+    def Init(self, node, isCloneInit=False):
         """Called by Cinema 4D on the initialization of the PreferenceData, the place to define the type of object.
 
         Args:
             node (c4d.GeListNode): The instance of the PreferenceData.
+            isCloneInit (bool): True if the preference data is a copy of another one.
 
         Returns:
             True if the initialization success, otherwise False will not create the object.

plugins/py-rounded_tube_r13/py-rounded_tube_r13.pyp

@@ -150,11 +150,12 @@ class RoundedTube(c4d.plugins.ObjectData, RoundedTubeHelper):
         super(RoundedTube, self).__init__(*args)
         self.SetOptimizeCache(True)
 
-    def Init(self, op):
+    def Init(self, op, isCloneInit=False):
         """Called when Cinema 4D Initialize the ObjectData (used to define, default values).
 
         Args:
             op: (c4d.GeListNode): The instance of the ObjectData.
+            isCloneInit (bool): True if the object data is a copy of another one.
 
         Returns:
             bool: True on success, otherwise False.
@@ -168,14 +169,15 @@ class RoundedTube(c4d.plugins.ObjectData, RoundedTubeHelper):
         self.InitAttr(op, int, c4d.PY_TUBEOBJECT_SEG)
         self.InitAttr(op, int, c4d.PRIM_AXIS)
 
-        op[c4d.PY_TUBEOBJECT_RAD] = 200.0
-        op[c4d.PY_TUBEOBJECT_IRADX] = 50.0
-        op[c4d.PY_TUBEOBJECT_IRADY] = 50.0
-        op[c4d.PY_TUBEOBJECT_SUB] = 1
-        op[c4d.PY_TUBEOBJECT_ROUNDSUB] = 8
-        op[c4d.PY_TUBEOBJECT_ROUNDRAD] = 10.0
-        op[c4d.PY_TUBEOBJECT_SEG] = 36
-        op[c4d.PRIM_AXIS] = c4d.PRIM_AXIS_YP
+        if not isCloneInit:
+            op[c4d.PY_TUBEOBJECT_RAD] = 200.0
+            op[c4d.PY_TUBEOBJECT_IRADX] = 50.0
+            op[c4d.PY_TUBEOBJECT_IRADY] = 50.0
+            op[c4d.PY_TUBEOBJECT_SUB] = 1
+            op[c4d.PY_TUBEOBJECT_ROUNDSUB] = 8
+            op[c4d.PY_TUBEOBJECT_ROUNDRAD] = 10.0
+            op[c4d.PY_TUBEOBJECT_SEG] = 36
+            op[c4d.PRIM_AXIS] = c4d.PRIM_AXIS_YP
         return True
 
     def GetDimension(self, op, mp, rad):

plugins/py-sculpt_modifier_deformer_r16/sculpt_modifier_deformer_r16.pyp

@@ -31,11 +31,12 @@ class SculptModifierDeformer(c4d.plugins.ObjectData):
     def __init__(self):
         self.brushInterface = None
 
-    def Init(self, node):
+    def Init(self, node, isCloneInit=False):
         """Called when Cinema 4D Initialize the ObjectData (used to define, default values).
 
         Args:
             node (c4d.GeListNode): The instance of the ObjectData.
+            isCloneInit (bool): True if the object data is a copy of another one.
 
         Returns:
             True on success, otherwise False.
@@ -48,13 +49,14 @@ class SculptModifierDeformer(c4d.plugins.ObjectData):
         self.InitAttr(node, int, c4d.PYSCULPTMODIFIERDEFORMER_SEED)
         self.InitAttr(node, float, c4d.PYSCULPTMODIFIERDEFORMER_STAMP_ROTATION)
 
-        node[c4d.PYSCULPTMODIFIERDEFORMER_RADIUS] = 20
-        node[c4d.PYSCULPTMODIFIERDEFORMER_PRESSURE] = 0.2
-        node[c4d.PYSCULPTMODIFIERDEFORMER_STAMP_ACTIVE] = False
-        node[c4d.PYSCULPTMODIFIERDEFORMER_NUMSTAMPS] = 10
-        node[c4d.PYSCULPTMODIFIERDEFORMER_STAMP_USEFALLOFF] = True
-        node[c4d.PYSCULPTMODIFIERDEFORMER_SEED] = 0
-        node[c4d.PYSCULPTMODIFIERDEFORMER_STAMP_ROTATION] = 0
+        if not isCloneInit:
+            node[c4d.PYSCULPTMODIFIERDEFORMER_RADIUS] = 20
+            node[c4d.PYSCULPTMODIFIERDEFORMER_PRESSURE] = 0.2
+            node[c4d.PYSCULPTMODIFIERDEFORMER_STAMP_ACTIVE] = False
+            node[c4d.PYSCULPTMODIFIERDEFORMER_NUMSTAMPS] = 10
+            node[c4d.PYSCULPTMODIFIERDEFORMER_STAMP_USEFALLOFF] = True
+            node[c4d.PYSCULPTMODIFIERDEFORMER_SEED] = 0
+            node[c4d.PYSCULPTMODIFIERDEFORMER_STAMP_ROTATION] = 0
 
         self.brushInterface = c4d.modules.sculpting.SculptModifierInterface()
 

plugins/py-spherify_modifier_r13/py-spherify_modifier_r13.pyp

@@ -38,20 +38,22 @@ class SpherifyModifier(c4d.plugins.ObjectData):
         self.falloff = None
         self.falloffDirty = True
 
-    def Init(self, op):
+    def Init(self, op, isCloneInit=False):
         """Called when Cinema 4D Initialize the ObjectData (used to define, default values).
 
         Args:
             op: (c4d.GeListNode): The instance of the ObjectData.
+            isCloneInit (bool): True if the object data is a copy of another one.
 
         Returns:
             True on success, otherwise False.
         """
         self.InitAttr(op, float, c4d.PYSPHERIFYMODIFIER_RADIUS)
         self.InitAttr(op, float, c4d.PYSPHERIFYMODIFIER_STRENGTH)
 
-        op[c4d.PYSPHERIFYMODIFIER_RADIUS] = 200.0
-        op[c4d.PYSPHERIFYMODIFIER_STRENGTH] = 0.5
+        if not isCloneInit:
+            op[c4d.PYSPHERIFYMODIFIER_RADIUS] = 200.0
+            op[c4d.PYSPHERIFYMODIFIER_STRENGTH] = 0.5
 
         # Assigns falloff
         if self.falloff is None and c4d.API_VERSION > 19000:

scripts/03_application_development/files_media/import_obj_r13.py

@@ -37,7 +37,7 @@ def main():
         raise RuntimeError("Failed to retrieve BaseContainer private data.")
 
     # Defines the settings
-    objImport[c4d.OBJIMPORTOPTIONS_PHONG_ANGLE_DEFAULT] = 22.5
+    objImport[c4d.OBJIMPORTOPTIONS_PHONG_ANGLE_DEFAULT] = c4d.utils.DegToRad(22.5)
     if c4d.GetC4DVersion() > 22600:
         objImport[c4d.OBJIMPORTOPTIONS_IMPORT_UVS] = c4d.OBJIMPORTOPTIONS_UV_ORIGINAL
     else: