Omniverse

class ansys.pyensight.core.utils.omniverse.Omniverse(interface: ensight_api.ensight | ensight)

Provides the ensight.utils.omniverse interface.

The omniverse class methods provide an interface between an EnSight session and an Omniverse instance. See PyEnSight/ANSYS Omniverse Interface for additional details.

Parameters:

interface: Union[“ensight_api.ensight”, “ensight”]

Entity that provides the ensight namespace. In the case of EnSight Python, the ensight module is passed. In the case of PyEnSight, Session.ensight is passed.

Notes

This interface is only available when using pyensight (they do not work with the ensight Python interpreter) and the module must be used in an interpreter that includes the Omniverse Python modules (e.g. omni and pxr). Only a single Omniverse connection can be established within a single pyensight session.

Examples

>>> from ansys.pyensight.core import LocalLauncher
>>> session = LocalLauncher().start()
>>> ov = session.ensight.utils.omniverse
>>> ov.create_connection(r"D:\Omniverse\Example")
>>> ov.update()
>>> ov.close_connection()

Methods

Omniverse.close_connection()	Shut down the open EnSight dsg -> omniverse server
Omniverse.create_connection(omniverse_path)	Ensure that an EnSight dsg -> omniverse server is running
Omniverse.is_running_omniverse()	Check that an Omniverse connection is active
Omniverse.read_status_file()	Read the status file and return its contents as a dictionary.
Omniverse.update([temporal, line_width])	Update the geometry in Omniverse