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

vtkLineWidget2 - 3D widget for manipulating a finite, straight line More...

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

List of all members.

Public Member Functions

 vtkLineWidget2 (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkLineWidget2 ()
 Instantiate the object.
override void CreateDefaultRepresentation ()
 Create the default widget representation if one is not set.
vtkLineRepresentation GetLineRepresentation ()
 Return the representation as a vtkLineRepresentation.
override int IsA (string type)
 Standard vtkObject methods.
new vtkLineWidget2 NewInstance ()
 Standard vtkObject methods.
override void SetEnabled (int enabling)
 Override superclasses' SetEnabled() method because the line widget must enable its internal handle widgets.
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 (vtkLineRepresentation 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 vtkLineWidget2 New ()
 Instantiate the object.
static new int IsTypeOf (string type)
 Standard vtkObject methods.
static new vtkLineWidget2 SafeDownCast (vtkObjectBase o)
 Standard vtkObject methods.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkLineWidget2"
 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 vtkLineWidget2_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLineWidget2_CreateDefaultRepresentation_01 (HandleRef pThis)
static internal IntPtr vtkLineWidget2_GetLineRepresentation_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkLineWidget2_IsA_03 (HandleRef pThis, string type)
static internal int vtkLineWidget2_IsTypeOf_04 (string type)
static internal IntPtr vtkLineWidget2_NewInstance_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkLineWidget2_SafeDownCast_07 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLineWidget2_SetEnabled_08 (HandleRef pThis, int enabling)
static internal void vtkLineWidget2_SetProcessEvents_09 (HandleRef pThis, int arg0)
static internal void vtkLineWidget2_SetRepresentation_10 (HandleRef pThis, HandleRef r)

Static Private Member Functions

static vtkLineWidget2 ()
 Automatically generated type registration mechanics.

Detailed Description

vtkLineWidget2 - 3D widget for manipulating a finite, straight line

Description This 3D widget defines a straight line that can be interactively placed in a scene. The widget is assumed to consist of two parts: 1) two end points and 2) a straight line connecting the two points. (The representation paired with this widget determines the actual geometry of the widget.) The positioning of the two end points is facilitated by using vtkHandleWidgets to position the points.

To use this widget, you generally pair it with a vtkLineRepresentation (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 two end points are selected: LeftButtonPressEvent - activate the associated handle widget LeftButtonReleaseEvent - release the handle widget associated with the point MouseMoveEvent - move the point If the line is selected: LeftButtonPressEvent - activate a handle widget accociated with the line LeftButtonReleaseEvent - release the handle widget associated with the line MouseMoveEvent - translate the line 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 vtkLineWidget2's widget events: <pre> vtkWidgetEvent::Select -- some part of the widget has been selected vtkWidgetEvent::EndSelect -- the selection process has completed vtkWidgetEvent::Move -- a request for slider motion has been invoked </pre>

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


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Instantiate the object.


Member Function Documentation

Create the default widget representation if one is not set.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Here is the call graph for this function:

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

Standard vtkObject methods.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Standard vtkObject methods.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Instantiate the object.

Reimplemented from Kitware.VTK.vtkObject.

Standard vtkObject methods.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Standard vtkObject methods.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

Here is the call graph for this function:

override void Kitware.VTK.vtkLineWidget2.SetEnabled ( int  enabling) [virtual]

Override superclasses' SetEnabled() method because the line widget must enable its internal handle widgets.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

static internal void Kitware.VTK.vtkLineWidget2.vtkLineWidget2_CreateDefaultRepresentation_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLineWidget2.vtkLineWidget2_GetLineRepresentation_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLineWidget2.vtkLineWidget2_IsA_03 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkLineWidget2.vtkLineWidget2_IsTypeOf_04 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkLineWidget2.vtkLineWidget2_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLineWidget2.vtkLineWidget2_NewInstance_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLineWidget2.vtkLineWidget2_SafeDownCast_07 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLineWidget2.vtkLineWidget2_SetEnabled_08 ( HandleRef  pThis,
int  enabling 
) [private]
static internal void Kitware.VTK.vtkLineWidget2.vtkLineWidget2_SetProcessEvents_09 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkLineWidget2.vtkLineWidget2_SetRepresentation_10 ( HandleRef  pThis,
HandleRef  r 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkLineWidget2.MRClassNameKey = "14vtkLineWidget2" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAbstractWidget.


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