Cinema 4D 2023.1.0 SDK

Cinema 4D 2023.1.0 SDK
- Updated scripts\02_data_algorithms\maxon_datadictionary_2023_1.py
- Updated nodes example to not use anymore AddGraph but instead use CreateDefaultGraph.

Author: gr4ph0s

scripts/02_data_algorithms/maxon_datadictionary_2023_1.py

@@ -0,0 +1,89 @@
+"""
+Copyright: MAXON Computer GmbH
+Author: Maxime Adam, Ferdinand Hoppe
+
+Highlights the key-functionalities of maxon.DataDictionary.
+
+Topics:
+    - Constructing DataDictionary instances.
+    - Reading, writing, and deleting key-value pairs.
+    - Retrieving the number of contained pairs.
+    - Testing if a specific key is contained.
+    - Testing equality.
+"""
+import typing
+import maxon
+
+def main():
+    # A Python dictionary object as a data source.
+    pyDict: dict = {42: "The answer.", "pi": 3.1415, True: "A string"}
+
+    # Create a reference to a `DataDictionaryInterface` object.
+    dataDict: maxon.DataDictionary = maxon.DataDictionary()
+
+    # Items can be set with the `.Set` method or with the bracket syntax. Just as the standard 
+    # Python dictionary, the type `DataDictionary` supports mixed key and value types.
+    dataDict.Set("myKey", "foo")
+    for key, value in pyDict.items():
+        dataDict[key] = value
+
+    # However, only the most atomic Python types as string, int, float, and bool are being
+    # automatically converted to their maxon API equivalent. For storing a list of integer values 
+    # under a key for example, one must convert that list explicitly to a BaseArray.
+    dataDict["prime_numbers"] = maxon.BaseArray(maxon.Int32, [2, 3, 5, 7, 11, 13])
+    
+    # The number of key-value pairs in a `DataDictionary` instance can be evaluated with with 
+    # `len()` and `.GetCount()`. Alternatively, `.IsPopulated()` or `IsEmpty() can be called to 
+    # evaluate if an instance is empty or not.
+    length: int = len(dataDict)
+    alsoLength: int = dataDict.GetCount()
+    isPopulated: bool = dataDict.IsPopulated()
+    isEmpty: bool = dataDict.IsEmpty()
+    print (f"\ndataDict: {length = }, {alsoLength = },  {isPopulated = },  {isEmpty = }")
+
+    # Other than the standard Python dictionary, a `DataDictionary` instance will yield directly 
+    # key-value pairs when iterated. Values can also be accessed with the bracket syntax and the
+    # method `.Get` which works similar to the method of the same name of a Python dict.
+    print ("\nState of dataDict:")
+    for key, value in dataDict:
+        print (f"\t{key = }, {value = }")
+
+    pi: float = dataDict["pi"]
+    # Will return the default value None, as the key "bar" does not exist.
+    bar: typing.Optional[str] = dataDict.Get("bar", None)
+
+    # The occurrence of a key can be tested with the keyword `in` or the method `.Contains()`.
+    hasKeyPi: bool = "pi" in dataDict
+    hasKeyBar: bool = dataDict.Contains("bar")
+    print (f"\ndataDict: {hasKeyPi = }, {hasKeyBar = }")
+
+    # Key-value pairs can be removed with the `del` keyword or the method `.Erase()`.
+    del dataDict["pi"]
+    dataDict.Erase(42)
+    
+    print ("\nNew state of dataDict:")
+    for key, value in dataDict:
+        print (f"\t{key = }, {value = }")
+
+    # DataDictionary instances can also be compared for equaltiy but the comparison is carried out
+    # as an identity comparison.
+
+    # Two data dictionaries which are are being filled with the same content.
+    aData: maxon.DataDictionary = maxon.DataDictionary()
+    bData: maxon.DataDictionary = maxon.DataDictionary()
+
+    aData[1000] = "Hello World!"
+    aData["value"] = 42
+    bData[1000] = "Hello World!"
+    bData["value"] = 42
+
+     # Will evaluate as `True` because `xData` points to the same object as `aData`.
+    xData: maxon.DataDictionary = aData
+    print (f"\n{aData == xData = }")
+
+    # Will evaluate as `False` because `aData` points to another object than `bData`. Not the
+    # content is being compared, but the identity of the two objects.
+    print (f"{aData == bData = }")
+
+if __name__ == "__main__":
+    main()

scripts/02_data_algorithms/maxon_datadictionary_r20.py

@@ -9,14 +9,14 @@
     NodeMaterials inherit from BaseMaterial. To be able to use the functions 
     that are in the NodeMaterial class, the BaseMaterial must be cast to a 
     NodeMaterial. This is done with the function GetNodeMaterialReference. To 
-    add a graph to an existing node space, one must use the function AddGraph.
+    create a graph to an existing node space, one must use the function CreateDefaultGraph.
     If one wants to have access to an already added node graph, one must 
     retrieve the nimbus reference which does store the graph. Once one has 
     retrieved the graph, one can access the root that contains all the nodes.
     
 Class/method highlighted:
     - GetNodeMaterialReference
-    - AddGraph
+    - CreateDefaultGraph
     - GetActiveNodeSpaceId
     - GetChildren
     - GetNimbusRef
@@ -46,11 +46,11 @@ def CreateMaterialForNodeSpace(nodespaceId):
         raise ValueError("Cannot retrieve nodeMaterial reference.")
 
     # Add a graph for the space Id
-    addedGraph = nodeMaterial.AddGraph(nodespaceId)
-    if addedGraph is None:
-        raise ValueError("Cannot add a GraphNode for this NodeSpace.")
+    createdGraph = nodeMaterial.CreateDefaultGraph(nodespaceId)
+    if createdGraph is None:
+        raise ValueError("Cannot create a GraphNode for this NodeSpace.")
 
-    # Retrieve the Nimbus reference for a specific NodeSpace. This Nimbus reference allow you to retreive the end node.
+    # Retrieve the Nimbus reference for a specific NodeSpace. This Nimbus reference allow you to retrieve the end node.
     nimbusRef = mat.GetNimbusRef(nodespaceId)
     if nimbusRef is None:
         raise ValueError(
@@ -101,13 +101,13 @@ def main():
     # Do the same with the Redshift node space. The Redshift plugin is not 
     # installed by default, so we call the function in an exception handling
     # context.
-    redShiftNodeSpPaceId = maxon.Id("com.redshift3d.redshift4c4d.class.nodespace")
-    if c4d.GetActiveNodeSpaceId() != redShiftNodeSpPaceId:
+    redshiftNodeSpaceId = maxon.Id("com.redshift3d.redshift4c4d.class.nodespace")
+    if c4d.GetActiveNodeSpaceId() != redshiftNodeSpaceId:
         try:
-            root = CreateMaterialForNodeSpace(redShiftNodeSpPaceId)
+            root = CreateMaterialForNodeSpace(redshiftNodeSpaceId)
             PrintChildren(root)
         except:
-            print(f"The node space with id {redShiftNodeSpPaceId} does not exist")
+            print(f"The node space with id {redshiftNodeSpaceId} does not exist")
 
     # Pushes an update event to Cinema 4D
     c4d.EventAdd()

scripts/05_modules/node/create_nodematerial_r26.py

@@ -26,17 +26,20 @@ def main():
     if nodeMaterial is None:
         raise ValueError("Cannot retrieve nodeMaterial reference")
 
-    # Create the node space ID for the standard's node space
-    nodespaceId = maxon.Id("net.maxon.nodespace.standard")
-
-    # Add a graph for the standard node space
-    addedGraph = nodeMaterial.AddGraph(nodespaceId)
+    # Define the ID of standard material node space and print a warning when the active node space
+    # is not the the standard material node space.
+    nodeSpaceId = maxon.Id("net.maxon.nodespace.standard")
+    if nodeSpaceId != c4d.GetActiveNodeSpaceId():
+        print (f"Warning: Active node space is not: {nodeSpaceId}")
+
+    # Add a graph for the standard node space.
+    addedGraph = nodeMaterial.CreateDefaultGraph(nodeSpaceId)
     if addedGraph is None:
         raise ValueError("Cannot add a graph node for this node space")
 
     # Retrieve the Nimbus reference for a specific node space from which we 
     # will retrieve the graph. One could also use 'addedGraph' defined above.
-    nimbusRef = mat.GetNimbusRef(nodespaceId)
+    nimbusRef = mat.GetNimbusRef(nodeSpaceId)
     if nimbusRef is None:
         raise ValueError("Cannot retrieve the nimbus ref for that node space")
 

scripts/05_modules/node/modify_port_value_r26.py

@@ -9,7 +9,7 @@
 Class/method highlighted:
     - BeginTransaction
     - SelectPort
-    - SelectWire
+    - SelectConnection
 """
 import c4d
 import maxon
@@ -32,7 +32,7 @@ def main():
     nodespaceId = c4d.GetActiveNodeSpaceId()
 
     # Add a graph for the space Id
-    addedGraph = nodeMaterial.AddGraph(nodespaceId)
+    addedGraph = nodeMaterial.CreateDefaultGraph(nodespaceId)
     if addedGraph is None:
         raise ValueError("Cannot add a graphnode for this nodespace")
 
@@ -105,7 +105,7 @@ def PrintConnection(port):
         res = port.GetConnections(maxon.PORT_DIR.OUTPUT, connections)
         print(port, res, connections)
         for connection in connections:
-            graph.SelectWire(port, connection[0])
+            maxon.GraphModelHelper.SelectConnection(port, connection[0])
         return True
 
     # Select the wire between the material node (end node) and the BSDF node

scripts/05_modules/node/nodegraph_selection_r26.py

@@ -30,7 +30,7 @@ def main():
     nodespaceId = c4d.GetActiveNodeSpaceId()
 
     # Add a graph for the space Id
-    addedGraph = nodeMaterial.AddGraph(nodespaceId)
+    addedGraph = nodeMaterial.CreateDefaultGraph(nodespaceId)
     if addedGraph is None:
         raise ValueError("Cannot add a graphnode for this nodespace")