HideButton

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

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

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

Parameters:

plotter_helperPlotterHelper

Plotter to add the hide widget to.

dark_modebool, optional

Whether to activate the dark mode or not.

Overview

Methods

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

Import detail

from ansys.tools.visualization_interface.backends.pyvista.widgets.hide_buttons import HideButton

Method detail

HideButton.callback(state: bool) → None

Remove or add the hide widget actor upon click.

Parameters:

statebool

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

HideButton.update() → None

Define the hide widget button parameters.