Geometry widget¶

Geometry widget is a CoSApp Lab widget allowing users to visualize Opencascade shape objects inside CoSApp system. Users can use geometry widget in notebook as a JupyterLab widget or use it in SysExplorer.

Start geometry widget¶

To open GeometryWidget inside SysExplorer, just select Geometry widget in widget menu of any section.

To use GeometryWidget as a JupyterLab widget, users can be import it from cosapp_lab.widgets, the required input parameter is an instance of CoSApp system.

By default, GeometryWidget will be opened on a side panel of JupyterLab interface, to modify position of widget, user can user anchor keyword as SysExplorer widget.

from cosapp_lab.widgets import GeometryWidget
demo = AnyCosappSystem("demo")
a = GeometryWidget(demo, anchor = "tab-after")

Default method to extract OCC shape from system: GeometryWidget will search for all ports named GeometryPort inside the CoSApp system to get shapes, this port need to contain 2 variable visible and shape. A typical implementation of GeometryPort is:

from cosapp.ports import Port
class GeometryPort(Port):
   def setup(self):
      self.add_variable("visible", True, desc="Should this geometry be shown?")
      self.add_variable("shape", None, desc="Geometrical object")

The shape variable of GeometryPort can be a OCC shape, list of OCC shape or a dict with following format:

{
  "shape" : Union[TopoDS_Shape, List[TopoDS_Shape]], # shapes to be drawn in viewer
  "color" : Optional[str] # Color of shapes, default value is 0x156289
  "transparent" : Optional[bool] # Transparent of shapes, default is False
  "edge" : Optional[bool] # Show or hide edge shape, default is False
  "misc_data" : Optional[{
                  "points": Optional[List[{"position": Iterable[float],
                                          "color": Optional[Union[str,int]], # default value is yellow
                                          "radius": Optional[float] # default value is 0.1
                                          }]],
                  "vectors": Optional[List[{"position": Iterable[float],
                                            "direction": Iterable[float]
                                            "color": Optional[Union[str,int]], # default value is 0x3900f2
                                          }]],
                }] # data to draw point and vector in the viewer
}

Points and vectors can be drawn in GeometryViewer by defining the related data in misc_data key of GeometryPort.shape.

In this default mode, GeometryWidget will save the geometry of system in each time step, so user does not need to specify a recorder to store the geometry. In order to capture all data, GeometryWidget need to be started before running drivers.

User defined method to extract OCC shape from system: If CoSApp system does not use GeometryPort, user needs to defined a method to extract shape from system by passing a function reference to add_shape parameter of GeometryWidget constructor. The custom add shape function needs to satisfy 2 requirements:

It takes 2 input parameters, first parameter is a list of shape data r (TopoDS_Shape, list of TopoDS_Shape or a dictionary), second one is a CoSApp system inp_system.
It will call itself recursively over all children of inp_system, at each call, it will append all shape data into the input list r

A typical implementation of this function is like this:

from cosapp_lab.widgets import GeometryWidget
demo = AnyCosappSystem("demo")

def custom_add_shapes(r : List[Any], inp_system: System):
   for child in inp_system.children.values():
      custom_add_shapes(r, child)

   for port in filter(lambda s: isinstance(s, CustomGeometryPort), inp_system.outputs.values()):
      [r.append(shape) for shape in port.custom_port_variable]

a = GeometryWidget(demo, add_shape = custom_add_shapes)

In this mode GeometryWidget still need to be started before running any driver.

Get shape data from recorder: if shape data is already stored in a recorder, user can specify source parameter of GeometryWidget constructor in order to get shape from recorder instead of system variable. In this mode, GeometryWidget can be started after running drivers. The format of data for source parameter is following:

from cosapp_lab.widgets import GeometryWidget
demo = AnyCosappSystem("demo")
a = GeometryWidget(demo, source = {"recorder": "solver", "variables": ["mass.dyn.geom.shape","arm.dyn.geom.shape"]})

Here recorder key is path to the solver which holds the recorder, this path is defined by concatenating contextual name of system with driver name, for example: system_1.system_2…system_n.driver_name. The variables key is the column of recorder which holds shape data.

To open GeometryWidget inside SysExplorer, just select Geometry widget in widget menu of any section, to use a customized add_shape function or using recorder data with SysExplorer, user can use the same method as GeometryWidget

Geometry widget main interface¶

GeometryViewer contains a large viewer window and a toolbar at the bottom of widget.

Geometry widget¶

Start geometry widget¶

Geometry widget main interface¶

Table of Contents

Previous topic

Next topic

Geometry widget¶

Start geometry widget¶

Geometry widget main interface¶

Toolbar¶