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

#include <vtkAngleWidget.h>

Inheritance diagram for vtkAngleWidget:

Collaboration diagram for vtkAngleWidget:

Public Types

enum	{ Start = 0, Define, Manipulate }
Public Member Functions
virtual void	SetEnabled (int)
void	CreateDefaultRepresentation ()
int	IsAngleValid ()
virtual void	SetProcessEvents (int)

void	SetRepresentation (vtkAngleRepresentation *r)

vtkAngleRepresentation *	GetAngleRepresentation ()

virtual void	SetWidgetStateToStart ()
virtual void	SetWidgetStateToManipulate ()

virtual int	GetWidgetState ()
Static Public Member Functions
static vtkAngleWidget *	New ()
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
vtkHandleWidget *	Point1Widget
vtkHandleWidget *	CenterWidget
vtkHandleWidget *	Point2Widget
vtkAngleWidgetCallback *	AngleWidgetCallback1
vtkAngleWidgetCallback *	AngleWidgetCenterCallback
vtkAngleWidgetCallback *	AngleWidgetCallback2
Friends
class	vtkAngleWidgetCallback
typedef vtkAbstractWidget	Superclass
static int	IsTypeOf (const char *type)
static vtkAngleWidget *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkAngleWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

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

Events:: vtkCommand::DisableEvent vtkCommand::EndInteractionEvent vtkCommand::MouseMoveEvent vtkCommand::InteractionEvent vtkCommand::EnableEvent vtkCommand::LeftButtonPressEvent vtkCommand::StartInteractionEvent vtkCommand::PlacePointEvent vtkCommand::LeftButtonReleaseEvent

Examples:: vtkAngleWidget (Examples)

Tests:: vtkAngleWidget (Tests)

Definition at line 90 of file vtkAngleWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkAngleWidget::Superclass

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

Definition at line 98 of file vtkAngleWidget.h.

Member Enumeration Documentation

anonymous enum

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. BTX

Enumerator:

Start
Define
Manipulate

Definition at line 137 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.

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 ( vtkObjectBase * o ) [static]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual vtkObjectBase* vtkAngleWidget::NewInstanceInternal ( ) const [protected, virtual]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

vtkAngleWidget* vtkAngleWidget::NewInstance ( ) const

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 activating and deactivating 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 111 of file vtkAngleWidget.h.

void vtkAngleWidget::CreateDefaultRepresentation ( ) [virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

vtkAngleRepresentation* vtkAngleWidget::GetAngleRepresentation ( ) [inline]

Return the representation as a vtkAngleRepresentation.

Definition at line 120 of file vtkAngleWidget.h.

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.

virtual void vtkAngleWidget::SetWidgetStateToStart ( ) [virtual]

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 vtkAngleWidget::SetWidgetStateToManipulate ( ) [virtual]

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 int vtkAngleWidget::GetWidgetState ( ) [inline, virtual]

Return the current widget state.

Definition at line 156 of file vtkAngleWidget.h.

static void vtkAngleWidget::AddPointAction ( vtkAbstractWidget * ) [static, protected]