vtkBiDimensionalWidget Class Reference

measure the bi-dimensional lengths of an object More...

#include <vtkBiDimensionalWidget.h>

Inheritance diagram for vtkBiDimensionalWidget:

Collaboration diagram for vtkBiDimensionalWidget:

Public Types
enum	{ EndWidgetSelectEvent = 10050 }
enum	{ Start =0, Define, Manipulate }
Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass
Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual void	SetEnabled (int)
void	CreateDefaultRepresentation ()
int	IsMeasureValid ()
virtual void	SetProcessEvents (int)
void	SetRepresentation (vtkBiDimensionalRepresentation *r)
vtkBiDimensionalRepresentation *	GetBiDimensionalRepresentation ()
virtual void	SetWidgetStateToStart ()
virtual void	SetWidgetStateToManipulate ()
virtual int	GetWidgetState ()
Public Member Functions inherited from vtkAbstractWidget
void	Render ()
virtual void	SetPriority (float)
virtual int	GetProcessEvents ()
virtual void	ProcessEventsOn ()
virtual void	ProcessEventsOff ()
vtkWidgetEventTranslator *	GetEventTranslator ()
void	SetParent (vtkAbstractWidget *parent)
virtual vtkAbstractWidget *	GetParent ()
vtkWidgetRepresentation *	GetRepresentation ()
virtual void	SetManagesCursor (int)
virtual int	GetManagesCursor ()
virtual void	ManagesCursorOn ()
virtual void	ManagesCursorOff ()
vtkAbstractWidget *	NewInstance () const
Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	OnChar ()
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
virtual vtkRenderWindowInteractor *	GetInteractor ()
virtual float	GetPriority ()
virtual void	PickingManagedOn ()
virtual void	PickingManagedOff ()
virtual void	SetPickingManaged (bool)
virtual bool	GetPickingManaged ()
virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()
virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()
virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)
virtual vtkRenderer *	GetCurrentRenderer ()
virtual void	SetCurrentRenderer (vtkRenderer *)
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	ReleaseFocus ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkBiDimensionalWidget *	New ()
Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)
static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)
static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
	vtkBiDimensionalWidget ()
	~vtkBiDimensionalWidget ()
void	StartBiDimensionalInteraction ()
virtual void	EndBiDimensionalInteraction ()
Protected Member Functions inherited from vtkAbstractWidget
	vtkAbstractWidget ()
	~vtkAbstractWidget ()
void	SetWidgetRepresentation (vtkWidgetRepresentation *r)
virtual void	SetCursor (int vtkNotUsed(state))
Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()
	~vtkInteractorObserver ()
virtual void	RegisterPickers ()
void	UnRegisterPickers ()
virtual void	PickersModified ()
vtkPickingManager *	GetPickingManager ()
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
virtual void	EndInteraction ()
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	AddPointAction (vtkAbstractWidget *)
static void	MoveAction (vtkAbstractWidget *)
static void	EndSelectAction (vtkAbstractWidget *)
Static Protected Member Functions inherited from vtkAbstractWidget
static void	ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

Protected Attributes
int	WidgetState
int	CurrentHandle
int	HandleLine1Selected
int	HandleLine2Selected
int	Line1InnerSelected
int	Line1OuterSelected
int	Line2InnerSelected
int	Line2OuterSelected
int	CenterSelected
vtkHandleWidget *	Point1Widget
vtkHandleWidget *	Point2Widget
vtkHandleWidget *	Point3Widget
vtkHandleWidget *	Point4Widget
vtkBiDimensionalWidgetCallback *	BiDimensionalWidgetCallback1
vtkBiDimensionalWidgetCallback *	BiDimensionalWidgetCallback2
vtkBiDimensionalWidgetCallback *	BiDimensionalWidgetCallback3
vtkBiDimensionalWidgetCallback *	BiDimensionalWidgetCallback4
Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep
int	ManagesCursor
vtkWidgetEventTranslator *	EventTranslator
vtkWidgetCallbackMapper *	CallbackMapper
vtkAbstractWidget *	Parent
void *	CallData
int	ProcessEvents
Protected Attributes inherited from vtkInteractorObserver
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
bool	PickingManaged
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Friends
class	vtkBiDimensionalWidgetCallback
typedef vtkAbstractWidget	Superclass
static int	IsTypeOf (const char *type)
static vtkBiDimensionalWidget *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkBiDimensionalWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

measure the bi-dimensional lengths of an object

The vtkBiDimensionalWidget is used to measure the bi-dimensional length of an object. The bi-dimensional measure is defined by two finite, orthogonal lines that intersect within the finite extent of both lines. The lengths of these two lines gives the bi-dimensional measure. Each line is defined by two handle widgets at the end points of each line.

The orthogonal constraint on the two lines limits how the four end points can be positioned. The first two points can be placed arbitrarily to define the first line (similar to vtkDistanceWidget). The placement of the third point is limited by the finite extent of the first line. As the third point is placed, the fourth point is placed on the opposite side of the first line. Once the third point is placed, the second line is defined since the fourth point is defined at the same time, but the fourth point can be moved along the second line (i.e., maintaining the orthogonal relationship between the two lines). Once defined, any of the four points can be moved along their constraint lines. Also, each line can be translated along the other line (in an orthogonal direction), and the whole bi-dimensional widget can be rotated about its center point (see the description of the event bindings). Finally, selecting the point where the two orthogonal axes intersect, the entire widget can be translated in any direction.

Placement of any point results in a special PlacePointEvent invocation so that special operations may be performed to reposition the point. Motion of any point, moving the lines, or rotating the widget cause InteractionEvents to be invoked. Note that the widget has two fundamental modes: a define mode (when initially placing the points) and a manipulate mode (after the points are placed). Line translation and rotation are only possible in manipulate mode.

To use this widget, specify an instance of vtkBiDimensionalWidget and a representation (e.g., vtkBiDimensionalRepresentation2D). The widget is implemented using four instances of vtkHandleWidget which are used to position the end points of the two intersecting lines. The representations for these handle widgets are provided by the vtkBiDimensionalRepresentation class.

Event Bindings:

By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):

  LeftButtonPressEvent - define a point or manipulate a handle, line,
                         perform rotation or translate the widget.
  MouseMoveEvent - position the points, move a line, rotate or translate the widget
  LeftButtonReleaseEvent - release the selected handle and end interaction

Event Bindings:

Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkBiDimensionalWidget's widget events:

  vtkWidgetEvent::AddPoint -- (In Define mode:) Add one point; depending on the
                              state it may the first, second, third or fourth
                              point added. (In Manipulate mode:) If near a handle,
                              select the handle. Or if near a line, select the line.
  vtkWidgetEvent::Move -- (In Define mode:) Position the second, third or fourth
                          point. (In Manipulate mode:) Move the handle, line or widget.
  vtkWidgetEvent::EndSelect -- the 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, line or performing rotation)
  vtkCommand::PlacePointEvent (after a point is positioned;
                               call data includes handle id (0,1,2,4))

See also

vtkHandleWidget vtkDistanceWidget

Events:

vtkCommand::PlacePointEvent vtkCommand::LeftButtonPressEvent vtkCommand::StartInteractionEvent vtkCommand::InteractionEvent vtkCommand::EndInteractionEvent vtkCommand::LeftButtonReleaseEvent

Tests:

vtkBiDimensionalWidget (Tests)

Definition at line 110 of file vtkBiDimensionalWidget.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkBiDimensionalWidget::Superclass

Standard methods for a VTK class.

Definition at line 118 of file vtkBiDimensionalWidget.h.

Member Enumeration Documentation

anonymous enum

Events.

Enumerator
EndWidgetSelectEvent

Definition at line 151 of file vtkBiDimensionalWidget.h.

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 167 of file vtkBiDimensionalWidget.h.

Constructor & Destructor Documentation

vtkBiDimensionalWidget::vtkBiDimensionalWidget ( )

protected

vtkBiDimensionalWidget::~vtkBiDimensionalWidget ( )

protected

Member Function Documentation

static vtkBiDimensionalWidget* vtkBiDimensionalWidget::New ( )

static

Instantiate this class.

static int vtkBiDimensionalWidget::IsTypeOf ( const char *  type )

static

Standard methods for a VTK class.

virtual int vtkBiDimensionalWidget::IsA ( const char *  type )

virtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

static vtkBiDimensionalWidget* vtkBiDimensionalWidget::SafeDownCast ( vtkObjectBase *  o )

static

Standard methods for a VTK class.

virtual vtkObjectBase* vtkBiDimensionalWidget::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

vtkBiDimensionalWidget* vtkBiDimensionalWidget::NewInstance

(

)

const

Standard methods for a VTK class.

void vtkBiDimensionalWidget::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Standard methods for a VTK class.

Reimplemented from vtkAbstractWidget.

virtual void vtkBiDimensionalWidget::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 vtkBiDimensionalWidget::SetRepresentation ( vtkBiDimensionalRepresentation *  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 131 of file vtkBiDimensionalWidget.h.

vtkBiDimensionalRepresentation* vtkBiDimensionalWidget::GetBiDimensionalRepresentation ( )

inline

Return the representation as a vtkBiDimensionalRepresentation.

Definition at line 137 of file vtkBiDimensionalWidget.h.

void vtkBiDimensionalWidget::CreateDefaultRepresentation ( )

virtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

int vtkBiDimensionalWidget::IsMeasureValid

(

)

A flag indicates whether the bi-dimensional measure is valid. The widget becomes valid after two of the four points are placed.

virtual void vtkBiDimensionalWidget::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 vtkBiDimensionalWidget::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 vtkBiDimensionalWidget::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 vtkBiDimensionalWidget::GetWidgetState ( )

inlinevirtual

Return the current widget state.

Definition at line 186 of file vtkBiDimensionalWidget.h.

static void vtkBiDimensionalWidget::AddPointAction ( vtkAbstractWidget *  )

staticprotected

static void vtkBiDimensionalWidget::MoveAction ( vtkAbstractWidget *  )

staticprotected

static void vtkBiDimensionalWidget::EndSelectAction ( vtkAbstractWidget *  )

staticprotected

void vtkBiDimensionalWidget::StartBiDimensionalInteraction ( )

protected

virtual void vtkBiDimensionalWidget::EndBiDimensionalInteraction ( )

protectedvirtual

Friends And Related Function Documentation

friend class vtkBiDimensionalWidgetCallback

friend

Definition at line 227 of file vtkBiDimensionalWidget.h.

Member Data Documentation

int vtkBiDimensionalWidget::WidgetState

protected

Definition at line 195 of file vtkBiDimensionalWidget.h.

int vtkBiDimensionalWidget::CurrentHandle

protected

Definition at line 196 of file vtkBiDimensionalWidget.h.

int vtkBiDimensionalWidget::HandleLine1Selected

protected

Definition at line 197 of file vtkBiDimensionalWidget.h.

int vtkBiDimensionalWidget::HandleLine2Selected

protected

Definition at line 198 of file vtkBiDimensionalWidget.h.

int vtkBiDimensionalWidget::Line1InnerSelected

protected

Definition at line 199 of file vtkBiDimensionalWidget.h.

int vtkBiDimensionalWidget::Line1OuterSelected

protected

Definition at line 200 of file vtkBiDimensionalWidget.h.

int vtkBiDimensionalWidget::Line2InnerSelected

protected

Definition at line 201 of file vtkBiDimensionalWidget.h.

int vtkBiDimensionalWidget::Line2OuterSelected

protected

Definition at line 202 of file vtkBiDimensionalWidget.h.

int vtkBiDimensionalWidget::CenterSelected

protected

Definition at line 203 of file vtkBiDimensionalWidget.h.

vtkHandleWidget* vtkBiDimensionalWidget::Point1Widget

protected

Definition at line 212 of file vtkBiDimensionalWidget.h.

vtkHandleWidget* vtkBiDimensionalWidget::Point2Widget

protected

Definition at line 213 of file vtkBiDimensionalWidget.h.

vtkHandleWidget* vtkBiDimensionalWidget::Point3Widget

protected

Definition at line 214 of file vtkBiDimensionalWidget.h.

vtkHandleWidget* vtkBiDimensionalWidget::Point4Widget

protected

Definition at line 215 of file vtkBiDimensionalWidget.h.

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback1

protected

Definition at line 216 of file vtkBiDimensionalWidget.h.

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback2

protected

Definition at line 217 of file vtkBiDimensionalWidget.h.

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback3

protected

Definition at line 218 of file vtkBiDimensionalWidget.h.

vtkBiDimensionalWidgetCallback* vtkBiDimensionalWidget::BiDimensionalWidgetCallback4

protected

Definition at line 219 of file vtkBiDimensionalWidget.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkBiDimensionalWidget.h