vtkPlaneWidget Class Reference

#include <vtkPlaneWidget.h>

Inheritance diagram for vtkPlaneWidget:

[legend]

Collaboration diagram for vtkPlaneWidget:

[legend]

List of all members.

Detailed Description

3D widget for manipulating a finite plane

This 3D widget defines a finite (bounded) plane that can be interactively placed in a scene. The plane has four handles (at its corner vertices), a normal vector, and the plane itself. The handles are used to resize the plane; the normal vector to rotate it, and the plane can be picked and translated. Selecting the plane while pressing CTRL makes it spin around the normal. A nice feature of the object is that the vtkPlaneWidget, like any 3D widget, will work with the current interactor style. That is, if vtkPlaneWidget does not handle an event, then all other registered observers (including the interactor style) have an opportunity to process the event. Otherwise, the vtkPlaneWidget 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. If the "i" key (for "interactor") is pressed, the vtkPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) By grabbing the one of the four handles (use the left mouse button), the plane can be resized. By grabbing the plane itself, the entire plane can be arbitrarily translated. Pressing CTRL while grabbing the plane will spin the plane around the normal. If you select the normal vector, the plane can be arbitrarily rotated. Selecting any part of the widget with the middle mouse button enables translation of the plane along its normal. (Once selected using middle mouse, moving the mouse in the direction of the normal translates the plane in the direction of the normal; moving in the direction opposite the normal translates the plane in the direction opposite the normal.) Scaling (about the center of the plane) is achieved by using the right mouse button. By moving the mouse "up" the render window the plane will be made bigger; by moving "down" the render window the widget will be made smaller. Events that occur outside of the widget (i.e., no part of the widget is picked) are propagated to any other registered obsevers (such as the interaction style). Turn off the widget by pressing the "i" key again (or invoke the Off() method).

The vtkPlaneWidget has several methods that can be used in conjunction with other VTK objects. The Set/GetResolution() methods control the number of subdivisions of the plane; the GetPolyData() method can be used to get the polygonal representation and can be used for things like seeding stream lines. GetPlane() can be used to update a vtkPlane implicit function. 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 plane. For example, you can set the property for the handles and plane. In addition there are methods to constrain the plane so that it is perpendicular to the x-y-z axes.

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

See also:: vtk3DWidget vtkBoxWidget vtkLineWidget vtkSphereWidget vtkImplicitPlaneWidget

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

Tests:: vtkPlaneWidget (Tests)

Definition at line 108 of file vtkPlaneWidget.h.


Public Types
typedef vtkPolyDataSourceWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	GetPolyData (vtkPolyData *pd)
void	GetPlane (vtkPlane *plane)
vtkPolyDataAlgorithm *	GetPolyDataAlgorithm ()
void	UpdatePlacement (void)

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	SetOrigin (double x, double y, double z)
void	SetOrigin (double x[3])
double *	GetOrigin ()
void	GetOrigin (double xyz[3])

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

void	SetCenter (double x, double y, double z)
void	SetCenter (double x[3])
double *	GetCenter ()
void	GetCenter (double xyz[3])

void	SetNormal (double x, double y, double z)
void	SetNormal (double x[3])
double *	GetNormal ()
void	GetNormal (double xyz[3])

virtual void	SetRepresentation (int)
virtual int	GetRepresentation ()
void	SetRepresentationToOff ()
void	SetRepresentationToOutline ()
void	SetRepresentationToWireframe ()
void	SetRepresentationToSurface ()

virtual void	SetNormalToXAxis (int)
virtual int	GetNormalToXAxis ()
virtual void	NormalToXAxisOn ()
virtual void	NormalToXAxisOff ()
virtual void	SetNormalToYAxis (int)
virtual int	GetNormalToYAxis ()
virtual void	NormalToYAxisOn ()
virtual void	NormalToYAxisOff ()
virtual void	SetNormalToZAxis (int)
virtual int	GetNormalToZAxis ()
virtual void	NormalToZAxisOn ()
virtual void	NormalToZAxisOff ()

virtual vtkProperty *	GetHandleProperty ()
virtual vtkProperty *	GetSelectedHandleProperty ()

virtual void	SetPlaneProperty (vtkProperty *)
virtual vtkProperty *	GetPlaneProperty ()
virtual vtkProperty *	GetSelectedPlaneProperty ()
Static Public Member Functions
static vtkPlaneWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkPlaneWidget *	SafeDownCast (vtkObject *o)
Protected Types
enum	WidgetState { Start = 0, Moving, Scaling, Pushing, Rotating, Spinning, Outside }
Protected Member Functions
	vtkPlaneWidget ()
	~vtkPlaneWidget ()
void	OnLeftButtonDown ()
void	OnLeftButtonUp ()
void	OnMiddleButtonDown ()
void	OnMiddleButtonUp ()
void	OnRightButtonDown ()
void	OnRightButtonUp ()
void	OnMouseMove ()
void	SelectRepresentation ()
void	HighlightPlane (int highlight)
void	PositionHandles ()
void	HandlesOn (double length)
void	HandlesOff ()
int	HighlightHandle (vtkProp *prop)
virtual void	SizeHandles ()
void	HighlightNormal (int highlight)
void	MoveOrigin (double p1, double p2)
void	MovePoint1 (double p1, double p2)
void	MovePoint2 (double p1, double p2)
void	MovePoint3 (double p1, double p2)
void	Rotate (int X, int Y, double p1, double p2, double *vpn)
void	Spin (double p1, double p2)
void	Scale (double p1, double p2, int X, int Y)
void	Translate (double p1, double p2)
void	Push (double p1, double p2)
void	CreateDefaultProperties ()
void	GeneratePlane ()
Static Protected Member Functions
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
Protected Attributes
int	State
int	NormalToXAxis
int	NormalToYAxis
int	NormalToZAxis
int	Representation
vtkActor *	PlaneActor
vtkPolyDataMapper *	PlaneMapper
vtkPlaneSource *	PlaneSource
vtkPolyData *	PlaneOutline
vtkActor **	Handle
vtkPolyDataMapper **	HandleMapper
vtkSphereSource **	HandleGeometry
vtkActor *	ConeActor
vtkPolyDataMapper *	ConeMapper
vtkConeSource *	ConeSource
vtkActor *	LineActor
vtkPolyDataMapper *	LineMapper
vtkLineSource *	LineSource
vtkActor *	ConeActor2
vtkPolyDataMapper *	ConeMapper2
vtkConeSource *	ConeSource2
vtkActor *	LineActor2
vtkPolyDataMapper *	LineMapper2
vtkLineSource *	LineSource2
vtkCellPicker *	HandlePicker
vtkCellPicker *	PlanePicker
vtkActor *	CurrentHandle
double	Normal [3]
vtkTransform *	Transform
vtkProperty *	HandleProperty
vtkProperty *	SelectedHandleProperty
vtkProperty *	PlaneProperty
vtkProperty *	SelectedPlaneProperty
int	LastPickValid
double	HandleSizeFactor

Member Typedef Documentation

typedef vtkPolyDataSourceWidget vtkPlaneWidget::Superclass

Reimplemented from vtkPolyDataSourceWidget.

Definition at line 114 of file vtkPlaneWidget.h.

Member Enumeration Documentation

enum vtkPlaneWidget::WidgetState [protected]

Enumerator:

Start
Moving
Scaling
Pushing
Rotating
Spinning
Outside

Definition at line 259 of file vtkPlaneWidget.h.

Constructor & Destructor Documentation

vtkPlaneWidget::vtkPlaneWidget ( ) [protected]

vtkPlaneWidget::~vtkPlaneWidget ( ) [protected]

Member Function Documentation

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

Instantiate the object.

Reimplemented from vtkObject.

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

Reimplemented from vtkPolyDataSourceWidget.

static int vtkPlaneWidget::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSourceWidget.

virtual int vtkPlaneWidget::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSourceWidget.

static vtkPlaneWidget* vtkPlaneWidget::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataSourceWidget.

void vtkPlaneWidget::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 vtkPolyDataSourceWidget.

virtual void vtkPlaneWidget::SetEnabled ( int ) [virtual]

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

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

Methods that satisfy the superclass' API.

Implements vtkPolyDataSourceWidget.

void vtkPlaneWidget::PlaceWidget ( ) [inline, virtual]

Methods that satisfy the superclass' API.

Reimplemented from vtkPolyDataSourceWidget.

Definition at line 121 of file vtkPlaneWidget.h.

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

Methods that satisfy the superclass' API.

Reimplemented from vtkPolyDataSourceWidget.

Definition at line 123 of file vtkPlaneWidget.h.

void vtkPlaneWidget::SetResolution ( int r )

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

int vtkPlaneWidget::GetResolution ( )

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

void vtkPlaneWidget::SetOrigin	(	double	x,
		double	y,
		double	z
	)

Set/Get the origin of the plane.

void vtkPlaneWidget::SetOrigin ( double x[3] )

Set/Get the origin of the plane.

double* vtkPlaneWidget::GetOrigin ( )

Set/Get the origin of the plane.

void vtkPlaneWidget::GetOrigin ( double xyz[3] )

Set/Get the origin of the plane.

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

Set/Get the position of the point defining the first axis of the plane.

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

Set/Get the position of the point defining the first axis of the plane.

double* vtkPlaneWidget::GetPoint1 ( )

Set/Get the position of the point defining the first axis of the plane.

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

Set/Get the position of the point defining the first axis of the plane.

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

Set/Get the position of the point defining the second axis of the plane.

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

Set/Get the position of the point defining the second axis of the plane.

double* vtkPlaneWidget::GetPoint2 ( )

Set/Get the position of the point defining the second axis of the plane.

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

Set/Get the position of the point defining the second axis of the plane.

void vtkPlaneWidget::SetCenter	(	double	x,
		double	y,
		double	z
	)

Get the center of the plane.

void vtkPlaneWidget::SetCenter ( double x[3] )

Get the center of the plane.

double* vtkPlaneWidget::GetCenter ( )

Get the center of the plane.

void vtkPlaneWidget::GetCenter ( double xyz[3] )

Get the center of the plane.

void vtkPlaneWidget::SetNormal	(	double	x,
		double	y,
		double	z
	)

Get the normal to the plane.

void vtkPlaneWidget::SetNormal ( double x[3] )

Get the normal to the plane.

double* vtkPlaneWidget::GetNormal ( )

Get the normal to the plane.

void vtkPlaneWidget::GetNormal ( double xyz[3] )

Get the normal to the plane.

virtual void vtkPlaneWidget::SetRepresentation ( int ) [virtual]

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

virtual int vtkPlaneWidget::GetRepresentation ( ) [virtual]

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

void vtkPlaneWidget::SetRepresentationToOff ( ) [inline]

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

Definition at line 184 of file vtkPlaneWidget.h.

void vtkPlaneWidget::SetRepresentationToOutline ( ) [inline]

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

Definition at line 186 of file vtkPlaneWidget.h.

void vtkPlaneWidget::SetRepresentationToWireframe ( ) [inline]

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

Definition at line 188 of file vtkPlaneWidget.h.

void vtkPlaneWidget::SetRepresentationToSurface ( ) [inline]

Control how the plane appears when GetPolyData() is invoked. If the mode is "outline", then just the outline of the plane is shown. If the mode is "wireframe" then the plane is drawn with the outline plus the interior mesh (corresponding to the resolution specified). If the mode is "surface" then the plane is drawn as a surface.

Definition at line 190 of file vtkPlaneWidget.h.

virtual void vtkPlaneWidget::SetNormalToXAxis ( int ) [virtual]