create_connection#
- Omniverse.create_connection(omniverse_path: str, include_camera: bool = False, normalize_geometry: bool = False, live: bool = True, debug_filename: str = '') None#
Ensure that an EnSight dsg -> omniverse server is running
Connect the current EnSight session to an Omniverse server. This is done by launching a new service that makes a dynamic scene graph connection to the EnSight session and pushes updates to the Omniverse server. The initial EnSight scene will be pushed after the connection is established.
- Parameters:
- omniverse_path
str The URI to the Omniverse server. It will look like this: “omniverse://localhost/Users/test”
- include_camerabool
If True, apply the EnSight camera to the Omniverse scene. This option should be used if the target viewer is in AR/VR mode. Defaults to False.
- normalize_geometrybool
Omniverse units are in meters. If the source dataset is not in the correct unit system or is just too large/small, this option will remap the geometry to a unit cube. Defaults to False.
- livebool
If True, one can call ‘update()’ to send updated geometry to Omniverse. If False, the Omniverse connection will push a single update and then disconnect. Defaults to True.
- debug_filename
str If the name of a file is provided, it will be used to save logging information on the connection between EnSight and Omniverse.
- omniverse_path