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.vtkDistanceWidget Class Reference

vtkDistanceWidget - measure the distance between two points More...

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

List of all members.

Public Types

enum  Define_WrapperEnum { Define = 1, Manipulate = 2, Start = 0 }
 Enum defining the state of the widget. By default the widget is in Start mode, and expects to be interactively placed. While placing the points the widget transitions to Define state. Once placed, the widget enters the Manipulate state. More...

Public Member Functions

 vtkDistanceWidget (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDistanceWidget ()
 Instantiate this class.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
vtkDistanceRepresentation GetDistanceRepresentation ()
 Return the representation as a vtkDistanceRepresentation.
virtual int GetWidgetState ()
 Return the current widget state.
override int IsA (string type)
 Standard methods for a VTK class.
new vtkDistanceWidget NewInstance ()
 Standard methods for a VTK class.
override void SetEnabled (int arg0)
 The method for activiating and deactiviating this widget. This method must be overridden because it is a composite widget and does more than its superclasses' vtkAbstractWidget::SetEnabled() method.
override void SetProcessEvents (int arg0)
 Methods to change the whether the widget responds to interaction. Overridden to pass the state to component widgets.
void SetRepresentation (vtkDistanceRepresentation 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 SetWidgetStateToManipulate ()
 Set the state of the widget. If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.
virtual void SetWidgetStateToStart ()
 Set the state of the widget. If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.

Static Public Member Functions

static new vtkDistanceWidget New ()
 Instantiate this class.
static new int IsTypeOf (string type)
 Standard methods for a VTK class.
static new vtkDistanceWidget SafeDownCast (vtkObjectBase o)
 Standard methods for a VTK class.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkDistanceWidget"
 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 vtkDistanceWidget_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDistanceWidget_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal IntPtr vtkDistanceWidget_GetDistanceRepresentation_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkDistanceWidget_GetWidgetState_03 (HandleRef pThis)
static internal int vtkDistanceWidget_IsA_04 (HandleRef pThis, string type)
static internal int vtkDistanceWidget_IsTypeOf_05 (string type)
static internal IntPtr vtkDistanceWidget_NewInstance_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDistanceWidget_SafeDownCast_08 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDistanceWidget_SetEnabled_09 (HandleRef pThis, int arg0)
static internal void vtkDistanceWidget_SetProcessEvents_10 (HandleRef pThis, int arg0)
static internal void vtkDistanceWidget_SetRepresentation_11 (HandleRef pThis, HandleRef r)
static internal void vtkDistanceWidget_SetWidgetStateToManipulate_12 (HandleRef pThis)
static internal void vtkDistanceWidget_SetWidgetStateToStart_13 (HandleRef pThis)

Static Private Member Functions

static vtkDistanceWidget ()
 Automatically generated type registration mechanics.

Detailed Description

vtkDistanceWidget - measure the distance between two points

Description The vtkDistanceWidget is used to measure the distance between two points. The two end points can be positioned independently, and when they are released, a special PlacePointEvent is invoked so that special operations may be take to reposition the point (snap to grid, etc.) The widget has two different modes of interaction: when initially defined (i.e., placing the two points) and then a manipulate mode (adjusting the position of the two points).

To use this widget, specify an instance of vtkDistanceWidget and a representation (a subclass of vtkDistanceRepresentation). The widget is implemented using two instances of vtkHandleWidget which are used to position the end points of the line. The representations for these two handle widgets are provided by the vtkDistanceRepresentation.

Event Bindings By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events): <pre> LeftButtonPressEvent - add a point or select a handle MouseMoveEvent - position the second point or move a handle LeftButtonReleaseEvent - release the handle </pre>

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkDistanceWidget's widget events: <pre> vtkWidgetEvent::AddPoint -- add one point; depending on the state it may the first or second point added. Or, if near a handle, select the handle. vtkWidgetEvent::Move -- move the second point or handle depending on the state. vtkWidgetEvent::EndSelect -- the handle manipulation process has completed. </pre>

This widget invokes the following VTK events on itself (which observers can listen for): <pre> vtkCommand::StartInteractionEvent (beginning to interact) vtkCommand::EndInteractionEvent (completing interaction) vtkCommand::InteractionEvent (moving after selecting something) vtkCommand::PlacePointEvent (after point is positioned; call data includes handle id (0,1)) </pre>


Member Enumeration Documentation

Enum defining the state of the widget. By default the widget is in Start mode, and expects to be interactively placed. While placing the points the widget transitions to Define state. Once placed, the widget enters the Manipulate state.

Enumerator:
Define 

enum member

Manipulate 

enum member

Start 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Instantiate this class.


Member Function Documentation

Create the default widget representation if one is not set.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

override void Kitware.VTK.vtkDistanceWidget.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.

Return the representation as a vtkDistanceRepresentation.

Here is the call graph for this function:

Return the current widget state.

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

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Instantiate this class.

Reimplemented from Kitware.VTK.vtkObject.

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Standard methods for a VTK class.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Here is the call graph for this function:

override void Kitware.VTK.vtkDistanceWidget.SetEnabled ( int  arg0) [virtual]

The method for activiating and deactiviating this widget. This method must be overridden because it is a composite widget and does more than its superclasses' vtkAbstractWidget::SetEnabled() method.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

override void Kitware.VTK.vtkDistanceWidget.SetProcessEvents ( int  arg0) [virtual]

Methods to change the whether the widget responds to interaction. Overridden to pass the state to component widgets.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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.

Set the state of the widget. If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.

Set the state of the widget. If the state is set to "Manipulate" then it is assumed that the widget and its representation will be initialized programmatically and is not interactively placed. Initially the widget state is set to "Start" which means nothing will appear and the user must interactively place the widget with repeated mouse selections. Set the state to "Start" if you want interactive placement. Generally state changes must be followed by a Render() for things to visually take effect.

static internal void Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_GetDistanceRepresentation_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_GetWidgetState_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_IsA_04 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_IsTypeOf_05 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_NewInstance_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_SafeDownCast_08 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_SetEnabled_09 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_SetProcessEvents_10 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_SetRepresentation_11 ( HandleRef  pThis,
HandleRef  r 
) [private]
static internal void Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_SetWidgetStateToManipulate_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkDistanceWidget.vtkDistanceWidget_SetWidgetStateToStart_13 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkDistanceWidget.MRClassNameKey = "17vtkDistanceWidget" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


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