propagate element geometry (#1570)

Author: arun3688

src/OMSimulatorPython/capi.py

@@ -25,6 +25,19 @@ class ssd_connector_geometry_t(ctypes.Structure):
     ("x", ctypes.c_double),
     ("y", ctypes.c_double)
   ]
+## C structure for element geometry to properly pass the data from Python to C API
+class ssd_element_geometry_t(ctypes.Structure):
+  _fields_ = [
+    ("x1", ctypes.c_double),
+    ("y1", ctypes.c_double),
+    ("x2", ctypes.c_double),
+    ("y2", ctypes.c_double),
+    ("rotation", ctypes.c_double),
+    ("iconSource", ctypes.c_char_p),
+    ("iconRotation", ctypes.c_double),
+    ("iconFlip", ctypes.c_bool),
+    ("iconFixedAspectRatio", ctypes.c_bool),
+  ]
 class capi:
   def __init__(self):
     dirname = os.path.dirname(__file__)
@@ -92,6 +105,8 @@ def __init__(self):
     self.obj.oms_setConnectionGeometry.restype = ctypes.c_int
     self.obj.oms_setConnectorGeometry.argtypes = [ctypes.c_char_p, ctypes.POINTER(ssd_connector_geometry_t)]
     self.obj.oms_setConnectorGeometry.restype = ctypes.c_int
+    self.obj.oms_setElementGeometry.argtypes = [ctypes.c_char_p, ctypes.POINTER(ssd_element_geometry_t)]
+    self.obj.oms_setElementGeometry.restype = ctypes.c_int
     self.obj.oms_setTempDirectory.argtypes = [ctypes.c_char_p]
     self.obj.oms_setTempDirectory.restype = ctypes.c_int
     self.obj.oms_setExportName.argtypes = [ctypes.c_char_p, ctypes.c_char_p]
@@ -244,6 +259,13 @@ def setConnectorGeometry(self, cref, x, y):
     status = self.obj.oms_setConnectorGeometry(cref.encode(), ctypes.byref(geometry))
     return Status(status)
 
+  def setElementGeometry(self, cref, x1, y1, x2, y2, rotation=0.0, iconSource=b"", iconRotation=0.0, iconFlip=False, iconFixedAspectRatio=False):
+    '''Set the element geometry for a model or system.
+    The element geometry is defined by a bounding box (x1, y1, x2, y2) that defines the position and size of the element in the diagram, as well as optional rotation and icon information.'''
+    geometry = ssd_element_geometry_t(x1, y1, x2, y2, rotation, iconSource, iconRotation, iconFlip, iconFixedAspectRatio)
+    status = self.obj.oms_setElementGeometry(cref.encode(), ctypes.byref(geometry))
+    return Status(status)
+
   def setTempDirectory(self, newTempDir):
     status = self.obj.oms_setTempDirectory(newTempDir.encode())
     return Status(status)

src/OMSimulatorPython/instantiated_model.py

@@ -134,6 +134,23 @@ def __init__(self, json_description, system: System, resources: dict):
                 raise RuntimeError(f"Failed to set connector geometry for {connector_path}: {status}")
               self.apiCall.append(f'oms_setConnectorGeometry("{connector_path}", {x}, {y})')
 
+        ## parse element geometry for the component if exist and set it to capi after adding the component, this is needed for proper mapping of element geometry
+        if "element geometry" in comp:
+          geometry = comp["element geometry"]
+          x1 = geometry.get("x1", 0.0)
+          y1 = geometry.get("y1", 0.0)
+          x2 = geometry.get("x2", 0.0)
+          y2 = geometry.get("y2", 0.0)
+          rotation = geometry.get("rotation")
+          iconSource = geometry.get("iconSource", b"")
+          iconRotation = geometry.get("iconRotation", 0.0)
+          iconFlip = geometry.get("iconFlip", False)
+          iconFixedAspectRatio = geometry.get("iconFixedAspectRatio", False)
+          status = Capi.setElementGeometry(comp_path, x1, y1, x2, y2, rotation, iconSource, iconRotation, iconFlip, iconFixedAspectRatio)
+          if status != Status.ok:
+            raise RuntimeError(f"Failed to set element geometry for {comp_path}: {status}")
+          self.apiCall.append(f'oms_setElementGeometry("{comp_path}", {x1}, {y1}, {x2}, {y2}, {rotation}, "{iconSource}", {iconRotation}, {iconFlip}, {iconFixedAspectRatio})')
+
         if not export_name in self.mappedCrefs:
           self.mappedCrefs[export_name] = comp_path
           self.mappedCrefs[".".join(comp["name"][:-1])] = solver_path # map parent system too for connector lookup

src/OMSimulatorPython/system.py

@@ -664,6 +664,21 @@ def processElements(self, elements_dict: dict, connections: list, data: dict, so
             "path": str(Path(tempdir, str(element.fmuPath))) if tempdir is not None else str(element.fmuPath),
             "connectors": connector_info
         })
+        ## add element geometry if available, this is needed for propagating element geometry to capi
+        if element.elementgeometry:
+          element_geometry = {
+              "x1": element.elementgeometry.x1,
+              "y1": element.elementgeometry.y1,
+              "x2": element.elementgeometry.x2,
+              "y2": element.elementgeometry.y2,
+              "rotation": element.elementgeometry.rotation,
+              "iconSource": element.elementgeometry.icon_source,
+              "iconRotation": element.elementgeometry.icon_rotation,
+              "iconFlip": element.elementgeometry.icon_flip,
+              "iconFixedAspectRatio": element.elementgeometry.icon_fixed_aspect_ratio
+          }
+          solver_groups[element.solver][-1]["element geometry"] = element_geometry
+
         componentSolver[str(element.name)] = element.solver
       elif isinstance(element, ComponentTable):
         solver_groups[element.solver].append({