Left click to pick points

[p-j-smith]

Overview

Resolves #2193
Indirectly addresses: #1285 pyvista/pyvista-support#249

Hi, I've added the ability to pick points on a mesh by clicking the left mouse button.

Details

I've added an optional left_clicking keyword to enable_point_picking. If set to True, an observer is added to the interactor that will launch a pick event when the left button is clicked.

Because the pick event is not created using by pressing 'P', there is no red box around the picked point (I think the red box is generated by a KeyReleaseEvent associated with vtkRenderWindowInteractor on the C++ side, and cannot be disabled from Python).

I'm not sure this is the best way to go about adding this functionality, so I've not yet added tests. I've added a simple example to the end ofexamples/02_plot/point_picking.py.

[codecov]

Codecov Report

Merging #2266 (530f8a2) into main (c5b5330) will increase coverage by 0.07%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #2266      +/-   ##
==========================================
+ Coverage   93.40%   93.48%   +0.07%     
==========================================
  Files          75       74       -1     
  Lines       15615    15728     +113     
==========================================
+ Hits        14585    14703     +118     
+ Misses       1030     1025       -5     

[banesullivan]

Because the pick event is not created using by pressing 'P', there is no red box around the picked point (I think the red box is generated by a KeyReleaseEvent associated with vtkRenderWindowInteractor on the C++ side, and cannot be disabled from Python).

This is a fantastic side effect!

I'm liking the changes you have so far!

[akaszynski]

LGTM.

Note: for whatever reason LeftButtonPressEvent isn’t being triggered despite simulating it. I skipped coverage of the function that would be triggered by this event. Since we have coverage of the rest of this feature, I’m fine with approving this. We can consider looking into this later.

[akaszynski]

Merging as there has been no additional feedback and it's time for a release.

[p-j-smith]

Hi, thanks for the reviews and for merging! Sorry for not getting back to you - I was away for a couple of weeks

[akaszynski]

Hi, thanks for the reviews and for merging! Sorry for not getting back to you - I was away for a couple of weeks

No problem at all! Thanks for adding this feature.