pyvista.plotting.widgets.WidgetHelper#

class WidgetHelper(*args, **kwargs)[source]#

An internal class to manage widgets.

It also manages and other helper methods involving widgets.

Methods

WidgetHelper.add_affine_transform_widget(actor)

Add a 3D affine transform widget.

WidgetHelper.add_box_widget(callback[, ...])

Add a box widget to the scene.

WidgetHelper.add_camera_orientation_widget([...])

Add a camera orientation widget to the active renderer.

WidgetHelper.add_checkbox_button_widget(callback)

Add a checkbox button widget to the scene.

WidgetHelper.add_line_widget(callback[, ...])

Add a line widget to the scene.

WidgetHelper.add_logo_widget([logo, ...])

Add a logo widget to the top of the viewport.

WidgetHelper.add_measurement_widget([...])

Interactively measure distance with a distance widget.

WidgetHelper.add_mesh_clip_box(mesh[, ...])

Clip a mesh using a box widget.

WidgetHelper.add_mesh_clip_plane(mesh[, ...])

Clip a mesh using a plane widget.

WidgetHelper.add_mesh_isovalue(mesh[, ...])

Create a contour of a mesh with a slider.

WidgetHelper.add_mesh_slice(mesh[, normal, ...])

Slice a mesh using a plane widget.

WidgetHelper.add_mesh_slice_orthogonal(mesh)

Slice a mesh with three interactive planes.

WidgetHelper.add_mesh_slice_spline(mesh[, ...])

Slice a mesh with a spline widget.

WidgetHelper.add_mesh_threshold(mesh[, ...])

Apply a threshold on a mesh with a slider.

WidgetHelper.add_plane_widget(callback[, ...])

Add a plane widget to the scene.

WidgetHelper.add_slider_widget(callback, rng)

Add a slider bar widget.

WidgetHelper.add_sphere_widget(callback[, ...])

Add one or many sphere widgets to a scene.

WidgetHelper.add_spline_widget(callback[, ...])

Create and add a spline widget to the scene.

WidgetHelper.add_text_slider_widget(...[, ...])

Add a text slider bar widget.

WidgetHelper.add_volume_clip_plane(volume[, ...])

Clip a volume using a plane widget.

WidgetHelper.clear_box_widgets()

Remove all of the box widgets.

WidgetHelper.clear_button_widgets()

Remove all of the button widgets.

WidgetHelper.clear_camera_widgets()

Remove all of the camera widgets.

WidgetHelper.clear_line_widgets()

Remove all of the line widgets.

WidgetHelper.clear_logo_widgets()

Remove all of the logo widgets.

WidgetHelper.clear_measure_widgets()

Remove all of the measurement widgets.

WidgetHelper.clear_plane_widgets()

Remove all of the plane widgets.

WidgetHelper.clear_slider_widgets()

Remove all of the slider widgets.

WidgetHelper.clear_sphere_widgets()

Remove all of the sphere widgets.

WidgetHelper.clear_spline_widgets()

Remove all of the spline widgets.

WidgetHelper.close()

Close the widgets.