Plotter.add_spline_widget

Plotter.add_spline_widget(

callback: Callable[..., object] | None,

*,

bounds: VectorLike[float] | None = None,

factor: float = 1.25,

n_handles: int = 5,

resolution: int = 25,

color: ColorLike | None = 'yellow',

show_ribbon: bool = False,

ribbon_color: ColorLike | None = 'pink',

ribbon_opacity: float = 0.5,

pass_widget: bool = False,

closed: bool = False,

initial_points: MatrixLike[float] | None = None,

interaction_event: InteractionEventType = 'end',

) → _vtk.vtkSplineWidget

Create and add a spline widget to the scene.

Use the bounds argument to place this widget. Several “handles” are used to control a parametric function for building this spline. Click directly on the line to translate the widget.

Parameters:

callbackcallable()

The method called every time the spline is updated. This passes a pyvista.PolyData object to the callback function of the generated spline.

boundssequence[float], optional

Length 6 sequence of the bounding box where the widget is placed.

factorfloat, optional

An inflation factor to expand on the bounds when placing.

n_handlesint, optional

The number of interactive spheres to control the spline’s parametric function.

resolutionint, optional

The number of points in the spline created between all the handles.

colorColorLike, optional

Either a string, RGB sequence, or hex color string.

show_ribbonbool, optional

If True, the poly plane used for slicing will also be shown.

ribbon_colorColorLike, optional

Color of the ribbon. Either a string, RGB sequence, or hex color string.

ribbon_opacityfloat, optional

Opacity of ribbon. Defaults to 1.0 and must be between [0, 1].

pass_widgetbool, optional

If True, the widget will be passed as the last argument of the callback.

closedbool, optional

Make the spline a closed loop.

initial_pointssequence, optional

The points to initialize the widget placement. Must have same number of elements as n_handles. If the first and last point are the same, this will be a closed loop spline.

interaction_eventInteractionEventType, optional

The VTK interaction event to use for triggering the callback. Accepts either the strings 'start', 'end', 'always' or a vtkCommand.EventIds.

Returns:

vtkSplineWidget

The newly created spline widget.

Notes

This widget has trouble displaying certain colors. Use only simple colors (white, black, yellow).

See Also

Spline Widget