Ruler

class ansys.tools.visualization_interface.backends.pyvista.widgets.ruler.Ruler(plotter: pyvista.Plotter, dark_mode: bool = False)

Bases: ansys.tools.visualization_interface.backends.pyvista.widgets.widget.PlotterWidget

Provides the ruler widget for the Visualization Interface Tool Plotter class.

Parameters:

plotterPlotter

Provides the plotter to add the ruler widget to.

dark_modebool, optional

Whether to activate the dark mode or not.

Overview

Methods

callback	Remove or add the ruler widget actor upon click.
update	Define the configuration and representation of the ruler widget button.

Import detail

from ansys.tools.visualization_interface.backends.pyvista.widgets.ruler import Ruler

Method detail

Ruler.callback(state: bool) → None

Remove or add the ruler widget actor upon click.

Parameters:

statebool

Whether the state of the button, which is inherited from PyVista, is True.

Notes

This method provides a callback function for the ruler widet. It is called every time the ruler widget is clicked.

Ruler.update() → None

Define the configuration and representation of the ruler widget button.