System

tissue_forge.system.print_performance_counters()
tissue_forge.system.context_has_current()
tissue_forge.system.context_make_current()
tissue_forge.system.context_release()
tissue_forge.system.camera_move_to(*args)

Overload 1:

Set the camera view parameters

Parameters:

  • eye (FVector3) – camera eye

  • center (FVector3) – view center

  • up (FVector3) – view upward direction

Return type:

int

Returns:

HRESULT


Overload 2:

Set the camera view parameters

Parameters:

  • center (FVector3) – target camera view center position

  • rotation (FQuaternion) – target camera rotation

  • zoom (float) – target camera zoom

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_view_bottom()

Move the camera to view the domain from the bottm

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_view_top()

Move the camera to view the domain from the top

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_view_left()

Move the camera to view the domain from the left

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_view_right()

Move the camera to view the domain from the right

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_view_back()

Move the camera to view the domain from the back

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_view_front()

Move the camera to view the domain from the front

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_reset()

Reset the camera

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_rotate_mouse(mousePos)
tissue_forge.system.camera_translate_mouse(mousePos)
tissue_forge.system.camera_translate_down()

Translate the camera down

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_translate_up()

Translate the camera up

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_translate_right()

Translate the camera right

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_translate_left()

Translate the camera left

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_translate_forward()

Translate the camera forward

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_translate_backward()

Translate the camera backward

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_rotate_down()

Rotate the camera down

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_rotate_up()

Rotate the camera up

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_rotate_left()

Rotate the camera left

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_rotate_right()

Rotate the camera right

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_roll_left()

Roll the camera left

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_roll_right()

Rotate the camera right

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_zoom_in()

Zoom the camera in

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_zoom_out()

Zoom the camera out

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_init_mouse(mousePos)
tissue_forge.system.camera_translate_by(trans)
tissue_forge.system.camera_zoom_by(delta)

Zoom the camera by an increment in distance.

Positive values zoom in.

Parameters:

delta (float) – zoom increment

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_zoom_to(distance)

Zoom the camera to a distance.

Parameters:

distance (float) – zoom distance

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_rotate_to_axis(axis, distance)

Rotate the camera to a point from the view center a distance along an axis.

Only rotates the view to the given eye position.

Parameters:

  • axis (FVector3) – axis from the view center

  • distance (float) – distance along the axis

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_rotate_to_euler_angle(angles)

Rotate the camera to a set of Euler angles.

Rotations are Z-Y-X.

Parameters:

angles (FVector3)

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_rotate_by_euler_angle(angles)

Rotate the camera by a set of Euler angles.

Rotations are Z-Y-X.

Parameters:

angles (FVector3)

Return type:

int

Returns:

HRESULT

tissue_forge.system.camera_center()

Get the current camera view center position

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.camera_rotation()

Get the current camera rotation

Return type:

FQuaternion

Returns:

FQuaternion

tissue_forge.system.camera_zoom()

Get the current camera zoom

Return type:

float

Returns:

float

tissue_forge.system.get_renderer()

Get the universe renderer

Return type:

TissueForge::rendering::UniverseRenderer

Returns:

struct rendering::UniverseRenderer*

tissue_forge.system.get_rendering_3d_bonds()

Get whether bonds are renderered with 3D objects

tissue_forge.system.set_rendering_3d_bonds(_flag)

Set whether bonds are renderered with 3D objects

tissue_forge.system.toggle_rendering_3d_bonds()

Toggle whether bonds are renderered with 3D objects

tissue_forge.system.get_rendering_3d_angles()

Get whether angles are renderered with 3D objects

tissue_forge.system.set_rendering_3d_angles(_flag)

Set whether angles are renderered with 3D objects

tissue_forge.system.toggle_rendering_3d_angles()

Toggle whether angles are renderered with 3D objects

tissue_forge.system.get_rendering_3d_dihedrals()

Get whether dihedrals are renderered with 3D objects

tissue_forge.system.set_rendering_3d_dihedrals(_flag)

Set whether dihedrals are renderered with 3D objects

tissue_forge.system.toggle_rendering_3d_dihedrals()

Toggle whether dihedrals are renderered with 3D objects

tissue_forge.system.set_rendering_3d_all(_flag)

Set whether bonds, angle and dihedrals are renderered with 3D objects

tissue_forge.system.toggle_rendering_3d_all()

Toggle whether bonds, angle and dihedrals are renderered with 3D objects

tissue_forge.system.get_ambient_color()

Get the ambient color

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_ambient_color(*args)

Overload 1:

Set the ambient color

Parameters:

color (FVector3)

Return type:

int

Returns:

HRESULT


Overload 2:

Set the ambient color of a subrenderer

Parameters:

  • color (FVector3)

  • srFlag (int)

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_diffuse_color()

Get the diffuse color

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_diffuse_color(*args)

Overload 1:

Set the diffuse color

Parameters:

color (FVector3)

Return type:

int

Returns:

HRESULT


Overload 2:

Set the diffuse color of a subrenderer

Parameters:

  • color (FVector3)

  • srFlag (int)

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_specular_color()

Get specular color

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_specular_color(*args)

Overload 1:

Set the specular color

Parameters:

color (FVector3)

Return type:

int

Returns:

HRESULT


Overload 2:

Set the specular color of a subrenderer

Parameters:

  • color (FVector3)

  • srFlag (int)

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_shininess()

Get the shininess

Return type:

float

Returns:

float

tissue_forge.system.set_shininess(*args)

Overload 1:

Set the shininess

Parameters:

shininess (float)

Return type:

int

Returns:

HRESULT


Overload 2:

Set the shininess of a subrenderer

Parameters:

  • shininess (float)

  • srFlag (int)

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_grid_color()

Get the grid color

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_grid_color(color)

Set the grid color

Parameters:

color (FVector3)

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_scene_box_color()

Get the scene box color

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_scene_box_color(color)

Set the scene box color

Parameters:

color (FVector3)

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_light_direction()

Get the light direction

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_light_direction(*args)

Overload 1:

Set the light direction

Parameters:

lightDir (FVector3)

Return type:

int

Returns:

HRESULT


Overload 2:

Set the light direction of a subrenderer

Parameters:

  • lightDir (FVector3)

  • srFlag (int)

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_light_color()

Get the light color

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_light_color(*args)

Overload 1:

Set the light color

Parameters:

color (FVector3)

Return type:

int

Returns:

HRESULT


Overload 2:

Set the light color of a subrenderer

Parameters:

  • color (FVector3)

  • srFlag (int)

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_background_color()

Get the background color

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_background_color(color)

Set the background color

Parameters:

color (FVector3)

Return type:

int

Returns:

HRESULT

tissue_forge.system.decorated()

Test whether the rendered scene is decorated

Return type:

boolean

Returns:

true

Return type:

boolean

Returns:

false

tissue_forge.system.decorate_scene(decorate)

Set flag to draw/not draw scene decorators (e.g., grid)

Parameters:

decorate (boolean) – flag; true says to decorate

Return type:

int

Returns:

HRESULT

tissue_forge.system.showing_discretization()

Test whether discretization is current shown

Return type:

boolean

Returns:

true

Return type:

boolean

Returns:

false

tissue_forge.system.show_discretization(show)

Set flag to draw/not draw discretization

Parameters:

show (boolean) – flag; true says to show

Return type:

int

Returns:

HRESULT

tissue_forge.system.get_discretizationColor()

Get the current color of the discretization grid

Return type:

FVector3

Returns:

FVector3

tissue_forge.system.set_discretizationColor(color)

Set the color of the discretization grid

Parameters:

color (FVector3)

Return type:

int

Returns:

HRESULT

tissue_forge.system.view_reshape(windowSize)
tissue_forge.system.performance_counters()
tissue_forge.system.egl_info()

Get EGL info

Return type:

string

Returns:

std::string

tissue_forge.system.image_data()
tissue_forge.system.is_terminal_interactive()

Test whether Tissue Forge is running in an interactive terminal

Return type:

boolean

Returns:

true if running in an interactive terminal

Return type:

boolean

Returns:

false

tissue_forge.system.is_jupyter_notebook()

Test whether Tissue Forge is running in a Jupyter notebook

Return type:

boolean

Returns:

true if running in a Jupyter notebook

Return type:

boolean

Returns:

false

tissue_forge.system.jwidget_init(args, kwargs)
tissue_forge.system.jwidget_run(args, kwargs)
tissue_forge.system.color_mapper_names()

Get all available color mapper names

tissue_forge.system.add_render_arrow(*args)

Overload 1:

Adds a vector visualization specification.

The passed pointer is borrowed. The client is responsible for maintaining the underlying data. The returned integer can be used to reference the arrow when doing subsequent operations with the renderer (e.g., removing an arrow from the scene).

Parameters:

arrow (ArrowData) – pointer to visualization specs

Return type:

int

Returns:

id of arrow according to the renderer


Overload 2:

Adds a vector visualization specification.

The passed pointer is borrowed. The client is responsible for maintaining the underlying data. The returned integer can be used to reference the arrow when doing subsequent operations with the renderer (e.g., removing an arrow from the scene).

Parameters:

  • position (FVector3) – position of vector

  • components (FVector3) – components of vector

  • style (Style) – style of vector

  • scale (float, optional) – scale of vector; defaults to 1.0

Return type:

std::pair< int,TissueForge::rendering::ArrowData * >

Returns:

id of arrow according to the renderer and arrow

tissue_forge.system.remove_render_arrow(arrowId)

Removes a vector visualization specification.

The removed pointer is only forgotten. The client is responsible for clearing the underlying data.

Parameters:

arrowId (int) – id of arrow according to the renderer

tissue_forge.system.get_render_arrow(arrowId)

Gets a vector visualization specification.

Parameters:

arrowId (int) – id of arrow according to the renderer

tissue_forge.system.cpu_info() → dict

Dictionary of CPU info

tissue_forge.system.compile_flags() → dict

Dictionary of CPU info

tissue_forge.system.gl_info() → dict

Dictionary of OpenGL info

tissue_forge.system.screenshot(filepath: str, decorate: bool | None = None, bgcolor=None)

Save a screenshot of the current scene

Parameters:

  • filepath (str) – path of file to save

  • decorate (bool) – flag to decorate the scene in the screenshot

  • bgcolor (FVector3 or [float, float, float] or (float, float, float) or float) – background color of the scene in the screenshot

Return type:

int

Returns:

HRESULT