ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkHandleWidget Class Reference

vtkHandleWidget - a general widget for moving handles More...

Inheritance diagram for Kitware.VTK.vtkHandleWidget:
[legend]
Collaboration diagram for Kitware.VTK.vtkHandleWidget:
[legend]

List of all members.

Public Types

enum  _WidgetState { Active = 1, Start = 0 }
 Get the widget state. More...

Public Member Functions

 vtkHandleWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkHandleWidget ()
 Instantiate this class.
virtual void AllowHandleResizeOff ()
 Allow resizing of handles ? By default the right mouse button scales the handle size.
virtual void AllowHandleResizeOn ()
 Allow resizing of handles ? By default the right mouse button scales the handle size.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set. By default an instance of vtkPointHandleRepresenation3D is created.
virtual void EnableAxisConstraintOff ()
 Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.
virtual void EnableAxisConstraintOn ()
 Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.
virtual int GetAllowHandleResize ()
 Allow resizing of handles ? By default the right mouse button scales the handle size.
virtual int GetEnableAxisConstraint ()
 Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.
vtkHandleRepresentation GetHandleRepresentation ()
 Return the representation as a vtkHandleRepresentation.
virtual int GetWidgetState ()
 Get the widget state.
override int IsA (string type)
 Standard VTK class macros.
new vtkHandleWidget NewInstance ()
 Standard VTK class macros.
virtual void SetAllowHandleResize (int _arg)
 Allow resizing of handles ? By default the right mouse button scales the handle size.
virtual void SetEnableAxisConstraint (int _arg)
 Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.
void SetRepresentation (vtkHandleRepresentation 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.

Static Public Member Functions

static new vtkHandleWidget New ()
 Instantiate this class.
static new int IsTypeOf (string type)
 Standard VTK class macros.
static new vtkHandleWidget SafeDownCast (vtkObjectBase o)
 Standard VTK class macros.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkHandleWidget"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkHandleWidget"
 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 vtkHandleWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHandleWidget_AllowHandleResizeOff_01 (HandleRef pThis)
static internal void vtkHandleWidget_AllowHandleResizeOn_02 (HandleRef pThis)
static internal void vtkHandleWidget_CreateDefaultRepresentation_03 (HandleRef pThis)
static internal void vtkHandleWidget_EnableAxisConstraintOff_04 (HandleRef pThis)
static internal void vtkHandleWidget_EnableAxisConstraintOn_05 (HandleRef pThis)
static internal int vtkHandleWidget_GetAllowHandleResize_06 (HandleRef pThis)
static internal int vtkHandleWidget_GetEnableAxisConstraint_07 (HandleRef pThis)
static internal IntPtr vtkHandleWidget_GetHandleRepresentation_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkHandleWidget_GetWidgetState_09 (HandleRef pThis)
static internal int vtkHandleWidget_IsA_10 (HandleRef pThis, string type)
static internal int vtkHandleWidget_IsTypeOf_11 (string type)
static internal IntPtr vtkHandleWidget_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHandleWidget_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHandleWidget_SetAllowHandleResize_15 (HandleRef pThis, int _arg)
static internal void vtkHandleWidget_SetEnableAxisConstraint_16 (HandleRef pThis, int _arg)
static internal void vtkHandleWidget_SetRepresentation_17 (HandleRef pThis, HandleRef r)

Static Private Member Functions

static vtkHandleWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkHandleWidget - a general widget for moving handles

Description The vtkHandleWidget is used to position a handle. A handle is a widget with a position (in display and world space). Various appearances are available depending on its associated representation. The widget provides methods for translation, including constrained translation along coordinate axes. To use this widget, create and associate a representation with the widget.

Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> LeftButtonPressEvent - select focal point of widget LeftButtonReleaseEvent - end selection MiddleButtonPressEvent - translate widget MiddleButtonReleaseEvent - end translation RightButtonPressEvent - scale widget RightButtonReleaseEvent - end scaling MouseMoveEvent - interactive movement across widget </pre>

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkHandleWidget's widget events: <pre> vtkWidgetEvent::Select -- focal point is being selected vtkWidgetEvent::EndSelect -- the selection process has completed vtkWidgetEvent::Translate -- translate the widget vtkWidgetEvent::EndTranslate -- end widget translation vtkWidgetEvent::Scale -- scale the widget vtkWidgetEvent::EndScale -- end scaling the widget vtkWidgetEvent::Move -- a request for widget motion </pre>

In turn, when these widget events are processed, the vtkHandleWidget 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>


Member Enumeration Documentation

Get the widget state.

Enumerator:
Active 

enum member

Start 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkHandleWidget.vtkHandleWidget ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkHandleWidget.vtkHandleWidget ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Instantiate this class.


Member Function Documentation

Allow resizing of handles ? By default the right mouse button scales the handle size.

Allow resizing of handles ? By default the right mouse button scales the handle size.

Create the default widget representation if one is not set. By default an instance of vtkPointHandleRepresenation3D is created.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

override void Kitware.VTK.vtkHandleWidget.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.

Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.

Allow resizing of handles ? By default the right mouse button scales the handle size.

Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.

Return the representation as a vtkHandleRepresentation.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkHandleWidget.GetWidgetState ( ) [virtual]

Get the widget state.

override int Kitware.VTK.vtkHandleWidget.IsA ( string  type) [virtual]

Standard VTK class macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

static new int Kitware.VTK.vtkHandleWidget.IsTypeOf ( string  type) [static]

Standard VTK class macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Instantiate this class.

Reimplemented from Kitware.VTK.vtkObject.

Standard VTK class macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Standard VTK class macros.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkHandleWidget.SetAllowHandleResize ( int  _arg) [virtual]

Allow resizing of handles ? By default the right mouse button scales the handle size.

virtual void Kitware.VTK.vtkHandleWidget.SetEnableAxisConstraint ( int  _arg) [virtual]

Enable / disable axis constrained motion of the handles. By default the widget responds to the shift modifier to constrain the handle along the axis closest aligned with the motion vector.

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.

static internal void Kitware.VTK.vtkHandleWidget.vtkHandleWidget_AllowHandleResizeOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHandleWidget.vtkHandleWidget_AllowHandleResizeOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHandleWidget.vtkHandleWidget_CreateDefaultRepresentation_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHandleWidget.vtkHandleWidget_EnableAxisConstraintOff_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHandleWidget.vtkHandleWidget_EnableAxisConstraintOn_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHandleWidget.vtkHandleWidget_GetAllowHandleResize_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHandleWidget.vtkHandleWidget_GetEnableAxisConstraint_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkHandleWidget.vtkHandleWidget_GetHandleRepresentation_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkHandleWidget.vtkHandleWidget_GetWidgetState_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHandleWidget.vtkHandleWidget_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkHandleWidget.vtkHandleWidget_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkHandleWidget.vtkHandleWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHandleWidget.vtkHandleWidget_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHandleWidget.vtkHandleWidget_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkHandleWidget.vtkHandleWidget_SetAllowHandleResize_15 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkHandleWidget.vtkHandleWidget_SetEnableAxisConstraint_16 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkHandleWidget.vtkHandleWidget_SetRepresentation_17 ( HandleRef  pThis,
HandleRef  r 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkHandleWidget.MRClassNameKey = "15vtkHandleWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

new const string Kitware.VTK.vtkHandleWidget.MRFullTypeName = "Kitware.VTK.vtkHandleWidget"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


The documentation for this class was generated from the following file: