vtkDistanceWidget Class Reference

#include <vtkDistanceWidget.h>

Inheritance diagram for vtkDistanceWidget:

[legend]

Collaboration diagram for vtkDistanceWidget:

[legend]

List of all members.

---

Detailed Description

measure the distance between two points

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):

   LeftButtonPressEvent - add a point or select a handle
   MouseMoveEvent - position the second point or move a handle
   LeftButtonReleaseEvent - release the 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 vtkDistanceWidget's widget events:

   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.
 

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 after selecting something)
   vtkCommand::PlacePointEvent (after point is positioned;
                                call data includes handle id (0,1))
 

See also:

vtkHandleWidget

Events:

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

Tests:

vtkDistanceWidget (Tests)

Definition at line 84 of file vtkDistanceWidget.h.

typedef vtkAbstractWidget	Superclass
static int	IsTypeOf (const char *type)
static vtkDistanceWidget *	SafeDownCast (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 ()
virtual void	SetProcessEvents (int)
void	SetRepresentation (vtkDistanceRepresentation *r)
Static Public Member Functions
static vtkDistanceWidget *	New ()
Protected Types
enum	{ Start = 0, Define, Manipulate }
Protected Member Functions
	vtkDistanceWidget ()
	~vtkDistanceWidget ()
void	StartDistanceInteraction (int handleNum)
void	DistanceInteraction (int handleNum)
void	EndDistanceInteraction (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 *	Point2Widget
vtkDistanceWidgetCallback *	DistanceWidgetCallback1
vtkDistanceWidgetCallback *	DistanceWidgetCallback2
Friends
class	vtkDistanceWidgetCallback

---

Member Typedef Documentation

typedef vtkAbstractWidget vtkDistanceWidget::Superclass

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

Definition at line 92 of file vtkDistanceWidget.h.

---

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

Start
Define
Manipulate

Definition at line 123 of file vtkDistanceWidget.h.

---

Constructor & Destructor Documentation

vtkDistanceWidget::vtkDistanceWidget

(

)

[protected]

vtkDistanceWidget::~vtkDistanceWidget

(

)

[protected]

---

Member Function Documentation

static vtkDistanceWidget* vtkDistanceWidget::New

(

)

[static]

Instantiate this class.

Reimplemented from vtkObject.

virtual const char* vtkDistanceWidget::GetClassName

(

)

[virtual]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

static int vtkDistanceWidget::IsTypeOf

(

const char *

type

)

[static]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual int vtkDistanceWidget::IsA

(

const char *

type

)

[virtual]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

static vtkDistanceWidget* vtkDistanceWidget::SafeDownCast

(

vtkObject *

o

)

[static]

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

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

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual void vtkDistanceWidget::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 vtkDistanceWidget::SetRepresentation

(

vtkDistanceRepresentation *

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 105 of file vtkDistanceWidget.h.

void vtkDistanceWidget::CreateDefaultRepresentation

(

)

[virtual]

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

virtual void vtkDistanceWidget::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 vtkDistanceWidget::AddPointAction

(

vtkAbstractWidget *

)

[static, protected]

static void vtkDistanceWidget::MoveAction

(

vtkAbstractWidget *

)

[static, protected]

static void vtkDistanceWidget::EndSelectAction

(

vtkAbstractWidget *

)

[static, protected]

void vtkDistanceWidget::StartDistanceInteraction

(

int

handleNum

)

[protected]

void vtkDistanceWidget::DistanceInteraction

(

int

handleNum

)

[protected]

void vtkDistanceWidget::EndDistanceInteraction

(

int

handleNum

)

[protected]

---

Friends And Related Function Documentation

friend class vtkDistanceWidgetCallback [friend]

Definition at line 147 of file vtkDistanceWidget.h.

---

Member Data Documentation

int vtkDistanceWidget::WidgetState [protected]

Definition at line 125 of file vtkDistanceWidget.h.

int vtkDistanceWidget::CurrentHandle [protected]

Definition at line 126 of file vtkDistanceWidget.h.

vtkHandleWidget* vtkDistanceWidget::Point1Widget [protected]

Definition at line 135 of file vtkDistanceWidget.h.

vtkHandleWidget* vtkDistanceWidget::Point2Widget [protected]

Definition at line 136 of file vtkDistanceWidget.h.

vtkDistanceWidgetCallback* vtkDistanceWidget::DistanceWidgetCallback1 [protected]

Definition at line 137 of file vtkDistanceWidget.h.

vtkDistanceWidgetCallback* vtkDistanceWidget::DistanceWidgetCallback2 [protected]

Definition at line 138 of file vtkDistanceWidget.h.

---

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

• dox/Widgets/vtkDistanceWidget.h