vtkAngleWidget Class Reference

#include <vtkAngleWidget.h>

Inheritance diagram for vtkAngleWidget:

Inheritance graph
Collaboration diagram for vtkAngleWidget:

Collaboration graph

List of all members.

Detailed Description

measure the angle between two rays (defined by three points)

The vtkAngleWidget is used to measure the angle between two rays (defined by three points). The three points (two end points and a center) 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 three points) and then a manipulate mode (adjusting the position of the three points).

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

Event Bindings:
By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
   LeftButtonPressEvent - add a point or select a handle 
   MouseMoveEvent - position the second or third point, or move a handle
   LeftButtonReleaseEvent - release the selected handle
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkAngleWidget's widget events:
   vtkWidgetEvent::AddPoint -- add one point; depending on the state
                               it may the first, second or third point 
                               added. Or, if near a handle, select the handle.
   vtkWidgetEvent::Move -- position the second or third point, or move the
                           handle depending on the state.
   vtkWidgetEvent::EndSelect -- the handle manipulation process has completed.
Event Bindings:
This widget invokes the following VTK events on itself (which observers can listen for):
   vtkCommand::StartInteractionEvent (beginning to interact)
   vtkCommand::EndInteractionEvent (completing interaction)
   vtkCommand::InteractionEvent (moving a handle)
   vtkCommand::PlacePointEvent (after a point is positioned; 
                                call data includes handle id (0,1,2))
See also:
vtkHandleWidget vtkDistanceWidget
vtkCommand::DisableEvent vtkCommand::EndInteractionEvent vtkCommand::MouseMoveEvent vtkCommand::InteractionEvent vtkCommand::EnableEvent vtkCommand::LeftButtonPressEvent vtkCommand::StartInteractionEvent vtkCommand::PlacePointEvent vtkCommand::LeftButtonReleaseEvent
vtkAngleWidget (Examples)
vtkAngleWidget (Tests)

Definition at line 89 of file vtkAngleWidget.h.

typedef vtkAbstractWidget Superclass
static int IsTypeOf (const char *type)
static vtkAngleWidgetSafeDownCast (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)
void CreateDefaultRepresentation ()
int IsAngleValid ()
virtual void SetProcessEvents (int)
void SetRepresentation (vtkAngleRepresentation *r)

Static Public Member Functions

static vtkAngleWidgetNew ()

Protected Types

enum  { Start = 0, Define, Manipulate }

Protected Member Functions

 vtkAngleWidget ()
 ~vtkAngleWidget ()
void StartAngleInteraction (int handleNum)
void AngleInteraction (int handleNum)
void EndAngleInteraction (int handleNum)

Static Protected Member Functions

static void AddPointAction (vtkAbstractWidget *)
static void MoveAction (vtkAbstractWidget *)
static void EndSelectAction (vtkAbstractWidget *)

Protected Attributes

int WidgetState
int CurrentHandle
vtkAngleWidgetCallback * AngleWidgetCallback1
vtkAngleWidgetCallback * AngleWidgetCenterCallback
vtkAngleWidgetCallback * AngleWidgetCallback2


class vtkAngleWidgetCallback

Member Typedef Documentation

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

Definition at line 97 of file vtkAngleWidget.h.

Member Enumeration Documentation

anonymous enum [protected]


Definition at line 131 of file vtkAngleWidget.h.

Constructor & Destructor Documentation

vtkAngleWidget::vtkAngleWidget (  )  [protected]

vtkAngleWidget::~vtkAngleWidget (  )  [protected]

Member Function Documentation

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

Instantiate this class.

Reimplemented from vtkObject.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual void vtkAngleWidget::SetEnabled ( int   )  [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 vtkAbstractWidget.

void vtkAngleWidget::SetRepresentation ( vtkAngleRepresentation 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 110 of file vtkAngleWidget.h.

void vtkAngleWidget::CreateDefaultRepresentation (  )  [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

int vtkAngleWidget::IsAngleValid (  ) 

A flag indicates whether the angle is valid. The angle value only becomes valid after two of the three points are placed.

virtual void vtkAngleWidget::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 vtkAngleWidget::AddPointAction ( vtkAbstractWidget  )  [static, protected]

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

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

void vtkAngleWidget::StartAngleInteraction ( int  handleNum  )  [protected]

void vtkAngleWidget::AngleInteraction ( int  handleNum  )  [protected]

void vtkAngleWidget::EndAngleInteraction ( int  handleNum  )  [protected]

Friends And Related Function Documentation

friend class vtkAngleWidgetCallback [friend]

Definition at line 157 of file vtkAngleWidget.h.

Member Data Documentation

int vtkAngleWidget::WidgetState [protected]

Definition at line 133 of file vtkAngleWidget.h.

Definition at line 134 of file vtkAngleWidget.h.

Definition at line 143 of file vtkAngleWidget.h.

Definition at line 144 of file vtkAngleWidget.h.

Definition at line 145 of file vtkAngleWidget.h.

vtkAngleWidgetCallback* vtkAngleWidget::AngleWidgetCallback1 [protected]

Definition at line 146 of file vtkAngleWidget.h.

vtkAngleWidgetCallback* vtkAngleWidget::AngleWidgetCenterCallback [protected]

Definition at line 147 of file vtkAngleWidget.h.

vtkAngleWidgetCallback* vtkAngleWidget::AngleWidgetCallback2 [protected]

Definition at line 148 of file vtkAngleWidget.h.

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

Generated on Mon Sep 27 18:17:48 2010 for VTK by  doxygen 1.5.6