Plane Widget

The plane widget can be enabled and disabled by the pyvista.WidgetHelper.add_plane_widget() and pyvista.WidgetHelper.clear_plane_widgets() methods respectively. As with all widgets, you must provide a custom callback method to utilize that plane. Considering that planes are most commonly used for clipping and slicing meshes, we have included two helper methods for doing those tasks!

Let’s use a plane to clip a mesh:

# sphinx_gallery_thumbnail_number = 2
import pyvista as pv
from pyvista import examples

vol = examples.download_brain()

p = pv.Plotter()
p.add_mesh_clip_plane(vol)
p.show()

Out:

[(578.7093647107201, 596.7093628033715, 578.7093628033715),
 (90.00000190734863, 108.0, 90.0),
 (0.0, 0.0, 1.0)]

After interacting with the scene, the clipped mesh is available as:

p.plane_clipped_meshes

Out:

[UnstructuredGrid (0x7f8c012272f0)
  N Cells:  3538080
  N Points: 3613484
  X Bounds: 9.000e+01, 1.800e+02
  Y Bounds: 0.000e+00, 2.160e+02
  Z Bounds: 0.000e+00, 1.800e+02
  N Arrays: 1
]

And here is a screen capture of a user interacting with this

Or you could slice a mesh using the plane widget:

p = pv.Plotter()
p.add_mesh_slice(vol)
p.show()

Out:

[(578.7093647107201, 596.7093628033715, 578.7093628033715),
 (90.00000190734863, 108.0, 90.0),
 (0.0, 0.0, 1.0)]

After interacting with the scene, the slice is available as:

p.plane_sliced_meshes

Out:

[PolyData (0x7f8c01227ec0)
  N Cells:  38880
  N Points: 39277
  X Bounds: 9.000e+01, 9.000e+01
  Y Bounds: 0.000e+00, 2.160e+02
  Z Bounds: 0.000e+00, 1.800e+02
  N Arrays: 1
]

And here is a screen capture of a user interacting with this

Or you could leverage the plane widget for some custom task like glyphing a vector field along that plane. Note that we have to pass a name when calling add_mesh to ensure that there is only one set of glyphs plotted at a time.

import pyvista as pv
from pyvista import examples

mesh = examples.download_carotid()

p = pv.Plotter()
p.add_mesh(mesh.contour(8).extract_largest(), opacity=0.5)

def my_plane_func(normal, origin):
    slc = mesh.slice(normal=normal, origin=origin)
    arrows = slc.glyph(orient='vectors', scale="scalars", factor=0.01)
    p.add_mesh(arrows, name='arrows')

p.add_plane_widget(my_plane_func)
p.show_grid()
p.add_axes()
p.show()

Out:

[(275.9751053451392, 242.47510534513918, 161.47510534513918),
 (137.5, 104.0, 23.0),
 (0.0, 0.0, 1.0)]

And here is a screen capture of a user interacting with this

Further, a user can disable the arrow vector by setting the normal_rotation argument to False. For example, here we programmatically set the normal vector on which we want to translate the plane and we disable the arrow to prevent its rotation.

p = pv.Plotter()
p.add_mesh_slice(vol, normal=(1,1,1), normal_rotation=False)
p.show()

Out:

[(555.4519839675984, 573.4519839675984, 555.4519839675984),
 (90.0, 108.0, 90.0),
 (0.0, 0.0, 1.0)]

The vector is also forcibly disabled anytime the assign_to_axis argument is set.

p = pv.Plotter()
p.add_mesh_slice(vol, assign_to_axis='z')
p.show()

Out:

[(578.7093628033715, 596.7093628033715, 578.7093647107201),
 (90.0, 108.0, 90.00000190734863),
 (0.0, 0.0, 1.0)]