ScreenshotButton#

class ansys.tools.visualization_interface.backends.pyvista.widgets.screenshot.ScreenshotButton(plotter: pyvista.Plotter)#

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

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

Parameters:
plotterPlotter

Provides the plotter to add the screenshot widget to.

Overview#

callback

Remove or add the screenshot widget actor upon click.

update

Define the configuration and representation of the screenshot widget button.

Import detail#

from ansys.tools.visualization_interface.backends.pyvista.widgets.screenshot import ScreenshotButton

Method detail#

ScreenshotButton.callback(state: bool) None#

Remove or add the screenshot 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 screenshot widget. It is called every time the screenshot widget is clicked.

ScreenshotButton.update() None#

Define the configuration and representation of the screenshot widget button.