S26 Release

Add new example for the Asset frameworks
Add new example for Geometry handling

Author: gr4ph0s

plugins/py-sculpt_modifier_deformer_r16/res/c4d_symbols.h

@@ -1,5 +1,5 @@
-enum
-{
-    // End of symbol definition
-    _DUMMY_ELEMENT_
-};
+enum
+{
+    // End of symbol definition
+    _DUMMY_ELEMENT_
+};

scripts/01_foundations/load_python_script_r26.py

@@ -0,0 +1,117 @@
+"""
+Copyright: MAXON Computer GmbH
+Author: Maxime Adam
+
+Description:
+    - Create a new temporary script.
+    - Load an existing Python file into the Script Manager.
+    - Retrieve the first script not active in the script manager and make it active.
+
+Class/method highlighted:
+    - c4d.CreateNewPythonScript()
+    - c4d.LoadPythonScript()
+    - c4d.GetScriptHead()
+    - c4d.GetDynamicScriptID()
+    - c4d.SetActiveScriptObject()
+"""
+import c4d
+import os
+
+
+def CreateNewPythonScript():
+    """ Create a new temporary script.
+    """
+    # Create a new temporary script. The first argument is the script name. If an empty string is used as the script
+    # name, Cinema 4D will generate automatically the name. The second argument being the content of the script.
+    # The new script will be set as active automatically.
+    newScript = c4d.CreateNewPythonScript("", r"print('Sometimes science is more art than science.')")
+
+    # ScriptObject being BaseList2D the usual C4DAtom bracket operator can be used to access various properties from it.
+    scriptName = newScript[c4d.PYTHONSCRIPT_SCRIPTNAME]
+
+    # An empty PYTHONSCRIPT_SCRIPTPATH indicate that this script is not saved and will be deleted once Cinema 4D close.
+    scriptPath = newScript[c4d.PYTHONSCRIPT_SCRIPTPATH]
+
+    # PYTHONSCRIPT_TEXT returns the python script visible in hte Script Manager.
+    scriptContent = newScript[c4d.PYTHONSCRIPT_TEXT]
+
+    print(f"Added '{scriptName}', it's content in the Script Manager is:\n{scriptContent}")
+
+
+def LoadExistingPythonScript():
+    """Load an existing Python file into the Script Manager.
+    """
+    scriptPathToLoad = os.path.join(os.path.dirname(__file__), "reg_plugin_info_r23.py")
+
+    # Load the script in the script manager and set it as active automatically
+    loadedScript = c4d.LoadPythonScript(scriptPathToLoad)
+
+    # ScriptObject being BaseList2D the usual C4DAtom bracket operator can be used to access various properties from it.
+    scriptName = loadedScript[c4d.PYTHONSCRIPT_SCRIPTNAME]
+
+    # An empty PYTHONSCRIPT_SCRIPTPATHindicate that this script is not saved and will be deleted once Cinema 4D close.
+    scriptPath = loadedScript[c4d.PYTHONSCRIPT_SCRIPTPATH]
+
+    # PYTHONSCRIPT_TEXT returns the python script visible in hte Script Manager.
+    scriptContent = loadedScript[c4d.PYTHONSCRIPT_TEXT]
+
+    print(f"Load '{scriptName}', from '{scriptPath}' it's content in the Script Manager is:\n{scriptContent}")
+
+
+def SetActiveScript():
+    """Retrieve the first script not active in the script manager and make it active.
+
+    Scripts available in the script manager are BaseList2D stored into a specific GeListHead.
+    """
+    def HierarchyIterator(obj):
+        """A Python Generator to iterate over the Hierarchy.
+        Args:
+            obj: The starting object of the python generator (will be the first result)
+        Returns:
+            All objects under and next of the `obj`
+        """
+        while obj:
+            yield obj
+            for opChild in HierarchyIterator(obj.GetDown()):
+                yield opChild
+            obj = obj.GetNext()
+
+    # Retrieve the script list head.
+    scriptHead = c4d.GetScriptHead()
+
+    # Retrieve the first script not active in the script manager and make it active.
+    # A script is active when it has its code displayed in the script manager.
+    for scriptOp in HierarchyIterator(scriptHead.GetFirst()):
+        # Go to the next script object if the script is already active in the script manager.
+        if scriptOp.GetBit(c4d.BIT_ACTIVE):
+            continue
+
+        # Retrieve the unique plugin ID generated by Cinema 4D for this script.
+        scriptId = c4d.GetDynamicScriptID(scriptOp)
+
+        # Define this script as the new script to be active in the script manager.
+        c4d.SetActiveScriptObject(scriptId)
+
+        # ScriptObject being BaseList2D the usual C4DAtom bracket operator can be used to access various properties from it.
+        scriptName = scriptOp[c4d.PYTHONSCRIPT_SCRIPTNAME]
+
+        # An empty PYTHONSCRIPT_SCRIPTPATH indicate that this script is not saved and will be deleted once Cinema 4D close.
+        scriptPath = scriptOp[c4d.PYTHONSCRIPT_SCRIPTPATH]
+
+        # PYTHONSCRIPT_TEXT returns the python script visible in hte Script Manager.
+        scriptContent = scriptOp[c4d.PYTHONSCRIPT_TEXT]
+
+        print(f"Set as active '{scriptName}', saved in `{scriptPath}` with the next content in"
+              f" the Script Manager is:\n{scriptContent}")
+
+        break
+
+
+def main():
+    CreateNewPythonScript()
+    LoadExistingPythonScript()
+    SetActiveScript()
+
+
+if __name__ == "__main__":
+    main()

scripts/01_foundations/readme.md

@@ -16,6 +16,10 @@ Maxon API:
 
 ## Examples
 
+### load_python_script
+
+	Handle the scripts managed by the Script Manager programmatically.
+
 ### reg_plugin_info
 
     Stores plugin information.

scripts/02_data_algorithms/datatype_gradient_r21.py

@@ -0,0 +1,66 @@
+"""
+Copyright: MAXON Computer GmbH
+Author: Maxime Adam, Ferdinand Hoppe
+
+Description:
+    - Showcases the usage of the custom data type `c4d.Gradient`.
+    - Creates a material with a gradient shader in the color channel.
+
+Class/method highlighted:
+    - c4d.BaseMaterial
+    - c4d.BaseShader
+    - c4d.Gradient
+    - c4d.BaseContainer
+
+"""
+
+import c4d
+
+def main():
+    # Create a new material and a new gradient shader.
+    material = c4d.BaseMaterial(c4d.Mmaterial)
+    shader = c4d.BaseShader(c4d.Xgradient)
+    
+    # Get a copy of the c4d.Gradient data referenced by the gradient shader
+    # and a copy of the knot data stored in the c4d.Gradient data. The knot
+    # data is expressed as a c4d.BaseCoontainer.
+    gradient = shader[c4d.SLA_GRADIENT_GRADIENT]
+    knotData = gradient.GetData(c4d.GRADIENT_KNOT)
+    
+    # Iterate over all knots in the knot data container and set their 
+    # interpolations to linear. Each knot in the knot data container is itself 
+    # a c4d.BaseContainer, storing the data for a single knot.
+    for _, knot in knotData:
+        knot[c4d.GRADIENTKNOT_INTERPOLATION] = c4d.GRADIENT_INTERPOLATION_NONE
+
+    # Items can also be retrieved by their index from a BaseContainer, here 
+    # the first index, i.e., second item, in the container. In this case the 
+    # position of the knot is written and then the knot container is being 
+    # written back into the index its has been retrieved from.
+    knot = knotData.GetIndexData(1)
+
+    knot[c4d.GRADIENTKNOT_POSITION] = 0.5
+    knotData.SetIndexData(1, knot)
+    
+    # After these modifications the knots must be written back into the 
+    # c4d.Gradient data, because GetData() returned a copy above. This also
+    # does apply to the shader and its gradient for the same reason.
+    gradient.SetData(c4d.GRADIENT_KNOT, knotData)
+    shader[c4d.SLA_GRADIENT_GRADIENT] = gradient
+    
+    # Aside from assigning the shader to the correct parameter of the 
+    # material, it is also important to call BaseList2D.InsertShader(), as 
+    # otherwise the setup will not work.
+    material.InsertShader(shader)
+    material[c4d.MATERIAL_COLOR_SHADER] = shader
+
+    # Finally, the material is being inserted into the active document and an
+    # update event is being pushed event to Cinema 4D, so that its GUI can 
+    # catch up to our changes. 'doc' is a predefined module attribute in 
+    # script manger scripts which points to the active document. It is
+    # equivalent to c4d.documents.GetActiveDocument().
+    doc.InsertMaterial(material)
+    c4d.EventAdd()
+
+if __name__=='__main__':
+    main()

scripts/02_data_algorithms/readme.md

@@ -32,9 +32,12 @@ Maxon API:
     Creates a Luka Noise into a BaseBitmap.
     Displays this BaseBitmap into the Picture Viewer.
 
+### datatype_gradient
+
+    Showcases the usage of the custom data type c4d.Gradient.
+
 ### icondata_basic
 
-
     Displays the icon of the selected object into the Picture Viewer.
     Before R21 it's possible to call BaseList2D.GetIcon which will returns a dictionary representing an IconData.