MeasureWidget

class ansys.tools.visualization_interface.backends.pyvista.widgets.measure.MeasureWidget(plotter_helper: ansys.tools.visualization_interface.backends.pyvista.pyvista.Plotter)

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

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

Parameters:

plotter_helperPlotterHelper

Plotter to add the measure widget to.

Overview

Methods

callback	Remove or add the measurement widget actor upon click.
update	Define the measurement widget button parameters.

Attributes

plotter_helper

Import detail

from ansys.tools.visualization_interface.backends.pyvista.widgets.measure import MeasureWidget

Attribute detail

MeasureWidget.plotter_helper

Method detail

MeasureWidget.callback(state: bool) → None

Remove or add the measurement widget actor upon click.

Parameters:

statebool

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

MeasureWidget.update() → None

Define the measurement widget button parameters.