pyvista.plotting.picking.PickingHelper.enable_geodesic_picking

PickingHelper.enable_geodesic_picking(

callback=None,

show_message=True,

font_size=18,

color='pink',

point_size=10,

line_width=5,

tolerance=0.025,

show_path=True,

keep_order=True,

**kwargs,

)

Enable picking at geodesic paths.

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

The geodesic path is saved to the .picked_geodesic attribute of this plotter.

Parameters:

callbackcallable(), optional

When given, calls this callable after a pick is made. The entire picked, geodesic 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.

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.

show_pathbool, default: True

Show the picked path interactively.

keep_orderbool, default: True

If True, the created geodesic path is a single ordered and cleaned line from the first point to the last.

Note

In older versions there were apparent discontinuities in the resulting path due to the behavior of the underlying VTK filter which corresponds to keep_order=False.

Added in version 0.32.0.

**kwargsdict, optional

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