pyvista.Plotter.enable_rectangle_visible_picking

pyvista.Plotter.enable_rectangle_visible_picking#

Plotter.enable_rectangle_visible_picking(
callback=None,
show=True,
style='wireframe',
line_width=5,
color='pink',
show_message=True,
font_size=18,
start=False,
show_frustum=False,
**kwargs,
)[source]#

Enable rectangle based cell picking on visible surfaces.

Parameters:
callbackcallable(), optional

When input, calls this callable after a selection is made. The picked cells is the only passed argument.

showbool, default: True

Show the selection interactively.

stylestr, default: “wireframe”

Visualization style of the selection frustum. One of the following: style='surface', style='wireframe', or style='points'.

line_widthfloat, default: 5.0

Thickness of selected mesh edges.

colorColorLike, default: “pink”

The color of the selected frustum when shown.

show_messagebool | str, default: True

Show the message about how to use the cell picking tool. If this is a string, that will be the message shown.

font_sizeint, default: 18

Sets the font size of the message.

startbool, default: True

Automatically start the cell selection tool.

show_frustumbool, default: False

Show the frustum in the scene.

**kwargsdict, optional

All remaining keyword arguments are used to control how the selection frustum is interactively displayed.