vtkLineWidget2 Class Reference

#include <vtkLineWidget2.h>

Inheritance diagram for vtkLineWidget2:

Inheritance graph
Collaboration diagram for vtkLineWidget2:

Collaboration graph

List of all members.

Detailed Description

3D widget for manipulating a finite, straight line

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):
 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
Event Bindings:
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:
   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
Event Bindings:
In turn, when these widget events are processed, the vtkLineWidget2 invokes the following VTK events on itself (which observers can listen for):
   vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
   vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
   vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
Note that the widget can be picked even when it is "behind" other actors. This is an intended feature and not a bug.

This class, and vtkLineRepresentation, are next generation VTK widgets. An earlier version of this functionality was defined in the class vtkLineWidget.

See also:
vtkLineRepresentation vtkLineWidget vtk3DWidget vtkImplicitPlaneWidget vtkImplicitPlaneWidget2
vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::MouseMoveEvent vtkCommand::LeftButtonPressEvent vtkCommand::StartInteractionEvent vtkCommand::LeftButtonReleaseEvent
vtkLineWidget2 (Tests)

Definition at line 99 of file vtkLineWidget2.h.

typedef vtkAbstractWidget Superclass
static int IsTypeOf (const char *type)
static vtkLineWidget2SafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions

virtual void SetEnabled (int enabling)
void CreateDefaultRepresentation ()
virtual void SetProcessEvents (int)
void SetRepresentation (vtkLineRepresentation *r)

Static Public Member Functions

static vtkLineWidget2New ()

Protected Types

enum  _WidgetState { Start = 0, Active }

Protected Member Functions

 vtkLineWidget2 ()
 ~vtkLineWidget2 ()

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
static void TranslateAction (vtkAbstractWidget *)
static void ScaleAction (vtkAbstractWidget *)
static void EndSelectAction (vtkAbstractWidget *)
static void MoveAction (vtkAbstractWidget *)

Protected Attributes

int WidgetState
int CurrentHandle

Member Typedef Documentation

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

Definition at line 107 of file vtkLineWidget2.h.

Member Enumeration Documentation

enum vtkLineWidget2::_WidgetState [protected]


Definition at line 136 of file vtkLineWidget2.h.

Constructor & Destructor Documentation

vtkLineWidget2::vtkLineWidget2 (  )  [protected]

vtkLineWidget2::~vtkLineWidget2 (  )  [protected]

Member Function Documentation

static vtkLineWidget2* vtkLineWidget2::New (  )  [static]

Instantiate the object.

Reimplemented from vtkObject.

virtual const char* vtkLineWidget2::GetClassName (  )  [virtual]

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

static int vtkLineWidget2::IsTypeOf ( const char *  type  )  [static]

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

virtual int vtkLineWidget2::IsA ( const char *  type  )  [virtual]

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

static vtkLineWidget2* vtkLineWidget2::SafeDownCast ( vtkObject o  )  [static]

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

void vtkLineWidget2::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

virtual void vtkLineWidget2::SetEnabled ( int  enabling  )  [virtual]

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

Reimplemented from vtkAbstractWidget.

void vtkLineWidget2::SetRepresentation ( vtkLineRepresentation r  )  [inline]

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.

Definition at line 119 of file vtkLineWidget2.h.

void vtkLineWidget2::CreateDefaultRepresentation (  )  [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

virtual void vtkLineWidget2::SetProcessEvents ( int   )  [virtual]

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

Reimplemented from vtkAbstractWidget.

static void vtkLineWidget2::SelectAction ( vtkAbstractWidget  )  [static, protected]

static void vtkLineWidget2::TranslateAction ( vtkAbstractWidget  )  [static, protected]

static void vtkLineWidget2::ScaleAction ( vtkAbstractWidget  )  [static, protected]

static void vtkLineWidget2::EndSelectAction ( vtkAbstractWidget  )  [static, protected]

static void vtkLineWidget2::MoveAction ( vtkAbstractWidget  )  [static, protected]

Member Data Documentation

int vtkLineWidget2::WidgetState [protected]

Definition at line 135 of file vtkLineWidget2.h.

Definition at line 138 of file vtkLineWidget2.h.

Definition at line 148 of file vtkLineWidget2.h.

Definition at line 149 of file vtkLineWidget2.h.

Definition at line 150 of file vtkLineWidget2.h.

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

Generated on Mon Sep 27 18:32:53 2010 for VTK by  doxygen 1.5.6