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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkImplicitPlaneWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	GetPolyData (vtkPolyData *pd)
	Grab the polydata that defines the plane. More...

vtkPolyDataAlgorithm *	GetPolyDataAlgorithm () override
	Satisfies superclass API. More...

void	GetPlane (vtkPlane *plane)
	Get the implicit function for the plane. More...

void	UpdatePlacement () override
	Satisfies the superclass API. More...

void	SizeHandles () override
	Control widget appearance. More...


void	SetEnabled (int) override
	Methods that satisfy the superclass' API. More...

void	PlaceWidget (double bounds[6]) override
	Methods that satisfy the superclass' API. More...

void	PlaceWidget () override
	Methods that satisfy the superclass' API. More...

void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
	Methods that satisfy the superclass' API. More...


virtual void	SetOrigin (double x, double y, double z)
	Get the origin of the plane. More...

virtual void	SetOrigin (double x[3])
	Get the origin of the plane. More...

double *	GetOrigin ()
	Get the origin of the plane. More...

void	GetOrigin (double xyz[3])
	Get the origin of the plane. More...


void	SetNormal (double x, double y, double z)
	Get the normal to the plane. More...

void	SetNormal (double n[3])
	Get the normal to the plane. More...

double *	GetNormal ()
	Get the normal to the plane. More...

void	GetNormal (double xyz[3])
	Get the normal to the plane. More...


void	SetNormalToXAxis (vtkTypeBool)
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual vtkTypeBool	GetNormalToXAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToXAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToXAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

void	SetNormalToYAxis (vtkTypeBool)
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual vtkTypeBool	GetNormalToYAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToYAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToYAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

void	SetNormalToZAxis (vtkTypeBool)
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual vtkTypeBool	GetNormalToZAxis ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToZAxisOn ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...

virtual void	NormalToZAxisOff ()
	Force the plane widget to be aligned with one of the x-y-z axes. More...


virtual void	SetTubing (vtkTypeBool)
	Turn on/off tubing of the wire outline of the plane. More...

virtual vtkTypeBool	GetTubing ()
	Turn on/off tubing of the wire outline of the plane. More...

virtual void	TubingOn ()
	Turn on/off tubing of the wire outline of the plane. More...

virtual void	TubingOff ()
	Turn on/off tubing of the wire outline of the plane. More...


void	SetDrawPlane (vtkTypeBool plane)
	Enable/disable the drawing of the plane. More...

virtual vtkTypeBool	GetDrawPlane ()
	Enable/disable the drawing of the plane. More...

virtual void	DrawPlaneOn ()
	Enable/disable the drawing of the plane. More...

virtual void	DrawPlaneOff ()
	Enable/disable the drawing of the plane. More...


virtual void	SetOutlineTranslation (vtkTypeBool)
	Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...

virtual vtkTypeBool	GetOutlineTranslation ()
	Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...

virtual void	OutlineTranslationOn ()
	Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...

virtual void	OutlineTranslationOff ()
	Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button. More...


virtual void	SetOutsideBounds (vtkTypeBool)
	Turn on/off the ability to move the widget outside of the input's bound. More...

virtual vtkTypeBool	GetOutsideBounds ()
	Turn on/off the ability to move the widget outside of the input's bound. More...

virtual void	OutsideBoundsOn ()
	Turn on/off the ability to move the widget outside of the input's bound. More...

virtual void	OutsideBoundsOff ()
	Turn on/off the ability to move the widget outside of the input's bound. More...


virtual void	SetScaleEnabled (vtkTypeBool)
	Turn on/off the ability to scale with the mouse. More...

virtual vtkTypeBool	GetScaleEnabled ()
	Turn on/off the ability to scale with the mouse. More...

virtual void	ScaleEnabledOn ()
	Turn on/off the ability to scale with the mouse. More...

virtual void	ScaleEnabledOff ()
	Turn on/off the ability to scale with the mouse. More...


virtual void	SetOriginTranslation (vtkTypeBool)
	Turn on/off the ability to translate the origin (sphere) with the left mouse button. More...

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

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

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


virtual void	SetDiagonalRatio (double)
	By default the arrow is 30% of the diagonal length. More...

virtual double	GetDiagonalRatio ()
	By default the arrow is 30% of the diagonal length. More...


virtual vtkProperty *	GetNormalProperty ()
	Get the properties on the normal (line and cone). More...

virtual vtkProperty *	GetSelectedNormalProperty ()
	Get the properties on the normal (line and cone). More...


virtual vtkProperty *	GetPlaneProperty ()
	Get the plane properties. More...

virtual vtkProperty *	GetSelectedPlaneProperty ()
	Get the plane properties. More...


virtual vtkProperty *	GetOutlineProperty ()
	Get the property of the outline. More...

virtual vtkProperty *	GetSelectedOutlineProperty ()
	Get the property of the outline. More...


virtual vtkProperty *	GetEdgesProperty ()
	Get the property of the intersection edges. More...

Public Member Functions inherited from vtkPolyDataSourceWidget
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkPolyDataSourceWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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

void	PlaceWidget (double bounds[6]) override=0
	We have to redeclare this abstract, PlaceWidget() requires it. More...

void	PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
	Convenience method brought over from vtkPlaneWidget. More...

virtual vtkPolyDataAlgorithm *	GetPolyDataAlgorithm ()=0
	Returns underlying vtkPolyDataAlgorithm that determines geometry. More...

virtual void	UpdatePlacement ()=0
	If you've made changes to the underlying vtkPolyDataSource AFTER your initial call to PlaceWidget(), use this method to realise the changes in the widget. More...

Public Member Functions inherited from vtk3DWidget
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtk3DWidget *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	SetProp3D (vtkProp3D *)
	Specify a vtkProp3D around which to place the widget. More...

virtual vtkProp3D *	GetProp3D ()
	Specify a vtkProp3D around which to place the widget. More...

virtual void	SetInputData (vtkDataSet *)
	Specify the input dataset. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *)
	Specify the input dataset. More...

virtual vtkDataSet *	GetInput ()
	Specify the input dataset. More...

virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget. More...

virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget. More...

Public Member Functions inherited from vtkInteractorObserver
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	SetEnabled (int)
	Methods for turning the interactor observer on and off, and determining its state. More...

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	OnChar ()
	Sets up the keypress-i event. More...

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
	This method is used to associate the widget with the render window interactor. More...

virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor. More...

virtual void	SetPriority (float)
	Set/Get the priority at which events are processed. More...

virtual float	GetPriority ()
	Set/Get the priority at which events are processed. More...

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking. More...

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual vtkTypeBool	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...

virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer. More...

virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer. More...

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer. More...

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer. More...

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...

void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkImplicitPlaneWidget *	New ()
	Instantiate the object. More...

static vtkTypeBool	IsTypeOf (const char *type)

static vtkImplicitPlaneWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkPolyDataSourceWidget
static vtkTypeBool	IsTypeOf (const char *type)

static vtkPolyDataSourceWidget *	SafeDownCast (vtkObjectBase *o)

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

static vtk3DWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes. More...

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Types
enum	WidgetState { Start = 0 , MovingPlane , MovingOutline , MovingOrigin , Scaling , Pushing , Rotating , Outside }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImplicitPlaneWidget ()

	~vtkImplicitPlaneWidget () override

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)

void	RegisterPickers () override
	Register internal Pickers in the Picking Manager. More...

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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPolyDataSourceWidget ()
	Empty constructor that calls the parent constructor. More...

Protected Member Functions inherited from vtk3DWidget
virtual vtkObjectBase *	NewInstanceInternal () const

	vtk3DWidget ()

	~vtk3DWidget () override

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

double	SizeHandles (double factor)

virtual void	SizeHandles ()

void	UpdateInput ()

Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong. More...

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
	Utility routines used to start and end interaction. More...

virtual void	EndInteraction ()
	Utility routines used to start and end interaction. More...

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses. More...

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

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)
	Handles the char widget activation event. More...

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
int	State

vtkTypeBool	NormalToXAxis

vtkTypeBool	NormalToYAxis

vtkTypeBool	NormalToZAxis

vtkPlane *	Plane

vtkImageData *	Box

vtkOutlineFilter *	Outline

vtkPolyDataMapper *	OutlineMapper

vtkActor *	OutlineActor

vtkTypeBool	OutlineTranslation

vtkTypeBool	ScaleEnabled

vtkTypeBool	OutsideBounds

vtkCutter *	Cutter

vtkPolyDataMapper *	CutMapper

vtkActor *	CutActor

vtkTypeBool	DrawPlane

vtkFeatureEdges *	Edges

vtkTubeFilter *	EdgesTuber

vtkPolyDataMapper *	EdgesMapper

vtkActor *	EdgesActor

vtkTypeBool	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

vtkTypeBool	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

vtkTypeBool	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
std::atomic< int32_t >	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

Definition at line 86 of file vtkImplicitPlaneWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataSourceWidget vtkImplicitPlaneWidget::Superclass

Definition at line 94 of file vtkImplicitPlaneWidget.h.

Member Enumeration Documentation

◆ WidgetState

enum vtkImplicitPlaneWidget::WidgetState

protected

Enumerator
Start
MovingPlane
MovingOutline
MovingOrigin
Scaling
Pushing
Rotating
Outside

Definition at line 289 of file vtkImplicitPlaneWidget.h.

Constructor & Destructor Documentation

◆ vtkImplicitPlaneWidget()

vtkImplicitPlaneWidget::vtkImplicitPlaneWidget ( )

protected

◆ ~vtkImplicitPlaneWidget()

vtkImplicitPlaneWidget::~vtkImplicitPlaneWidget ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkImplicitPlaneWidget * vtkImplicitPlaneWidget::New ( )

static

Instantiate the object.

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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
	)

overridevirtual

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

void vtkImplicitPlaneWidget::SetEnabled ( int )

overridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtkInteractorObserver.

◆ PlaceWidget() [1/3]

void vtkImplicitPlaneWidget::PlaceWidget ( double bounds[6] )

overridevirtual

Methods that satisfy the superclass' API.

Implements vtkPolyDataSourceWidget.

◆ PlaceWidget() [2/3]

void vtkImplicitPlaneWidget::PlaceWidget ( )

inlineoverridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 103 of file vtkImplicitPlaneWidget.h.

◆ PlaceWidget() [3/3]

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

inlineoverridevirtual

Methods that satisfy the superclass' API.

Reimplemented from vtk3DWidget.

Definition at line 104 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

Get the origin of the plane.

◆ GetOrigin() [1/2]

double * vtkImplicitPlaneWidget::GetOrigin ( )

Get the origin of the plane.

◆ GetOrigin() [2/2]

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

Get the origin of the plane.

◆ 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 n[3] )

Get the normal to the plane.

◆ GetNormal() [1/2]

double * vtkImplicitPlaneWidget::GetNormal ( )

Get the normal to the plane.

◆ GetNormal() [2/2]

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

Get the normal to the plane.