vtkImplicitPlaneWidget Class Reference

3D widget for manipulating an infinite plane More...

#include <vtkImplicitPlaneWidget.h>

Inheritance diagram for vtkImplicitPlaneWidget:

Collaboration diagram for vtkImplicitPlaneWidget:

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)
vtkImplicitPlaneWidget *	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)
virtual void	SetOrigin (double x, double y, double z)
virtual void	SetOrigin (double x[3])
double *	GetOrigin ()
void	GetOrigin (double xyz[3])
void	SetNormal (double x, double y, double z)
void	SetNormal (double x[3])
double *	GetNormal ()
void	GetNormal (double xyz[3])
void	SetNormalToXAxis (int)
virtual int	GetNormalToXAxis ()
virtual void	NormalToXAxisOn ()
virtual void	NormalToXAxisOff ()
void	SetNormalToYAxis (int)
virtual int	GetNormalToYAxis ()
virtual void	NormalToYAxisOn ()
virtual void	NormalToYAxisOff ()
void	SetNormalToZAxis (int)
virtual int	GetNormalToZAxis ()
virtual void	NormalToZAxisOn ()
virtual void	NormalToZAxisOff ()
virtual void	SetTubing (int)
virtual int	GetTubing ()
virtual void	TubingOn ()
virtual void	TubingOff ()
void	SetDrawPlane (int plane)
virtual int	GetDrawPlane ()
virtual void	DrawPlaneOn ()
virtual void	DrawPlaneOff ()
virtual void	SetOutlineTranslation (int)
virtual int	GetOutlineTranslation ()
virtual void	OutlineTranslationOn ()
virtual void	OutlineTranslationOff ()
virtual void	SetOutsideBounds (int)
virtual int	GetOutsideBounds ()
virtual void	OutsideBoundsOn ()
virtual void	OutsideBoundsOff ()
virtual void	SetScaleEnabled (int)
virtual int	GetScaleEnabled ()
virtual void	ScaleEnabledOn ()
virtual void	ScaleEnabledOff ()
virtual void	SetOriginTranslation (int)
virtual int	GetOriginTranslation ()
virtual void	OriginTranslationOn ()
virtual void	OriginTranslationOff ()
virtual void	SetDiagonalRatio (double)
virtual double	GetDiagonalRatio ()
void	GetPolyData (vtkPolyData *pd)
vtkPolyDataAlgorithm *	GetPolyDataAlgorithm ()
void	GetPlane (vtkPlane *plane)
void	UpdatePlacement ()
virtual void	SizeHandles ()
virtual vtkProperty *	GetNormalProperty ()
virtual vtkProperty *	GetSelectedNormalProperty ()
virtual vtkProperty *	GetPlaneProperty ()
virtual vtkProperty *	GetSelectedPlaneProperty ()
virtual vtkProperty *	GetOutlineProperty ()
virtual vtkProperty *	GetSelectedOutlineProperty ()
virtual vtkProperty *	GetEdgesProperty ()
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 vtkImplicitPlaneWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkImplicitPlaneWidget *	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, MovingPlane, MovingOutline, MovingOrigin,   Scaling, Pushing, Rotating, Outside }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImplicitPlaneWidget ()
	~vtkImplicitPlaneWidget ()
void	OnLeftButtonDown ()
void	OnLeftButtonUp ()
void	OnMiddleButtonDown ()
void	OnMiddleButtonUp ()
void	OnRightButtonDown ()
void	OnRightButtonUp ()
void	OnMouseMove ()
void	UpdateRepresentation ()
void	HighlightOutline (int highlight)
virtual void	HighlightPlane (int highlight)
void	HighlightNormal (int highlight)
virtual void	RegisterPickers ()
void	ConstrainOrigin (double x[3])
void	Rotate (int X, int Y, double *p1, double *p2, double *vpn)
void	TranslatePlane (double *p1, double *p2)
void	TranslateOutline (double *p1, double *p2)
void	TranslateOrigin (double *p1, double *p2)
void	Push (double *p1, double *p2)
void	Scale (double *p1, double *p2, int X, int Y)
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
vtkPlane *	Plane
vtkImageData *	Box
vtkOutlineFilter *	Outline
vtkPolyDataMapper *	OutlineMapper
vtkActor *	OutlineActor
int	OutlineTranslation
int	ScaleEnabled
int	OutsideBounds
vtkCutter *	Cutter
vtkPolyDataMapper *	CutMapper
vtkActor *	CutActor
int	DrawPlane
vtkFeatureEdges *	Edges
vtkTubeFilter *	EdgesTuber
vtkPolyDataMapper *	EdgesMapper
vtkActor *	EdgesActor
int	Tubing
double	DiagonalRatio
vtkConeSource *	ConeSource
vtkPolyDataMapper *	ConeMapper
vtkActor *	ConeActor
vtkLineSource *	LineSource
vtkPolyDataMapper *	LineMapper
vtkActor *	LineActor
vtkConeSource *	ConeSource2
vtkPolyDataMapper *	ConeMapper2
vtkActor *	ConeActor2
vtkLineSource *	LineSource2
vtkPolyDataMapper *	LineMapper2
vtkActor *	LineActor2
vtkSphereSource *	Sphere
vtkPolyDataMapper *	SphereMapper
vtkActor *	SphereActor
int	OriginTranslation
vtkCellPicker *	Picker
vtkTransform *	Transform
vtkProperty *	NormalProperty
vtkProperty *	SelectedNormalProperty
vtkProperty *	PlaneProperty
vtkProperty *	SelectedPlaneProperty
vtkProperty *	OutlineProperty
vtkProperty *	SelectedOutlineProperty
vtkProperty *	EdgesProperty
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 an infinite plane

This 3D widget defines an infinite plane that can be interactively placed in a scene. The widget is represented by a plane with a normal vector; the plane is contained by a bounding box, and where the plane intersects the bounding box the edges are shown (possibly tubed). The normal can be selected and moved to rotate the plane; the plane itself can be selected and translated in various directions. As the plane is moved, the implicit plane function and polygon (representing the plane cut against the bounding box) is updated.

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 vtkImplicitPlaneWidget will appear. (See superclass documentation for information about changing this behavior.) If you select the normal vector, the plane can be arbitrarily rotated. The plane can be translated along the normal by selecting the plane and moving it. The plane (the plane origin) can also be arbitrary moved by selecting the plane with the middle mouse button. The right mouse button can be used to uniformly scale the bounding box (moving "up" the box scales larger; moving "down" the box scales 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 vtkImplicitPlaneWidget has several methods that can be used in conjunction with other VTK objects. The GetPolyData() method can be used to get a polygonal representation (the single polygon clipped by the bounding box). 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). (Note: there is also a PlaceWidgetEvent that is invoked when the widget is placed with PlaceWidget().)

Some additional features of this class include the ability to control the properties of the widget. You do this by setting property values on the normal vector (selected and unselected properties); the plane (selected and unselected properties); the outline (selected and unselected properties); and the edges. The edges may also be tubed or not.

See also

vtk3DWidget vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget

Events:

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

Examples:

vtkImplicitPlaneWidget (Examples)

Tests:

vtkImplicitPlaneWidget (Tests)

Definition at line 94 of file vtkImplicitPlaneWidget.h.

Member Typedef Documentation

Superclass

typedef vtkPolyDataSourceWidget vtkImplicitPlaneWidget::Superclass

Definition at line 100 of file vtkImplicitPlaneWidget.h.

Member Enumeration Documentation

WidgetState

enum vtkImplicitPlaneWidget::WidgetState

protected

Enumerator
Start
MovingPlane
MovingOutline
MovingOrigin
Scaling
Pushing
Rotating
Outside

Definition at line 255 of file vtkImplicitPlaneWidget.h.

Constructor & Destructor Documentation

vtkImplicitPlaneWidget()

vtkImplicitPlaneWidget::vtkImplicitPlaneWidget ( )

protected

~vtkImplicitPlaneWidget()

vtkImplicitPlaneWidget::~vtkImplicitPlaneWidget ( )

protected

Member Function Documentation

New()

static vtkImplicitPlaneWidget* vtkImplicitPlaneWidget::New ( )

static

Instantiate the object.

IsTypeOf()

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

static

IsA()

virtual int vtkImplicitPlaneWidget::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 vtkImplicitPlaneWidget* vtkImplicitPlaneWidget::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitPlaneWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataSourceWidget.

NewInstance()

vtkImplicitPlaneWidget* vtkImplicitPlaneWidget::NewInstance

(

)

const

PrintSelf()

void vtkImplicitPlaneWidget::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 vtkImplicitPlaneWidget::SetEnabled ( int  )

virtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

PlaceWidget() [1/3]

virtual void vtkImplicitPlaneWidget::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 vtkImplicitPlaneWidget::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 107 of file vtkImplicitPlaneWidget.h.

PlaceWidget() [3/3]

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

inlinevirtual

Reimplemented from vtk3DWidget.

Definition at line 109 of file vtkImplicitPlaneWidget.h.

SetOrigin() [1/2]

virtual void vtkImplicitPlaneWidget::SetOrigin ( double  x, double  y, double  z  )

virtual

Get the origin of the plane.

SetOrigin() [2/2]

virtual void vtkImplicitPlaneWidget::SetOrigin ( double  x[3] )

virtual

GetOrigin() [1/2]

double* vtkImplicitPlaneWidget::GetOrigin

(

)

GetOrigin() [2/2]

void vtkImplicitPlaneWidget::GetOrigin

(

double

xyz[3]

)

SetNormal() [1/2]

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

Get the normal to the plane.

SetNormal() [2/2]

void vtkImplicitPlaneWidget::SetNormal

(

double

x[3]

)

GetNormal() [1/2]

double* vtkImplicitPlaneWidget::GetNormal

(

)

GetNormal() [2/2]

void vtkImplicitPlaneWidget::GetNormal

(

double

xyz[3]

)

SetNormalToXAxis()

void vtkImplicitPlaneWidget::SetNormalToXAxis

(

int

)

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. 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 vtkImplicitPlaneWidget::GetNormalToXAxis ( )

virtual

NormalToXAxisOn()

virtual void vtkImplicitPlaneWidget::NormalToXAxisOn ( )

virtual

NormalToXAxisOff()

virtual void vtkImplicitPlaneWidget::NormalToXAxisOff ( )

virtual

SetNormalToYAxis()

void vtkImplicitPlaneWidget::SetNormalToYAxis

(

int

)

GetNormalToYAxis()

virtual int vtkImplicitPlaneWidget::GetNormalToYAxis ( )

virtual

NormalToYAxisOn()

virtual void vtkImplicitPlaneWidget::NormalToYAxisOn ( )

virtual

NormalToYAxisOff()

virtual void vtkImplicitPlaneWidget::NormalToYAxisOff ( )

virtual

SetNormalToZAxis()

void vtkImplicitPlaneWidget::SetNormalToZAxis

(

int

)

GetNormalToZAxis()

virtual int vtkImplicitPlaneWidget::GetNormalToZAxis ( )

virtual

NormalToZAxisOn()

virtual void vtkImplicitPlaneWidget::NormalToZAxisOn ( )

virtual

NormalToZAxisOff()

virtual void vtkImplicitPlaneWidget::NormalToZAxisOff ( )

virtual

SetTubing()

virtual void vtkImplicitPlaneWidget::SetTubing ( int  )

virtual

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

GetTubing()

virtual int vtkImplicitPlaneWidget::GetTubing ( )

virtual

TubingOn()

virtual void vtkImplicitPlaneWidget::TubingOn ( )

virtual

TubingOff()

virtual void vtkImplicitPlaneWidget::TubingOff ( )

virtual

SetDrawPlane()

void vtkImplicitPlaneWidget::SetDrawPlane

(

int

plane

)

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

GetDrawPlane()

virtual int vtkImplicitPlaneWidget::GetDrawPlane ( )

virtual

DrawPlaneOn()

virtual void vtkImplicitPlaneWidget::DrawPlaneOn ( )

virtual

DrawPlaneOff()

virtual void vtkImplicitPlaneWidget::DrawPlaneOff ( )

virtual

SetOutlineTranslation()

virtual void vtkImplicitPlaneWidget::SetOutlineTranslation ( int  )

virtual

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

GetOutlineTranslation()

virtual int vtkImplicitPlaneWidget::GetOutlineTranslation ( )

virtual

OutlineTranslationOn()

virtual void vtkImplicitPlaneWidget::OutlineTranslationOn ( )

virtual

OutlineTranslationOff()

virtual void vtkImplicitPlaneWidget::OutlineTranslationOff ( )

virtual

SetOutsideBounds()

virtual void vtkImplicitPlaneWidget::SetOutsideBounds ( int  )

virtual

Turn on/off the ability to move the widget outside of the input's bound

GetOutsideBounds()

virtual int vtkImplicitPlaneWidget::GetOutsideBounds ( )

virtual

OutsideBoundsOn()

virtual void vtkImplicitPlaneWidget::OutsideBoundsOn ( )

virtual

OutsideBoundsOff()

virtual void vtkImplicitPlaneWidget::OutsideBoundsOff ( )

virtual

SetScaleEnabled()

virtual void vtkImplicitPlaneWidget::SetScaleEnabled ( int  )

virtual

Turn on/off the ability to scale with the mouse

GetScaleEnabled()

virtual int vtkImplicitPlaneWidget::GetScaleEnabled ( )

virtual

ScaleEnabledOn()

virtual void vtkImplicitPlaneWidget::ScaleEnabledOn ( )

virtual

ScaleEnabledOff()

virtual void vtkImplicitPlaneWidget::ScaleEnabledOff ( )

virtual

SetOriginTranslation()

virtual void vtkImplicitPlaneWidget::SetOriginTranslation ( int  )

virtual

Turn on/off the ability to translate the origin (sphere) with the left mouse button.

GetOriginTranslation()

virtual int vtkImplicitPlaneWidget::GetOriginTranslation ( )

virtual

OriginTranslationOn()

virtual void vtkImplicitPlaneWidget::OriginTranslationOn ( )

virtual

OriginTranslationOff()

virtual void vtkImplicitPlaneWidget::OriginTranslationOff ( )

virtual

SetDiagonalRatio()

virtual void vtkImplicitPlaneWidget::SetDiagonalRatio ( double  )

virtual

By default the arrow is 30% of the diagonal length. DiagonalRatio control this ratio in the interval [0-2]

GetDiagonalRatio()

virtual double vtkImplicitPlaneWidget::GetDiagonalRatio ( )

virtual

GetPolyData()

void vtkImplicitPlaneWidget::GetPolyData

(

vtkPolyData *

pd

)

Grab the polydata that defines the plane. The polydata contains a single polygon that is clipped by the bounding box.

GetPolyDataAlgorithm()

vtkPolyDataAlgorithm* vtkImplicitPlaneWidget::GetPolyDataAlgorithm ( )

virtual

Satisfies superclass API. This returns a pointer to the underlying PolyData (which represents the plane).

Implements vtkPolyDataSourceWidget.

GetPlane()

void vtkImplicitPlaneWidget::GetPlane

(

vtkPlane *

plane

)

Get the implicit function for the plane. 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.

UpdatePlacement()

void vtkImplicitPlaneWidget::UpdatePlacement ( )

virtual

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

Implements vtkPolyDataSourceWidget.

SizeHandles()

virtual void vtkImplicitPlaneWidget::SizeHandles ( )

virtual

Control widget appearance

Reimplemented from vtk3DWidget.

GetNormalProperty()

virtual vtkProperty* vtkImplicitPlaneWidget::GetNormalProperty ( )

virtual

Get the properties on the normal (line and cone).

GetSelectedNormalProperty()

virtual vtkProperty* vtkImplicitPlaneWidget::GetSelectedNormalProperty ( )

virtual

GetPlaneProperty()

virtual vtkProperty* vtkImplicitPlaneWidget::GetPlaneProperty ( )

virtual

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

GetSelectedPlaneProperty()

virtual vtkProperty* vtkImplicitPlaneWidget::GetSelectedPlaneProperty ( )

virtual

GetOutlineProperty()

virtual vtkProperty* vtkImplicitPlaneWidget::GetOutlineProperty ( )

virtual

Get the property of the outline.

GetSelectedOutlineProperty()

virtual vtkProperty* vtkImplicitPlaneWidget::GetSelectedOutlineProperty ( )

virtual

GetEdgesProperty()

virtual vtkProperty* vtkImplicitPlaneWidget::GetEdgesProperty ( )

virtual

Get the property of the intersection edges. (This property also applies to the edges when tubed.)

ProcessEvents()

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

staticprotected

OnLeftButtonDown()

void vtkImplicitPlaneWidget::OnLeftButtonDown ( )

protected

OnLeftButtonUp()

void vtkImplicitPlaneWidget::OnLeftButtonUp ( )

protected

OnMiddleButtonDown()

void vtkImplicitPlaneWidget::OnMiddleButtonDown ( )

protected

OnMiddleButtonUp()

void vtkImplicitPlaneWidget::OnMiddleButtonUp ( )

protected

OnRightButtonDown()

void vtkImplicitPlaneWidget::OnRightButtonDown ( )

protected

OnRightButtonUp()

void vtkImplicitPlaneWidget::OnRightButtonUp ( )

protected

OnMouseMove()

void vtkImplicitPlaneWidget::OnMouseMove ( )

protected

UpdateRepresentation()

void vtkImplicitPlaneWidget::UpdateRepresentation ( )

protected

HighlightOutline()

void vtkImplicitPlaneWidget::HighlightOutline ( int  highlight )

protected

HighlightPlane()

virtual void vtkImplicitPlaneWidget::HighlightPlane ( int  highlight )

protectedvirtual

HighlightNormal()

void vtkImplicitPlaneWidget::HighlightNormal ( int  highlight )

protected

RegisterPickers()

virtual void vtkImplicitPlaneWidget::RegisterPickers ( )

protectedvirtual

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

Reimplemented from vtkInteractorObserver.

ConstrainOrigin()

void vtkImplicitPlaneWidget::ConstrainOrigin ( double  x[3] )

protected

Rotate()

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

protected

TranslatePlane()

void vtkImplicitPlaneWidget::TranslatePlane ( double *  p1, double *  p2  )

protected

TranslateOutline()

void vtkImplicitPlaneWidget::TranslateOutline ( double *  p1, double *  p2  )

protected

TranslateOrigin()

void vtkImplicitPlaneWidget::TranslateOrigin ( double *  p1, double *  p2  )

protected

Push()

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

protected

Scale()

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

protected

CreateDefaultProperties()

void vtkImplicitPlaneWidget::CreateDefaultProperties ( )

protected

GeneratePlane()

void vtkImplicitPlaneWidget::GeneratePlane ( )

protected

Member Data Documentation

State

int vtkImplicitPlaneWidget::State

protected

Definition at line 254 of file vtkImplicitPlaneWidget.h.

NormalToXAxis

int vtkImplicitPlaneWidget::NormalToXAxis

protected

Definition at line 282 of file vtkImplicitPlaneWidget.h.

NormalToYAxis

int vtkImplicitPlaneWidget::NormalToYAxis

protected

Definition at line 283 of file vtkImplicitPlaneWidget.h.

NormalToZAxis

int vtkImplicitPlaneWidget::NormalToZAxis

protected

Definition at line 284 of file vtkImplicitPlaneWidget.h.

Plane

vtkPlane* vtkImplicitPlaneWidget::Plane

protected

Definition at line 288 of file vtkImplicitPlaneWidget.h.

Box

vtkImageData* vtkImplicitPlaneWidget::Box

protected

Definition at line 291 of file vtkImplicitPlaneWidget.h.

Outline

vtkOutlineFilter* vtkImplicitPlaneWidget::Outline

protected

Definition at line 292 of file vtkImplicitPlaneWidget.h.

OutlineMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::OutlineMapper

protected

Definition at line 293 of file vtkImplicitPlaneWidget.h.

OutlineActor

vtkActor* vtkImplicitPlaneWidget::OutlineActor

protected

Definition at line 294 of file vtkImplicitPlaneWidget.h.

OutlineTranslation

int vtkImplicitPlaneWidget::OutlineTranslation

protected

Definition at line 296 of file vtkImplicitPlaneWidget.h.

ScaleEnabled

int vtkImplicitPlaneWidget::ScaleEnabled

protected

Definition at line 297 of file vtkImplicitPlaneWidget.h.

OutsideBounds

int vtkImplicitPlaneWidget::OutsideBounds

protected

Definition at line 298 of file vtkImplicitPlaneWidget.h.

Cutter

vtkCutter* vtkImplicitPlaneWidget::Cutter

protected

Definition at line 301 of file vtkImplicitPlaneWidget.h.

CutMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::CutMapper

protected

Definition at line 302 of file vtkImplicitPlaneWidget.h.

CutActor

vtkActor* vtkImplicitPlaneWidget::CutActor

protected

Definition at line 303 of file vtkImplicitPlaneWidget.h.

DrawPlane

int vtkImplicitPlaneWidget::DrawPlane

protected

Definition at line 304 of file vtkImplicitPlaneWidget.h.

Edges

vtkFeatureEdges* vtkImplicitPlaneWidget::Edges

protected

Definition at line 308 of file vtkImplicitPlaneWidget.h.

EdgesTuber

vtkTubeFilter* vtkImplicitPlaneWidget::EdgesTuber

protected

Definition at line 309 of file vtkImplicitPlaneWidget.h.

EdgesMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::EdgesMapper

protected

Definition at line 310 of file vtkImplicitPlaneWidget.h.

EdgesActor

vtkActor* vtkImplicitPlaneWidget::EdgesActor

protected

Definition at line 311 of file vtkImplicitPlaneWidget.h.

Tubing

int vtkImplicitPlaneWidget::Tubing

protected

Definition at line 312 of file vtkImplicitPlaneWidget.h.

DiagonalRatio

double vtkImplicitPlaneWidget::DiagonalRatio

protected

Definition at line 315 of file vtkImplicitPlaneWidget.h.

ConeSource

vtkConeSource* vtkImplicitPlaneWidget::ConeSource

protected

Definition at line 318 of file vtkImplicitPlaneWidget.h.

ConeMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::ConeMapper

protected

Definition at line 319 of file vtkImplicitPlaneWidget.h.

ConeActor

vtkActor* vtkImplicitPlaneWidget::ConeActor

protected

Definition at line 320 of file vtkImplicitPlaneWidget.h.

LineSource

vtkLineSource* vtkImplicitPlaneWidget::LineSource

protected

Definition at line 324 of file vtkImplicitPlaneWidget.h.

LineMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::LineMapper

protected

Definition at line 325 of file vtkImplicitPlaneWidget.h.

LineActor

vtkActor* vtkImplicitPlaneWidget::LineActor

protected

Definition at line 326 of file vtkImplicitPlaneWidget.h.

ConeSource2

vtkConeSource* vtkImplicitPlaneWidget::ConeSource2

protected

Definition at line 329 of file vtkImplicitPlaneWidget.h.

ConeMapper2

vtkPolyDataMapper* vtkImplicitPlaneWidget::ConeMapper2

protected

Definition at line 330 of file vtkImplicitPlaneWidget.h.

ConeActor2

vtkActor* vtkImplicitPlaneWidget::ConeActor2

protected

Definition at line 331 of file vtkImplicitPlaneWidget.h.

LineSource2

vtkLineSource* vtkImplicitPlaneWidget::LineSource2

protected

Definition at line 334 of file vtkImplicitPlaneWidget.h.

LineMapper2

vtkPolyDataMapper* vtkImplicitPlaneWidget::LineMapper2

protected

Definition at line 335 of file vtkImplicitPlaneWidget.h.

LineActor2

vtkActor* vtkImplicitPlaneWidget::LineActor2

protected

Definition at line 336 of file vtkImplicitPlaneWidget.h.

Sphere

vtkSphereSource* vtkImplicitPlaneWidget::Sphere

protected

Definition at line 339 of file vtkImplicitPlaneWidget.h.

SphereMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::SphereMapper

protected

Definition at line 340 of file vtkImplicitPlaneWidget.h.

SphereActor

vtkActor* vtkImplicitPlaneWidget::SphereActor

protected

Definition at line 341 of file vtkImplicitPlaneWidget.h.

OriginTranslation

int vtkImplicitPlaneWidget::OriginTranslation

protected

Definition at line 342 of file vtkImplicitPlaneWidget.h.

Picker

vtkCellPicker* vtkImplicitPlaneWidget::Picker

protected

Definition at line 345 of file vtkImplicitPlaneWidget.h.

Transform

vtkTransform* vtkImplicitPlaneWidget::Transform

protected

Definition at line 351 of file vtkImplicitPlaneWidget.h.

NormalProperty

vtkProperty* vtkImplicitPlaneWidget::NormalProperty

protected

Definition at line 364 of file vtkImplicitPlaneWidget.h.

SelectedNormalProperty

vtkProperty* vtkImplicitPlaneWidget::SelectedNormalProperty

protected

Definition at line 365 of file vtkImplicitPlaneWidget.h.

PlaneProperty

vtkProperty* vtkImplicitPlaneWidget::PlaneProperty

protected

Definition at line 366 of file vtkImplicitPlaneWidget.h.

SelectedPlaneProperty

vtkProperty* vtkImplicitPlaneWidget::SelectedPlaneProperty

protected

Definition at line 367 of file vtkImplicitPlaneWidget.h.

OutlineProperty

vtkProperty* vtkImplicitPlaneWidget::OutlineProperty

protected

Definition at line 368 of file vtkImplicitPlaneWidget.h.

SelectedOutlineProperty

vtkProperty* vtkImplicitPlaneWidget::SelectedOutlineProperty

protected

Definition at line 369 of file vtkImplicitPlaneWidget.h.

EdgesProperty

vtkProperty* vtkImplicitPlaneWidget::EdgesProperty

protected

Definition at line 370 of file vtkImplicitPlaneWidget.h.

---

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

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