vtkPlaneWidget Class Reference

3D widget for manipulating a finite plane More...

#include <vtkPlaneWidget.h>

Inheritance diagram for vtkPlaneWidget:

Collaboration diagram for vtkPlaneWidget:

Public Types
typedef vtkPolyDataSourceWidget	Superclass
Public Types inherited from vtkPolyDataSourceWidget
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)
vtkPlaneWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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 ()
void	GetPolyData (vtkPolyData *pd)
void	GetPlane (vtkPlane *plane)
vtkPolyDataAlgorithm *	GetPolyDataAlgorithm ()
void	UpdatePlacement (void)
virtual vtkProperty *	GetHandleProperty ()
virtual vtkProperty *	GetSelectedHandleProperty ()
virtual void	SetPlaneProperty (vtkProperty *)
virtual vtkProperty *	GetPlaneProperty ()
virtual vtkProperty *	GetSelectedPlaneProperty ()
Public Member Functions inherited from vtkPolyDataSourceWidget
vtkPolyDataSourceWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
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)
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 *)
virtual void	OnChar ()
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	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
int	GetReferenceCount ()
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPlaneWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkPlaneWidget *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPolyDataSourceWidget
static int	IsTypeOf (const char *type)
static vtkPolyDataSourceWidget *	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, Moving, Scaling, Pushing,   Rotating, Spinning, Outside }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	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)
virtual void	RegisterPickers ()
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 ()
Protected Member Functions inherited from vtkPolyDataSourceWidget
	vtkPolyDataSourceWidget ()
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 ()
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])
void	UnRegisterPickers ()
virtual void	PickersModified ()
vtkPickingManager *	GetPickingManager ()
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
int	RequestCursorShape (int requestedShape)
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	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
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

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.

See also

vtk3DWidget vtkBoxWidget vtkLineWidget vtkSphereWidget vtkImplicitPlaneWidget

Events:

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

Examples:

vtkPlaneWidget (Examples)

Tests:

vtkPlaneWidget (Tests)

Definition at line 108 of file vtkPlaneWidget.h.

Member Typedef Documentation

Superclass

typedef vtkPolyDataSourceWidget vtkPlaneWidget::Superclass

Definition at line 114 of file vtkPlaneWidget.h.

Member Enumeration Documentation

WidgetState

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::vtkPlaneWidget ( )

protected

~vtkPlaneWidget()

vtkPlaneWidget::~vtkPlaneWidget ( )

protected

Member Function Documentation

New()

static vtkPlaneWidget* vtkPlaneWidget::New ( )

static

Instantiate the object.

IsTypeOf()

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

static

IsA()

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSourceWidget.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase* vtkPlaneWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataSourceWidget.

NewInstance()

vtkPlaneWidget* vtkPlaneWidget::NewInstance

(

)

const

PrintSelf()

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 vtk3DWidget.

SetEnabled()

virtual void vtkPlaneWidget::SetEnabled ( int  )

virtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

PlaceWidget() [1/3]

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

virtual

We have to redeclare this abstract, PlaceWidget() requires it. You HAVE to override this in your concrete child classes. If there's no Prop3D and no Input, your PlaceWidget must make use of the underlying PolyDataSource to do its work.

Implements vtkPolyDataSourceWidget.

PlaceWidget() [2/3]

void vtkPlaneWidget::PlaceWidget ( )

inlinevirtual

Overrides vtk3DWidget PlaceWidget() so that it doesn't complain if there's no Input and no Prop3D.

Reimplemented from vtkPolyDataSourceWidget.

Definition at line 121 of file vtkPlaneWidget.h.

PlaceWidget() [3/3]

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

inlinevirtual

Reimplemented from vtk3DWidget.

Definition at line 123 of file vtkPlaneWidget.h.

SetResolution()

void vtkPlaneWidget::SetResolution

(

int

r

)

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

GetResolution()

int vtkPlaneWidget::GetResolution

(

)

SetOrigin() [1/2]

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

Set/Get the origin of the plane.

SetOrigin() [2/2]

void vtkPlaneWidget::SetOrigin

(

double

x[3]

)

GetOrigin() [1/2]

double* vtkPlaneWidget::GetOrigin

(

)

GetOrigin() [2/2]

void vtkPlaneWidget::GetOrigin

(

double

xyz[3]

)

SetPoint1() [1/2]

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

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

SetPoint1() [2/2]

void vtkPlaneWidget::SetPoint1

(

double

x[3]

)

GetPoint1() [1/2]

double* vtkPlaneWidget::GetPoint1

(

)

GetPoint1() [2/2]

void vtkPlaneWidget::GetPoint1

(

double

xyz[3]

)

SetPoint2() [1/2]

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

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

SetPoint2() [2/2]

void vtkPlaneWidget::SetPoint2

(

double

x[3]

)

GetPoint2() [1/2]

double* vtkPlaneWidget::GetPoint2

(

)

GetPoint2() [2/2]

void vtkPlaneWidget::GetPoint2

(

double

xyz[3]

)

SetCenter() [1/2]

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

Get the center of the plane.

SetCenter() [2/2]

void vtkPlaneWidget::SetCenter

(

double

x[3]

)

GetCenter() [1/2]

double* vtkPlaneWidget::GetCenter

(

)

GetCenter() [2/2]

void vtkPlaneWidget::GetCenter

(

double

xyz[3]

)

SetNormal() [1/2]

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

Get the normal to the plane.

SetNormal() [2/2]

void vtkPlaneWidget::SetNormal

(

double

x[3]

)

GetNormal() [1/2]

double* vtkPlaneWidget::GetNormal

(

)

GetNormal() [2/2]

void vtkPlaneWidget::GetNormal

(

double

xyz[3]

)

SetRepresentation()

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.

GetRepresentation()

virtual int vtkPlaneWidget::GetRepresentation ( )

virtual

SetRepresentationToOff()

void vtkPlaneWidget::SetRepresentationToOff ( )

inline

Definition at line 184 of file vtkPlaneWidget.h.

SetRepresentationToOutline()

void vtkPlaneWidget::SetRepresentationToOutline ( )

inline

Definition at line 186 of file vtkPlaneWidget.h.

SetRepresentationToWireframe()

void vtkPlaneWidget::SetRepresentationToWireframe ( )

inline

Definition at line 188 of file vtkPlaneWidget.h.

SetRepresentationToSurface()

void vtkPlaneWidget::SetRepresentationToSurface ( )

inline

Definition at line 190 of file vtkPlaneWidget.h.

SetNormalToXAxis()

virtual void vtkPlaneWidget::SetNormalToXAxis ( int  )

virtual

Force the plane widget to be aligned with one of the x-y-z axes. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

GetNormalToXAxis()

virtual int vtkPlaneWidget::GetNormalToXAxis ( )

virtual

NormalToXAxisOn()

virtual void vtkPlaneWidget::NormalToXAxisOn ( )

virtual

NormalToXAxisOff()

virtual void vtkPlaneWidget::NormalToXAxisOff ( )

virtual

SetNormalToYAxis()

virtual void vtkPlaneWidget::SetNormalToYAxis ( int  )

virtual

GetNormalToYAxis()

virtual int vtkPlaneWidget::GetNormalToYAxis ( )

virtual

NormalToYAxisOn()

virtual void vtkPlaneWidget::NormalToYAxisOn ( )

virtual

NormalToYAxisOff()

virtual void vtkPlaneWidget::NormalToYAxisOff ( )

virtual

SetNormalToZAxis()

virtual void vtkPlaneWidget::SetNormalToZAxis ( int  )

virtual

GetNormalToZAxis()

virtual int vtkPlaneWidget::GetNormalToZAxis ( )

virtual

NormalToZAxisOn()

virtual void vtkPlaneWidget::NormalToZAxisOn ( )

virtual

NormalToZAxisOff()

virtual void vtkPlaneWidget::NormalToZAxisOff ( )

virtual

GetPolyData()

void vtkPlaneWidget::GetPolyData

(

vtkPolyData *

pd

)

Grab the polydata (including points) that defines the plane. The polydata consists of (res+1)*(res+1) points, and res*res quadrilateral polygons, where res is the resolution of the plane. These point values are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and polyplane are added to it.

GetPlane()

void vtkPlaneWidget::GetPlane

(

vtkPlane *

plane

)

Get the planes describing the implicit function defined by the plane widget. The user must provide the instance of the class vtkPlane. Note that vtkPlane is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data.

GetPolyDataAlgorithm()

vtkPolyDataAlgorithm* vtkPlaneWidget::GetPolyDataAlgorithm ( )

virtual

Satisfies superclass API. This returns a pointer to the underlying PolyData. Make changes to this before calling the initial PlaceWidget() to have the initial placement follow suit. Or, make changes after the widget has been initialised and call UpdatePlacement() to realise.

Implements vtkPolyDataSourceWidget.

UpdatePlacement()

void vtkPlaneWidget::UpdatePlacement ( void  )

virtual

Satisfies superclass API. This will change the state of the widget to match changes that have been made to the underlying PolyDataSource

Implements vtkPolyDataSourceWidget.

GetHandleProperty()

virtual vtkProperty* vtkPlaneWidget::GetHandleProperty ( )

virtual

Get the handle properties (the little balls are the handles). The properties of the handles when selected and normal can be manipulated.

GetSelectedHandleProperty()

virtual vtkProperty* vtkPlaneWidget::GetSelectedHandleProperty ( )

virtual

SetPlaneProperty()

virtual void vtkPlaneWidget::SetPlaneProperty ( vtkProperty *  )

virtual

Get the plane properties. The properties of the plane when selected and unselected can be manipulated.

GetPlaneProperty()

virtual vtkProperty* vtkPlaneWidget::GetPlaneProperty ( )

virtual

GetSelectedPlaneProperty()

virtual vtkProperty* vtkPlaneWidget::GetSelectedPlaneProperty ( )

virtual

ProcessEvents()

static void vtkPlaneWidget::ProcessEvents ( vtkObject *  object, unsigned long  event, void *  clientdata, void *  calldata  )

staticprotected

OnLeftButtonDown()

void vtkPlaneWidget::OnLeftButtonDown ( )

protected

OnLeftButtonUp()

void vtkPlaneWidget::OnLeftButtonUp ( )

protected

OnMiddleButtonDown()

void vtkPlaneWidget::OnMiddleButtonDown ( )

protected

OnMiddleButtonUp()

void vtkPlaneWidget::OnMiddleButtonUp ( )

protected

OnRightButtonDown()

void vtkPlaneWidget::OnRightButtonDown ( )

protected

OnRightButtonUp()

void vtkPlaneWidget::OnRightButtonUp ( )

protected

OnMouseMove()

void vtkPlaneWidget::OnMouseMove ( )

protected

SelectRepresentation()

void vtkPlaneWidget::SelectRepresentation ( )

protected

HighlightPlane()

void vtkPlaneWidget::HighlightPlane ( int  highlight )

protected

PositionHandles()

void vtkPlaneWidget::PositionHandles ( )

protected

HandlesOn()

void vtkPlaneWidget::HandlesOn ( double  length )

protected

HandlesOff()

void vtkPlaneWidget::HandlesOff ( )

protected

HighlightHandle()

int vtkPlaneWidget::HighlightHandle ( vtkProp *  prop )

protected

SizeHandles()

virtual void vtkPlaneWidget::SizeHandles ( )

protectedvirtual

Reimplemented from vtk3DWidget.

HighlightNormal()

void vtkPlaneWidget::HighlightNormal ( int  highlight )

protected

RegisterPickers()

virtual void vtkPlaneWidget::RegisterPickers ( )

protectedvirtual

Register internal Pickers in the Picking Manager. Must be reimplemented by concrete widgets to register their pickers.

Reimplemented from vtkInteractorObserver.

MoveOrigin()

void vtkPlaneWidget::MoveOrigin ( double *  p1, double *  p2  )

protected

MovePoint1()

void vtkPlaneWidget::MovePoint1 ( double *  p1, double *  p2  )

protected

MovePoint2()

void vtkPlaneWidget::MovePoint2 ( double *  p1, double *  p2  )

protected

MovePoint3()

void vtkPlaneWidget::MovePoint3 ( double *  p1, double *  p2  )

protected

Rotate()

void vtkPlaneWidget::Rotate ( int  X, int  Y, double *  p1, double *  p2, double *  vpn  )

protected

Spin()

void vtkPlaneWidget::Spin ( double *  p1, double *  p2  )

protected

Scale()

void vtkPlaneWidget::Scale ( double *  p1, double *  p2, int  X, int  Y  )

protected

Translate()

void vtkPlaneWidget::Translate ( double *  p1, double *  p2  )

protected

Push()

void vtkPlaneWidget::Push ( double *  p1, double *  p2  )

protected

CreateDefaultProperties()

void vtkPlaneWidget::CreateDefaultProperties ( )

protected

GeneratePlane()

void vtkPlaneWidget::GeneratePlane ( )

protected

Member Data Documentation

State

int vtkPlaneWidget::State

protected

Definition at line 258 of file vtkPlaneWidget.h.

NormalToXAxis

int vtkPlaneWidget::NormalToXAxis

protected

Definition at line 287 of file vtkPlaneWidget.h.

NormalToYAxis

int vtkPlaneWidget::NormalToYAxis

protected

Definition at line 288 of file vtkPlaneWidget.h.

NormalToZAxis

int vtkPlaneWidget::NormalToZAxis

protected

Definition at line 289 of file vtkPlaneWidget.h.

Representation

int vtkPlaneWidget::Representation

protected

Definition at line 290 of file vtkPlaneWidget.h.

PlaneActor

vtkActor* vtkPlaneWidget::PlaneActor

protected

Definition at line 294 of file vtkPlaneWidget.h.

PlaneMapper

vtkPolyDataMapper* vtkPlaneWidget::PlaneMapper

protected

Definition at line 295 of file vtkPlaneWidget.h.

PlaneSource

vtkPlaneSource* vtkPlaneWidget::PlaneSource

protected

Definition at line 296 of file vtkPlaneWidget.h.

PlaneOutline

vtkPolyData* vtkPlaneWidget::PlaneOutline

protected

Definition at line 297 of file vtkPlaneWidget.h.

Handle

vtkActor** vtkPlaneWidget::Handle

protected

Definition at line 301 of file vtkPlaneWidget.h.

HandleMapper

vtkPolyDataMapper** vtkPlaneWidget::HandleMapper

protected

Definition at line 302 of file vtkPlaneWidget.h.

HandleGeometry

vtkSphereSource** vtkPlaneWidget::HandleGeometry

protected

Definition at line 303 of file vtkPlaneWidget.h.

ConeActor

vtkActor* vtkPlaneWidget::ConeActor

protected

Definition at line 311 of file vtkPlaneWidget.h.

ConeMapper

vtkPolyDataMapper* vtkPlaneWidget::ConeMapper

protected

Definition at line 312 of file vtkPlaneWidget.h.

ConeSource

vtkConeSource* vtkPlaneWidget::ConeSource

protected

Definition at line 313 of file vtkPlaneWidget.h.

LineActor

vtkActor* vtkPlaneWidget::LineActor

protected

Definition at line 317 of file vtkPlaneWidget.h.

LineMapper

vtkPolyDataMapper* vtkPlaneWidget::LineMapper

protected

Definition at line 318 of file vtkPlaneWidget.h.

LineSource

vtkLineSource* vtkPlaneWidget::LineSource

protected

Definition at line 319 of file vtkPlaneWidget.h.

ConeActor2

vtkActor* vtkPlaneWidget::ConeActor2

protected

Definition at line 322 of file vtkPlaneWidget.h.

ConeMapper2

vtkPolyDataMapper* vtkPlaneWidget::ConeMapper2

protected

Definition at line 323 of file vtkPlaneWidget.h.

ConeSource2

vtkConeSource* vtkPlaneWidget::ConeSource2

protected

Definition at line 324 of file vtkPlaneWidget.h.

LineActor2

vtkActor* vtkPlaneWidget::LineActor2

protected

Definition at line 327 of file vtkPlaneWidget.h.

LineMapper2

vtkPolyDataMapper* vtkPlaneWidget::LineMapper2

protected

Definition at line 328 of file vtkPlaneWidget.h.

LineSource2

vtkLineSource* vtkPlaneWidget::LineSource2

protected

Definition at line 329 of file vtkPlaneWidget.h.

HandlePicker

vtkCellPicker* vtkPlaneWidget::HandlePicker

protected

Definition at line 332 of file vtkPlaneWidget.h.

PlanePicker

vtkCellPicker* vtkPlaneWidget::PlanePicker

protected

Definition at line 333 of file vtkPlaneWidget.h.

CurrentHandle

vtkActor* vtkPlaneWidget::CurrentHandle

protected

Definition at line 334 of file vtkPlaneWidget.h.

Normal

double vtkPlaneWidget::Normal[3]

protected

Definition at line 351 of file vtkPlaneWidget.h.

Transform

vtkTransform* vtkPlaneWidget::Transform

protected

Definition at line 354 of file vtkPlaneWidget.h.

HandleProperty

vtkProperty* vtkPlaneWidget::HandleProperty

protected

Definition at line 358 of file vtkPlaneWidget.h.

SelectedHandleProperty

vtkProperty* vtkPlaneWidget::SelectedHandleProperty

protected

Definition at line 359 of file vtkPlaneWidget.h.

PlaneProperty

vtkProperty* vtkPlaneWidget::PlaneProperty

protected

Definition at line 360 of file vtkPlaneWidget.h.

SelectedPlaneProperty

vtkProperty* vtkPlaneWidget::SelectedPlaneProperty

protected

Definition at line 361 of file vtkPlaneWidget.h.

LastPickValid

int vtkPlaneWidget::LastPickValid

protected

Definition at line 366 of file vtkPlaneWidget.h.

HandleSizeFactor

double vtkPlaneWidget::HandleSizeFactor

protected

Definition at line 367 of file vtkPlaneWidget.h.

---

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

• dox/opt/build/vtk6-6.3.0+dfsg2/Interaction/Widgets/vtkPlaneWidget.h