Public Member Functions |
| vtkBoxWidget2 (IntPtr rawCppThis, bool callDisposalMethod, bool strong) |
| Automatically generated constructor - called from generated code. DO NOT call directly.
|
| vtkBoxWidget2 () |
| Instantiate the object.
|
override void | CreateDefaultRepresentation () |
| Create the default widget representation if one is not set. By default, this is an instance of the vtkBoxRepresentation class.
|
virtual int | GetMoveFacesEnabled () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual int | GetRotationEnabled () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual int | GetScalingEnabled () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual int | GetTranslationEnabled () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
override int | IsA (string type) |
| Standard class methods for type information and printing.
|
virtual void | MoveFacesEnabledOff () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | MoveFacesEnabledOn () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
new vtkBoxWidget2 | NewInstance () |
| Standard class methods for type information and printing.
|
virtual void | RotationEnabledOff () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | RotationEnabledOn () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | ScalingEnabledOff () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | ScalingEnabledOn () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | SetMoveFacesEnabled (int _arg) |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
void | SetRepresentation (vtkBoxRepresentation r) |
| Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.
|
virtual void | SetRotationEnabled (int _arg) |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | SetScalingEnabled (int _arg) |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | SetTranslationEnabled (int _arg) |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | TranslationEnabledOff () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
virtual void | TranslationEnabledOn () |
| Control the behavior of the widget (i.e., how it processes events). Translation, rotation, scaling and face movement can all be enabled and disabled. Scaling refers to scaling of the whole widget at once, (default is through right mouse button) while face movement refers to scaling of the widget one face (axis) at a time (default through grabbing one of the representation spherical handles).
|
Static Public Member Functions |
static new vtkBoxWidget2 | New () |
| Instantiate the object.
|
static new int | IsTypeOf (string type) |
| Standard class methods for type information and printing.
|
static new vtkBoxWidget2 | SafeDownCast (vtkObjectBase o) |
| Standard class methods for type information and printing.
|
Public Attributes |
new const string | MRFullTypeName = "Kitware.VTK.vtkBoxWidget2" |
| Automatically generated type registration mechanics.
|
Static Public Attributes |
static new readonly string | MRClassNameKey = "13vtkBoxWidget2" |
| Automatically generated type registration mechanics.
|
Protected Member Functions |
override void | Dispose (bool disposing) |
| Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.
|
Private Member Functions |
static internal IntPtr | vtkBoxWidget2_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkBoxWidget2_CreateDefaultRepresentation_01 (HandleRef pThis) |
static internal int | vtkBoxWidget2_GetMoveFacesEnabled_02 (HandleRef pThis) |
static internal int | vtkBoxWidget2_GetRotationEnabled_03 (HandleRef pThis) |
static internal int | vtkBoxWidget2_GetScalingEnabled_04 (HandleRef pThis) |
static internal int | vtkBoxWidget2_GetTranslationEnabled_05 (HandleRef pThis) |
static internal int | vtkBoxWidget2_IsA_06 (HandleRef pThis, string type) |
static internal int | vtkBoxWidget2_IsTypeOf_07 (string type) |
static internal void | vtkBoxWidget2_MoveFacesEnabledOff_08 (HandleRef pThis) |
static internal void | vtkBoxWidget2_MoveFacesEnabledOn_09 (HandleRef pThis) |
static internal IntPtr | vtkBoxWidget2_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkBoxWidget2_RotationEnabledOff_12 (HandleRef pThis) |
static internal void | vtkBoxWidget2_RotationEnabledOn_13 (HandleRef pThis) |
static internal IntPtr | vtkBoxWidget2_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkBoxWidget2_ScalingEnabledOff_15 (HandleRef pThis) |
static internal void | vtkBoxWidget2_ScalingEnabledOn_16 (HandleRef pThis) |
static internal void | vtkBoxWidget2_SetMoveFacesEnabled_17 (HandleRef pThis, int _arg) |
static internal void | vtkBoxWidget2_SetRepresentation_18 (HandleRef pThis, HandleRef r) |
static internal void | vtkBoxWidget2_SetRotationEnabled_19 (HandleRef pThis, int _arg) |
static internal void | vtkBoxWidget2_SetScalingEnabled_20 (HandleRef pThis, int _arg) |
static internal void | vtkBoxWidget2_SetTranslationEnabled_21 (HandleRef pThis, int _arg) |
static internal void | vtkBoxWidget2_TranslationEnabledOff_22 (HandleRef pThis) |
static internal void | vtkBoxWidget2_TranslationEnabledOn_23 (HandleRef pThis) |
Static Private Member Functions |
static | vtkBoxWidget2 () |
| Automatically generated type registration mechanics.
|
vtkBoxWidget2 - 3D widget for manipulating a box
Description This 3D widget interacts with a vtkBoxRepresentation class (i.e., it handles the events that drive its corresponding representation). The representation is assumed to represent a region of interest that is represented by an arbitrarily oriented hexahedron (or box) with interior face angles of 90 degrees (i.e., orthogonal faces). The representation manifests seven handles that can be moused on and manipulated, plus the six faces can also be interacted with. The first six handles are placed on the six faces, the seventh is in the center of the box. In addition, a bounding box outline is shown, the "faces" of which can be selected for object rotation or scaling. A nice feature of vtkBoxWidget2, like any 3D widget, will work with the current interactor style. That is, if vtkBoxWidget2 does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkBoxWidget will terminate the processing of the event that it handles.
To use this widget, you generally pair it with a vtkBoxRepresentation (or a subclass). Variuos options are available in the representation for controlling how the widget appears, and how the widget functions.
Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> If one of the seven handles are selected: LeftButtonPressEvent - select the appropriate handle LeftButtonReleaseEvent - release the currently selected handle MouseMoveEvent - move the handle If one of the faces is selected: LeftButtonPressEvent - select a box face LeftButtonReleaseEvent - release the box face MouseMoveEvent - rotate the box In all the cases, independent of what is picked, the widget responds to the following VTK events: MiddleButtonPressEvent - translate the widget MiddleButtonReleaseEvent - release the widget RightButtonPressEvent - scale the widget's representation RightButtonReleaseEvent - stop scaling the widget MouseMoveEvent - scale (if right button) or move (if middle button) the widget </pre>
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkBoxWidget2's widget events: <pre> vtkWidgetEvent::Select -- some part of the widget has been selected vtkWidgetEvent::EndSelect -- the selection process has completed vtkWidgetEvent::Scale -- some part of the widget has been selected vtkWidgetEvent::EndScale -- the selection process has completed vtkWidgetEvent::Translate -- some part of the widget has been selected vtkWidgetEvent::EndTranslate -- the selection process has completed vtkWidgetEvent::Move -- a request for motion has been invoked </pre>
In turn, when these widget events are processed, the vtkBoxWidget2 invokes the following VTK events on itself (which observers can listen for): <pre> vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select) vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect) vtkCommand::InteractionEvent (on vtkWidgetEvent::Move) </pre>