vtkLineWidget Class Reference

#include <vtkLineWidget.h>

Inheritance diagram for vtkLineWidget:

[legend]

Collaboration diagram for vtkLineWidget:

[legend]

List of all members.

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.

Warning:: Note that handles and line can be picked even when they are "behind" other actors. This is an intended feature and not a bug.

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 98 of file vtkLineWidget.h.


Public Types
typedef vtk3DWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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 ()
Static Public Member Functions
static vtkLineWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkLineWidget *	SafeDownCast (vtkObject *o)
Protected Types
enum	WidgetState { Start = 0, MovingHandle, MovingLine, Scaling, Outside }
enum	AlignmentState { XAxis, YAxis, ZAxis, None }
Protected Member Functions
	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])
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)
Static Protected Member Functions
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
Friends
class	vtkPWCallback

Member Typedef Documentation

typedef vtk3DWidget vtkLineWidget::Superclass

Reimplemented from vtk3DWidget.

Definition at line 104 of file vtkLineWidget.h.

Member Enumeration Documentation

enum vtkLineWidget::WidgetState [protected]

Enumerator:

Start
MovingHandle
MovingLine
Scaling
Outside

Definition at line 201 of file vtkLineWidget.h.

enum vtkLineWidget::AlignmentState [protected]

Enumerator:

XAxis
YAxis
ZAxis
None

Definition at line 230 of file vtkLineWidget.h.

Constructor & Destructor Documentation

vtkLineWidget::vtkLineWidget ( ) [protected]

vtkLineWidget::~vtkLineWidget ( ) [protected]

Member Function Documentation

static vtkLineWidget* vtkLineWidget::New ( ) [static]

Instantiate the object.

Reimplemented from vtkObject.

virtual const char* vtkLineWidget::GetClassName ( ) [virtual]

Reimplemented from vtk3DWidget.

static int vtkLineWidget::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

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

Reimplemented from vtk3DWidget.

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 ( ) [inline, virtual]

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 111 of file vtkLineWidget.h.

void vtkLineWidget::PlaceWidget	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)			`[inline, virtual]`

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 113 of file vtkLineWidget.h.

void vtkLineWidget::SetResolution ( int r ) [inline]

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

Definition at line 120 of file vtkLineWidget.h.

int vtkLineWidget::GetResolution ( ) [inline]

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

Definition at line 122 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 129 of file vtkLineWidget.h.

double* vtkLineWidget::GetPoint1 ( ) [inline]

Set/Get the position of first end point.

Definition at line 131 of file vtkLineWidget.h.

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

Set/Get the position of first end point.

Definition at line 133 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 140 of file vtkLineWidget.h.

double* vtkLineWidget::GetPoint2 ( ) [inline]

Set position of other end point.

Definition at line 142 of file vtkLineWidget.h.

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

Set position of other end point.

Definition at line 144 of file vtkLineWidget.h.

virtual void vtkLineWidget::SetAlign ( int ) [virtual]