pyvista.plotting.picking.PickingHelper.enable_path_picking

PickingHelper.enable_path_picking(

callback=None,

show_message=True,

font_size=18,

color='pink',

point_size=10,

line_width=5,

show_path=True,

tolerance=0.025,

**kwargs,

)

Enable picking at paths.

This is a convenience method for enable_point_picking to keep track of the picked points and create a line using those points.

The line is saved to the .picked_path attribute of this plotter

Parameters:

callbackcallable(), optional

When given, calls this callable after a pick is made. The entire picked path is passed as the only parameter to this callable.

show_messagebool | str, default: True

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

font_sizeint, default: 18

Sets the size of the message.

colorColorLike, default: “pink”

The color of the selected mesh when shown.

point_sizeint, default: 10

Size of picked points if show_path is True.

line_widthfloat, default: 5.0

Thickness of path representation if show_path is True.

show_pathbool, default: True

Show the picked path interactively.

tolerancefloat, default: 0.025

Specify tolerance for performing pick operation. Tolerance is specified as fraction of rendering window size. Rendering window size is measured across diagonal.

**kwargsdict, optional

All remaining keyword arguments are used to control how the picked path is interactively displayed.