vtkmodules.util.widgets#

Pythonic API for VTK widgets.

Reduces boilerplate by auto-creating representations, forwarding attribute access to the representation, and providing decorator-style event callbacks::

from vtkmodules.vtkInteractionWidgets import vtkImplicitPlaneWidget2

widget = vtkImplicitPlaneWidget2(iren, bounds=actor.GetBounds(), normal=(0, 0, 1))

@widget.on_interaction
def update():
    widget.GetPlane(plane)

widget.on()

Module Contents#

Classes#

_WidgetMixin

Shared functionality for all pythonic widget overrides.

_BoxWidget2Mixin

_SphereWidget2Mixin

_ImplicitPlaneWidget2Mixin

_LineWidget2Mixin

_SplineWidget2Mixin

_SliderWidgetMixin

_ImplicitCylinderWidgetMixin

_ImplicitConeWidgetMixin

_ImplicitAnnulusWidgetMixin

_CoordinateFrameWidgetMixin

BoxWidget2

SphereWidget2

ImplicitPlaneWidget2

LineWidget2

SplineWidget2

SliderWidget

ImplicitCylinderWidget

ImplicitConeWidget

ImplicitAnnulusWidget

CoordinateFrameWidget

Functions#

_fmt3

API#

vtkmodules.util.widgets._fmt3(vals)#
class vtkmodules.util.widgets._WidgetMixin#

Shared functionality for all pythonic widget overrides.

__getattr__(name)#
_add_observer(event, callback)#
_clear_observers(event)#
on_interaction(callback)#

Decorator: call callback() on every InteractionEvent.

on_end_interaction(callback)#

Decorator: call callback() on EndInteractionEvent.

clear_on_interaction()#

Remove all callbacks registered via on_interaction().

clear_on_end_interaction()#

Remove all callbacks registered via on_end_interaction().

__del__()#
on()#

Enable the widget. Returns self for chaining.

off()#

Disable the widget. Returns self for chaining.

__enter__()#
__exit__(*exc)#
__repr__()#
class vtkmodules.util.widgets._BoxWidget2Mixin(*args, interactor=None, bounds=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._SphereWidget2Mixin(*args, interactor=None, bounds=None, center=None, radius=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._ImplicitPlaneWidget2Mixin(*args, interactor=None, bounds=None, origin=None, normal=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._LineWidget2Mixin(*args, interactor=None, bounds=None, point1=None, point2=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._SplineWidget2Mixin(*args, interactor=None, bounds=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._SliderWidgetMixin(*args, interactor=None, value=None, min_value=None, max_value=None, title=None, point1=None, point2=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._ImplicitCylinderWidgetMixin(*args, interactor=None, bounds=None, center=None, axis=None, radius=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._ImplicitConeWidgetMixin(*args, interactor=None, bounds=None, origin=None, axis=None, angle=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._ImplicitAnnulusWidgetMixin(*args, interactor=None, bounds=None, center=None, axis=None, inner_radius=None, outer_radius=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets._CoordinateFrameWidgetMixin(*args, interactor=None, bounds=None, origin=None)#

Bases: vtkmodules.util.widgets._WidgetMixin

__repr__()#
class vtkmodules.util.widgets.BoxWidget2(*args, interactor=None, bounds=None)#

Bases: vtkmodules.util.widgets._BoxWidget2Mixin, vtkmodules.vtkInteractionWidgets.vtkBoxWidget2

class vtkmodules.util.widgets.SphereWidget2(*args, interactor=None, bounds=None, center=None, radius=None)#

Bases: vtkmodules.util.widgets._SphereWidget2Mixin, vtkmodules.vtkInteractionWidgets.vtkSphereWidget2

class vtkmodules.util.widgets.ImplicitPlaneWidget2(*args, interactor=None, bounds=None, origin=None, normal=None)#

Bases: vtkmodules.util.widgets._ImplicitPlaneWidget2Mixin, vtkmodules.vtkInteractionWidgets.vtkImplicitPlaneWidget2

class vtkmodules.util.widgets.LineWidget2(*args, interactor=None, bounds=None, point1=None, point2=None)#

Bases: vtkmodules.util.widgets._LineWidget2Mixin, vtkmodules.vtkInteractionWidgets.vtkLineWidget2

class vtkmodules.util.widgets.SplineWidget2(*args, interactor=None, bounds=None)#

Bases: vtkmodules.util.widgets._SplineWidget2Mixin, vtkmodules.vtkInteractionWidgets.vtkSplineWidget2

class vtkmodules.util.widgets.SliderWidget(*args, interactor=None, value=None, min_value=None, max_value=None, title=None, point1=None, point2=None)#

Bases: vtkmodules.util.widgets._SliderWidgetMixin, vtkmodules.vtkInteractionWidgets.vtkSliderWidget

class vtkmodules.util.widgets.ImplicitCylinderWidget(*args, interactor=None, bounds=None, center=None, axis=None, radius=None)#

Bases: vtkmodules.util.widgets._ImplicitCylinderWidgetMixin, vtkmodules.vtkInteractionWidgets.vtkImplicitCylinderWidget

class vtkmodules.util.widgets.ImplicitConeWidget(*args, interactor=None, bounds=None, origin=None, axis=None, angle=None)#

Bases: vtkmodules.util.widgets._ImplicitConeWidgetMixin, vtkmodules.vtkInteractionWidgets.vtkImplicitConeWidget

class vtkmodules.util.widgets.ImplicitAnnulusWidget(*args, interactor=None, bounds=None, center=None, axis=None, inner_radius=None, outer_radius=None)#

Bases: vtkmodules.util.widgets._ImplicitAnnulusWidgetMixin, vtkmodules.vtkInteractionWidgets.vtkImplicitAnnulusWidget

class vtkmodules.util.widgets.CoordinateFrameWidget(*args, interactor=None, bounds=None, origin=None)#

Bases: vtkmodules.util.widgets._CoordinateFrameWidgetMixin, vtkmodules.vtkInteractionWidgets.vtkCoordinateFrameWidget