Merge pull request #7 from compas-dev/new-options

new: #6 add simplify/reverse/flatten/graft options

Author: gonzalocasas

README.md

@@ -149,11 +149,19 @@ An alternative is to include them in your packaging steps, e.g. calling `python
       `none`, `ghdoc`, `float`, `bool`, `int`, `complex`, `str`, `datetime`, `guid`,
       `color`, `point`, `vector`, `plane`, `interval`, `uvinterval`, `box`, `transform`,
       `line`, `circle`, `arc`, `polyline`, `rectangle`, `curve`, `mesh`, `surface`, `subd`, `brep`.
+    * `reverse`: **(optional)** Defines whether data inside the parameter is reversed. Defaults to `False`.
+    * `simplify`: **(optional)** Defines whether data inside the parameter is simplified. Defaults to `False`.
+    * `flatten`: **(optional)** Defines whether data inside the parameter is flattened. Mutually exclusive with `graft`. Defaults to `False`.
+    * `graft`: **(optional)** Defines whether data inside the parameter is grafted. Mutually exclusive with `flatten`. Defaults to `False`.
   * `outputParameters`: List of output parameters.
     * `name`: Name of the output parameter.
     * `nickname`: **(optional)** Abbreviation of the output parameter. Defaults to the same as `name`.
     * `description`: **(optional)** Description of the output parameter.
     * `optional`: **(optional)** Defines whether the output parameter is optional or not. Defaults to `False`.
+    * `reverse`: **(optional)** Defines whether data inside the parameter is reversed. Defaults to `False`.
+    * `simplify`: **(optional)** Defines whether data inside the parameter is simplified. Defaults to `False`.
+    * `flatten`: **(optional)** Defines whether data inside the parameter is flattened. Mutually exclusive with `graft`. Defaults to `False`.
+    * `graft`: **(optional)** Defines whether data inside the parameter is grafted. Mutually exclusive with `flatten`. Defaults to `False`.
 
 ## Caveats
 

componentize.py

@@ -250,6 +250,13 @@ def create_ghuser_component(source, target, version=None, prefix=None):
         pi_chunk.SetGuid('InstanceGuid', input_instance_guid)
         pi_chunk.SetGuid('TypeHintID', parse_param_type_hint(pi.get('typeHintID')))
         pi_chunk.SetInt32('WireDisplay', parse_wire_display(pi.get('wireDisplay', WIRE_DISPLAY['default'])))
+        pi_chunk.SetBoolean('ReverseData', pi.get('reverse', False))
+        pi_chunk.SetBoolean('SimplifyData', pi.get('simplify', False))
+        # Mutually exclusive options
+        if pi.get('flatten', False):
+            pi_chunk.SetInt32('Mapping', 1)
+        elif pi.get('graft', False):
+            pi_chunk.SetInt32('Mapping', 2)
 
     for i, po in enumerate(outputParam):
         output_instance_guid = System.Guid.NewGuid()
@@ -260,6 +267,13 @@ def create_ghuser_component(source, target, version=None, prefix=None):
         po_chunk.SetBoolean('Optional', po.get('optional', False))
         po_chunk.SetInt32('SourceCount', 0)
         po_chunk.SetGuid('InstanceGuid', output_instance_guid)
+        po_chunk.SetBoolean('ReverseData', pi.get('reverse', False))
+        po_chunk.SetBoolean('SimplifyData', pi.get('simplify', False))
+        # Mutually exclusive options
+        if po.get('flatten', False):
+            po_chunk.SetInt32('Mapping', 1)
+        elif po.get('graft', False):
+            po_chunk.SetInt32('Mapping', 2)
 
     # print(ghpython_root.Serialize_Xml())
     root.SetByteArray('Object', ghpython_root.Serialize_Binary())

examples/Test_KitchenSink/metadata.json

@@ -6,7 +6,6 @@
     "description": "This is an example with the everything and the kitchen sink in it, just to show all available options.",
     "exposure": 4,
     "instanceGuid": "cdd47086-f902-4b77-825b-6b79c3aaecc1",
-
     "ghpython": {
         "hideOutput": true,
         "hideInput": true,
@@ -24,7 +23,9 @@
                 "scriptParamAccess": "item",
                 "wireDisplay": "faint",
                 "sourceCount": 0,
-                "typeHintID": "float"
+                "typeHintID": "float",
+                "reverse": true,
+                "simplify": false
             },
             {
                 "name": "Y",
@@ -36,7 +37,8 @@
                 "scriptParamAccess": "item",
                 "wireDisplay": "default",
                 "sourceCount": 0,
-                "typeHintID": "float"
+                "typeHintID": "float",
+                "simplify": true
             },
             {
                 "name": "Z",
@@ -48,7 +50,8 @@
                 "scriptParamAccess": "item",
                 "wireDisplay": "faint",
                 "sourceCount": 0,
-                "typeHintID": "float"
+                "typeHintID": "float",
+                "flatten": true
             }
         ],
         "outputParameters": [
@@ -57,7 +60,8 @@
                 "nickname": "result",
                 "description": "Result of the computation",
                 "optional": false,
-                "sourceCount": 0
+                "sourceCount": 0,
+                "graft": true
             }
         ]
     }