3D widget for manipulating a finite, straight line More...

#include <vtkLineWidget2.h>

Inheritance diagram for vtkLineWidget2:

Collaboration diagram for vtkLineWidget2:

Public Member Functions
virtual void	SetEnabled (int enabling)

void	CreateDefaultRepresentation ()

virtual void	SetProcessEvents (int)


void	SetRepresentation (vtkLineRepresentation *r)


vtkLineRepresentation *	GetLineRepresentation ()

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 vtkLineWidget2 *	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 Types
enum	_WidgetState { Start =0, Active }

Protected Member Functions
	vtkLineWidget2 ()

	~vtkLineWidget2 ()

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	SelectAction (vtkAbstractWidget *)

static void	TranslateAction (vtkAbstractWidget *)

static void	ScaleAction (vtkAbstractWidget *)

static void	EndSelectAction (vtkAbstractWidget *)

static void	MoveAction (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

vtkHandleWidget *	Point1Widget

vtkHandleWidget *	Point2Widget

vtkHandleWidget *	LineHandle

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

typedef vtkAbstractWidget	Superclass

static int	IsTypeOf (const char *type)

static vtkLineWidget2 *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkLineWidget2 *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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). Various 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)

Event Bindings:: 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

Events:: vtkCommand::MouseMoveEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::LeftButtonPressEvent vtkCommand::LeftButtonReleaseEvent vtkCommand::EndInteractionEvent

Tests:: vtkLineWidget2 (Tests)

Definition at line 97 of file vtkLineWidget2.h.

Member Typedef Documentation

typedef vtkAbstractWidget vtkLineWidget2::Superclass

Standard vtkObject methods

Definition at line 105 of file vtkLineWidget2.h.

Member Enumeration Documentation

enum vtkLineWidget2::_WidgetState

protected

Enumerator
Start
Active

Definition at line 140 of file vtkLineWidget2.h.

Constructor & Destructor Documentation

vtkLineWidget2::vtkLineWidget2 ( )

protected

vtkLineWidget2::~vtkLineWidget2 ( )

protected

Member Function Documentation

static vtkLineWidget2* vtkLineWidget2::New ( )

static

Instantiate the object.

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

static

Standard vtkObject methods

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

virtual

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

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

static

Standard vtkObject methods

virtual vtkObjectBase* vtkLineWidget2::NewInstanceInternal ( ) const

protectedvirtual

Standard vtkObject methods

Reimplemented from vtkAbstractWidget.

vtkLineWidget2* vtkLineWidget2::NewInstance ( ) const

Standard vtkObject methods

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 117 of file vtkLineWidget2.h.

vtkLineRepresentation* vtkLineWidget2::GetLineRepresentation ( )

inline

Return the representation as a vtkLineRepresentation.

Definition at line 123 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 * )

staticprotected

static void vtkLineWidget2::TranslateAction ( vtkAbstractWidget * )

staticprotected

static void vtkLineWidget2::ScaleAction ( vtkAbstractWidget * )

staticprotected

static void vtkLineWidget2::EndSelectAction ( vtkAbstractWidget * )

staticprotected

static void vtkLineWidget2::MoveAction ( vtkAbstractWidget * )

staticprotected

Member Data Documentation

int vtkLineWidget2::WidgetState

protected

Definition at line 139 of file vtkLineWidget2.h.

int vtkLineWidget2::CurrentHandle

protected

Definition at line 142 of file vtkLineWidget2.h.

vtkHandleWidget* vtkLineWidget2::Point1Widget

protected

Definition at line 152 of file vtkLineWidget2.h.

vtkHandleWidget* vtkLineWidget2::Point2Widget

protected

Definition at line 153 of file vtkLineWidget2.h.

vtkHandleWidget* vtkLineWidget2::LineHandle

protected

Definition at line 154 of file vtkLineWidget2.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/vtkLineWidget2.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation