enable_surface_picking

Plotter.enable_surface_picking(callback=None, show_message=True, font_size=18, color='pink', show_point=True, point_size=10, tolerance=0.025, pickable_window=False, left_clicking=False, **kwargs)

Enable picking of a point on the surface of a mesh.

Parameters

callbackfunction, optional

When input, calls this function after a selection is made. The mesh is input as the first parameter to this function.

show_messagebool or str, optional

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

font_sizeint, optional

Sets the font size of the message.

colorcolor_like, optional

The color of the selected mesh when shown.

show_pointbool, optional

Show the selection interactively. Default True.

point_sizeint, optional

Size of picked points if show_point is True. Default 10.

tolerancefloat, optional

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

pickable_windowbool, optional

When True, points in the 3D window are pickable. Default to False.

left_clickingbool, optional

When True, meshes can be picked by clicking the left mousebutton. Default to False.

Note

If enabled, left-clicking will not display the bounding box around the picked mesh.

**kwargsdict, optional

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

Returns

vtk.vtkPropPicker

Property picker.

Notes

Picked point can be accessed from picked_point attribute.

Examples

Add a cube to a plot and enable cell picking. Enable left_clicking to immediately start picking on the left click and disable showing the box. You can still press the p key to select meshes.

>>> import pyvista as pv
>>> cube = pv.Cube()
>>> pl = pv.Plotter()
>>> _ = pl.add_mesh(cube)
>>> _ = pl.enable_surface_picking(left_clicking=True)

See Picking a Point on the Surface of a Mesh for a full example using this method.