PlotterWidget

class ansys.tools.visualization_interface.backends.pyvista.widgets.widget.PlotterWidget(plotter: pyvista.Plotter)

Bases: abc.ABC

Provides an abstract class for plotter widgets.

Parameters:

plotterPlotter

Plotter instance to add the widget to.

Notes

These widgets are intended to be used with PyVista plotter objects. More specifically, the way in which this abstraction has been built ensures that these widgets can be easily integrated with the Visualization Interface Tool’s widgets.

Overview

Abstract methods

callback	General callback function for PlotterWidget objects.
update	General update function for PlotterWidget objects.

Properties

plotter

Plotter object that the widget is assigned to.

Import detail

from ansys.tools.visualization_interface.backends.pyvista.widgets.widget import PlotterWidget

Property detail

property PlotterWidget.plotter: pyvista.Plotter

Plotter object that the widget is assigned to.

Method detail

abstract PlotterWidget.callback(state) → None

General callback function for PlotterWidget objects.

abstract PlotterWidget.update() → None

General update function for PlotterWidget objects.