- Plotter.add_box_widget(callback, bounds=None, factor=1.25, rotation_enabled=True, color=None, use_planes=False, outline_translation=True, pass_widget=False)¶
Add a box widget to the scene.
This is useless without a callback function. You can pass a callable function that takes a single argument, the PolyData box output from this widget, and performs a task with that box.
The method called every time the box is updated. This has two options: Take a single argument, the
PolyDatabox (default) or if
use_planes=True, then it takes a single argument of the plane collection as a
Length 6 tuple of the bounding box where the widget is placed.
An inflation factor to expand on the bounds when placing.
False, the box widget cannot be rotated and is strictly orthogonal to the cartesian axes.
Either a string, rgb sequence, or hex color string. Defaults to
Changes the arguments passed to the callback to the planes that make up the box.
False, the box widget cannot be translated and is strictly placed at the given bounds.
True, the widget will be passed as the last argument of the callback.