3D widget for manipulating a line More...

#include <vtkLineWidget.h>

Inheritance diagram for vtkLineWidget:

Collaboration diagram for vtkLineWidget:

Public Types
typedef vtk3DWidget	Superclass

Public Types inherited from vtk3DWidget
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkLineWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	GetPolyData (vtkPolyData *pd)


virtual void	SetEnabled (int)

virtual void	PlaceWidget (double bounds[6])

void	PlaceWidget ()

void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)


void	SetResolution (int r)

int	GetResolution ()


void	SetPoint1 (double x, double y, double z)

void	SetPoint1 (double x[3])

double *	GetPoint1 ()

void	GetPoint1 (double xyz[3])


void	SetPoint2 (double x, double y, double z)

void	SetPoint2 (double x[3])

double *	GetPoint2 ()

void	GetPoint2 (double xyz[3])


virtual void	SetAlign (int)

virtual int	GetAlign ()

void	SetAlignToXAxis ()

void	SetAlignToYAxis ()

void	SetAlignToZAxis ()

void	SetAlignToNone ()


virtual void	SetClampToBounds (int)

virtual int	GetClampToBounds ()

virtual void	ClampToBoundsOn ()

virtual void	ClampToBoundsOff ()


virtual vtkProperty *	GetHandleProperty ()

virtual vtkProperty *	GetSelectedHandleProperty ()


virtual vtkProperty *	GetLineProperty ()

virtual vtkProperty *	GetSelectedLineProperty ()

Public Member Functions inherited from vtk3DWidget
vtk3DWidget *	NewInstance () const

virtual void	SetProp3D (vtkProp3D *)

virtual vtkProp3D *	GetProp3D ()

virtual void	SetInputData (vtkDataSet *)

virtual void	SetInputConnection (vtkAlgorithmOutput *)

virtual vtkDataSet *	GetInput ()

virtual void	SetPlaceFactor (double)

virtual double	GetPlaceFactor ()

virtual void	SetHandleSize (double)

virtual double	GetHandleSize ()

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 void	SetPriority (float)

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 vtkLineWidget *	New ()

static int	IsTypeOf (const char *type)

static vtkLineWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtk3DWidget
static int	IsTypeOf (const char *type)

static vtk3DWidget *	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, MovingHandle, MovingLine, Scaling, Outside }

enum	AlignmentState { XAxis, YAxis, ZAxis, None }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkLineWidget ()

	~vtkLineWidget ()

void	OnLeftButtonDown ()

void	OnLeftButtonUp ()

void	OnMiddleButtonDown ()

void	OnMiddleButtonUp ()

void	OnRightButtonDown ()

void	OnRightButtonUp ()

virtual void	OnMouseMove ()

void	HighlightLine (int highlight)

void	BuildRepresentation ()

virtual void	SizeHandles ()

void	HandlesOn (double length)

void	HandlesOff ()

int	HighlightHandle (vtkProp *prop)

void	HighlightHandles (int highlight)

void	SetLinePosition (double x[3])

virtual void	RegisterPickers ()

void	Scale (double p1, double p2, int X, int Y)

void	ClampPosition (double x[3])

int	InBounds (double x[3])

void	CreateDefaultProperties ()

void	GenerateLine ()

void	EnablePointWidget ()

void	DisablePointWidget ()

int	ForwardEvent (unsigned long event)

Protected Member Functions inherited from vtk3DWidget
	vtk3DWidget ()

	~vtk3DWidget ()

void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])

double	SizeHandles (double factor)

void	UpdateInput ()

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver ()

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	ProcessEvents (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	State

int	Align

vtkActor *	LineActor

vtkPolyDataMapper *	LineMapper

vtkLineSource *	LineSource

vtkActor **	Handle

vtkPolyDataMapper **	HandleMapper

vtkSphereSource **	HandleGeometry

vtkCellPicker *	HandlePicker

vtkCellPicker *	LinePicker

vtkActor *	CurrentHandle

double	LastPosition [3]

int	ClampToBounds

vtkProperty *	HandleProperty

vtkProperty *	SelectedHandleProperty

vtkProperty *	LineProperty

vtkProperty *	SelectedLineProperty

vtkPointWidget *	PointWidget

vtkPointWidget *	PointWidget1

vtkPointWidget *	PointWidget2

vtkPWCallback *	PWCallback

vtkPW1Callback *	PW1Callback

vtkPW2Callback *	PW2Callback

vtkPointWidget *	CurrentPointWidget

Protected Attributes inherited from vtk3DWidget
vtkProp3D *	Prop3D

vtk3DWidgetConnection *	ConnectionHolder

double	PlaceFactor

int	Placed

double	InitialBounds [6]

double	InitialLength

double	HandleSize

int	ValidPick

double	LastPickPosition [3]

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	vtkPWCallback

Detailed Description

3D widget for manipulating a line

This 3D widget defines a line that can be interactively placed in a scene. The line has two handles (at its endpoints), plus the line can be picked to translate it in the scene. A nice feature of the object is that the vtkLineWidget, like any 3D widget, will work with the current interactor style and any other widgets present in the scene. That is, if vtkLineWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkLineWidget will terminate the processing of the event that it handles.

To use this object, just invoke SetInteractor() with the argument of the method a vtkRenderWindowInteractor. You may also wish to invoke "PlaceWidget()" to initially position the widget. The interactor will act normally until the "i" key (for "interactor") is pressed, at which point the vtkLineWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing one of the two end point handles (use the left mouse button), the line can be oriented and stretched (the other end point remains fixed). By grabbing the line itself, or using the middle mouse button, the entire line can be translated. Scaling (about the center of the line) is achieved by using the right mouse button. By moving the mouse "up" the render window the line will be made bigger; by moving "down" the render window the widget will be made smaller. Turn off the widget by pressing the "i" key again (or invoke the Off() method). (Note: picking the line or either one of the two end point handles causes a vtkPointWidget to appear. This widget has the ability to constrain motion to an axis by pressing the "shift" key while moving the mouse.)

The vtkLineWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the line; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding streamlines. Typical usage of the widget is to make use of the StartInteractionEvent, InteractionEvent, and EndInteractionEvent events. The InteractionEvent is called on mouse motion; the other two events are called on button down and button up (either left or right button).

Some additional features of this class include the ability to control the properties of the widget. You can set the properties of the selected and unselected representations of the line. For example, you can set the property for the handles and line. In addition there are methods to constrain the line so that it is aligned along the x-y-z axes.

See also: vtk3DWidget vtkBoxWidget vtkPlaneWidget

Events:: vtkCommand::DisableEvent vtkCommand::EndInteractionEvent vtkCommand::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EnableEvent

Examples:: vtkLineWidget (Examples)

Tests:: vtkLineWidget (Tests)

Definition at line 95 of file vtkLineWidget.h.

Member Typedef Documentation

typedef vtk3DWidget vtkLineWidget::Superclass

Definition at line 101 of file vtkLineWidget.h.

Member Enumeration Documentation

enum vtkLineWidget::WidgetState

protected

Enumerator
Start
MovingHandle
MovingLine
Scaling
Outside

Definition at line 198 of file vtkLineWidget.h.

enum vtkLineWidget::AlignmentState

protected

Enumerator
XAxis
YAxis
ZAxis
None

Definition at line 225 of file vtkLineWidget.h.

Constructor & Destructor Documentation

vtkLineWidget::vtkLineWidget ( )

protected

vtkLineWidget::~vtkLineWidget ( )

protected

Member Function Documentation

static vtkLineWidget* vtkLineWidget::New ( )

static

Instantiate the object.

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

static

virtual int vtkLineWidget::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtk3DWidget.

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

static

virtual vtkObjectBase* vtkLineWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtk3DWidget.

vtkLineWidget* vtkLineWidget::NewInstance ( ) const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtk3DWidget.

virtual void vtkLineWidget::SetEnabled ( int )

virtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

virtual void vtkLineWidget::PlaceWidget ( double bounds[6] )

virtual

Methods that satisfy the superclass' API.

Implements vtk3DWidget.

void vtkLineWidget::PlaceWidget ( )

inlinevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 108 of file vtkLineWidget.h.

void vtkLineWidget::PlaceWidget	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)

inlinevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 110 of file vtkLineWidget.h.

void vtkLineWidget::SetResolution ( int r )

inline

Set/Get the resolution (number of subdivisions) of the line.

Definition at line 117 of file vtkLineWidget.h.

int vtkLineWidget::GetResolution ( )

inline

Set/Get the resolution (number of subdivisions) of the line.

Definition at line 119 of file vtkLineWidget.h.

void vtkLineWidget::SetPoint1	(	double	x,
		double	y,
		double	z
	)

Set/Get the position of first end point.

void vtkLineWidget::SetPoint1 ( double x[3] )

inline

Set/Get the position of first end point.

Definition at line 126 of file vtkLineWidget.h.

double* vtkLineWidget::GetPoint1 ( )

inline

Set/Get the position of first end point.

Definition at line 128 of file vtkLineWidget.h.

void vtkLineWidget::GetPoint1 ( double xyz[3] )

inline

Set/Get the position of first end point.

Definition at line 130 of file vtkLineWidget.h.

void vtkLineWidget::SetPoint2	(	double	x,
		double	y,
		double	z
	)

Set position of other end point.

void vtkLineWidget::SetPoint2 ( double x[3] )

inline

Set position of other end point.

Definition at line 137 of file vtkLineWidget.h.

double* vtkLineWidget::GetPoint2 ( )

inline

Set position of other end point.

Definition at line 139 of file vtkLineWidget.h.

void vtkLineWidget::GetPoint2 ( double xyz[3] )

inline

Set position of other end point.

Definition at line 141 of file vtkLineWidget.h.

virtual void vtkLineWidget::SetAlign ( int )

virtual