Renderable

class ansys.pyensight.core.renderable.Renderable(session: Session, cell_handle: Any | None = None, width: int | None = None, height: int | None = None, temporal: bool = False, aa: int = 1, fps: float = 30.0, num_frames: int | None = None)

Generates HTML pages for renderable entities.

This class provides the underlying HTML remote webpage generation for the show method. The approach is to generate the renderable in the EnSight session and make the artifacts available via the websocket server. The artifacts are then wrapped with simple HTML pages, which are also served up by the websocket server. These HTML pages can then be used to populate iframes.

Parameters:

session

PyEnSight session to generate renderables for.

cell_handle

Jupyter notebook cell handle (if any). The default is None.

widthint, optional

Width of the renderable. The default is None.

heightint, optional

Height of the renderable. The default is None.

temporalbool, optional

Whether to show data for all timesteps in an interactive WebGL-based browser viewer. The default is False.

aaint, optional

Number of antialiasing passes to use when rendering images. The default is 1.

fpsfloat, optional

Number of frames per second to use for animation playback. The default is 30.0.

num_framesint, optional

Number of frames of static timestep to record for animation playback. The default is None.

Methods

Renderable.browser()	Open a web browser page to display the renderable content.
Renderable.delete()	Delete all server resources for the renderable.
Renderable.download(dirname)	Download the content files for the renderable.
Renderable.update()	Update the visualization and display it.

Attributes

Renderable.url

URL to the renderable content.