PlotterWidget#

class ansys.geometry.core.plotting.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 are easily integrable with PyAnsys Geometry’s own Plotter class.

Overview#

callback

General callback function for PlotterWidget objects.

update

General update function for PlotterWidget objects.

plotter

Plotter object the widget is assigned to.

Import detail#

from ansys.geometry.core.plotting.widgets.widget import PlotterWidget

Property detail#

property PlotterWidget.plotter: pyvista.Plotter#

Plotter object 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.