Homogenizing geometry API

[germa89]

Attemp to homogenise the geometry API. At the moment, different methods keypoints, lines, areas, etc return different objects.

With this PR, all methods should return a pyvista.MultiBlock object which can be easily plotted, or even iterate to. This establishes a deeper connection with the pyvista package.

Discussion in here: #2125 (comment)

[germa89]

@Gryfenfer97 can you have a look at the typing part? i am no expert so I would appreciate a lot your comments .

[codecov]

Codecov Report

Merging #2125 (32c5b00) into main (997e288) will increase coverage by 6.49%.
The diff coverage is 95.55%.

@@            Coverage Diff             @@
##             main    #2125      +/-   ##
==========================================
+ Coverage   80.82%   87.32%   +6.49%     
==========================================
  Files          44       45       +1     
  Lines        7489     8203     +714     
==========================================
+ Hits         6053     7163    +1110     
+ Misses       1436     1040     -396     

[AlejandroFernandezLuces]

Regarding PyVista, you can use PointSet for points, PolyData for lines and UnstructuredGrid for any other geometry. I see that you need to separate PolyData and UnstructuredGrid because of previous issues, so no discussion there.

My only commet is regarding the PointSet. If you look at the docs:

This class is useful for improving the performance of filters on point clouds, but not plotting.

If you don't really need to use if for that reason, you could also use PolyData for points, to increase compatibility among returned objects. This is not a big deal anyway, so up to you 🙂

[germa89]

Regarding PyVista, you can use PointSet for points, PolyData for lines and UnstructuredGrid for any other geometry. I see that you need to separate PolyData and UnstructuredGrid because of previous issues, so no discussion there.

My only commet is regarding the PointSet. If you look at the docs:

This class is useful for improving the performance of filters on point clouds, but not plotting.

If you don't really need to use if for that reason, you could also use PolyData for points, to increase compatibility among returned objects. This is not a big deal anyway, so up to you 🙂

I dont think we do much filtering with keypoints but we do a lot of plotting. So I guess choosing pv.PolyData is good and consistent with the homogenisation perspective.

Thank you for your feedback!

[germa89]

@clatapie