`AbstractPicker`#

class ansys.tools.visualization_interface.backends.pyvista.picker.AbstractPicker(plotter_backend: ansys.tools.visualization_interface.backends.pyvista.pyvista.Plotter, **kwargs)#

Bases: abc.ABC

Abstract base class for pickers.

Overview#

Abstract methods

`pick_select_object`	Determine actions to take when an object is selected.
`pick_unselect_object`	Determine actions to take when an object is unselected.
`hover_select_object`	Determine actions to take when an object is hovered over.
`hover_unselect_object`	Determine actions to take when an object is unhovered.

Properties

Return the dictionary of picked objects.

Import detail#

from ansys.tools.visualization_interface.backends.pyvista.picker import AbstractPicker

Property detail#

property AbstractPicker.picked_dict: dict#

Abstractmethod:

Return the dictionary of picked objects.

Method detail#

abstractmethod AbstractPicker.pick_select_object(custom_object: ansys.tools.visualization_interface.types.mesh_object_plot.MeshObjectPlot | ansys.tools.visualization_interface.types.edge_plot.EdgePlot, pt: numpy.ndarray) → None#: Determine actions to take when an object is selected.

abstractmethod AbstractPicker.pick_unselect_object(custom_object: ansys.tools.visualization_interface.types.mesh_object_plot.MeshObjectPlot | ansys.tools.visualization_interface.types.edge_plot.EdgePlot) → None#: Determine actions to take when an object is unselected.

abstractmethod AbstractPicker.hover_select_object(custom_object: ansys.tools.visualization_interface.types.mesh_object_plot.MeshObjectPlot | ansys.tools.visualization_interface.types.edge_plot.EdgePlot, pt: numpy.ndarray) → None#: Determine actions to take when an object is hovered over.

abstractmethod AbstractPicker.hover_unselect_object(custom_object: ansys.tools.visualization_interface.types.mesh_object_plot.MeshObjectPlot | ansys.tools.visualization_interface.types.edge_plot.EdgePlot) → None#: Determine actions to take when an object is unhovered.