VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkImplicitPlaneWidget Class Reference

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

#include <vtkImplicitPlaneWidget.h>

Inheritance diagram for vtkImplicitPlaneWidget:
[legend]
Collaboration diagram for vtkImplicitPlaneWidget:
[legend]

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...
 
vtkImplicitPlaneWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetEnabled (int) override
 Methods that satisfy the superclass' API. More...
 
void PlaceWidget (double bounds[6]) override
 We have to redeclare this abstract, PlaceWidget() requires it. More...
 
void PlaceWidget () override
 
void PlaceWidget (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
 
virtual void SetOrigin (double x, double y, double z)
 Get the origin of the plane. More...
 
virtual void SetOrigin (double x[3])
 
doubleGetOrigin ()
 
void GetOrigin (double xyz[3])
 
void SetNormal (double x, double y, double z)
 Get the normal to the plane. More...
 
void SetNormal (double x[3])
 
doubleGetNormal ()
 
void GetNormal (double xyz[3])
 
void SetNormalToXAxis (vtkTypeBool)
 Force the plane widget to be aligned with one of the x-y-z axes. More...
 
virtual vtkTypeBool GetNormalToXAxis ()
 
virtual void NormalToXAxisOn ()
 
virtual void NormalToXAxisOff ()
 
void SetNormalToYAxis (vtkTypeBool)
 
virtual vtkTypeBool GetNormalToYAxis ()
 
virtual void NormalToYAxisOn ()
 
virtual void NormalToYAxisOff ()
 
void SetNormalToZAxis (vtkTypeBool)
 
virtual vtkTypeBool GetNormalToZAxis ()
 
virtual void NormalToZAxisOn ()
 
virtual void NormalToZAxisOff ()
 
virtual void SetTubing (vtkTypeBool)
 Turn on/off tubing of the wire outline of the plane. More...
 
virtual vtkTypeBool GetTubing ()
 
virtual void TubingOn ()
 
virtual void TubingOff ()
 
void SetDrawPlane (vtkTypeBool plane)
 Enable/disable the drawing of the plane. More...
 
virtual vtkTypeBool GetDrawPlane ()
 
virtual void DrawPlaneOn ()
 
virtual void DrawPlaneOff ()
 
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 ()
 
virtual void OutlineTranslationOn ()
 
virtual void OutlineTranslationOff ()
 
virtual void SetOutsideBounds (vtkTypeBool)
 Turn on/off the ability to move the widget outside of the input's bound. More...
 
virtual vtkTypeBool GetOutsideBounds ()
 
virtual void OutsideBoundsOn ()
 
virtual void OutsideBoundsOff ()
 
virtual void SetScaleEnabled (vtkTypeBool)
 Turn on/off the ability to scale with the mouse. More...
 
virtual vtkTypeBool GetScaleEnabled ()
 
virtual void ScaleEnabledOn ()
 
virtual void ScaleEnabledOff ()
 
virtual void SetOriginTranslation (vtkTypeBool)
 Turn on/off the ability to translate the origin (sphere) with the left mouse button. More...
 
virtual vtkTypeBool GetOriginTranslation ()
 
virtual void OriginTranslationOn ()
 
virtual void OriginTranslationOff ()
 
virtual void SetDiagonalRatio (double)
 By default the arrow is 30% of the diagonal length. More...
 
virtual double GetDiagonalRatio ()
 
void GetPolyData (vtkPolyData *pd)
 Grab the polydata that defines the plane. More...
 
vtkPolyDataAlgorithmGetPolyDataAlgorithm () 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...
 
virtual vtkPropertyGetNormalProperty ()
 Get the properties on the normal (line and cone). More...
 
virtual vtkPropertyGetSelectedNormalProperty ()
 
virtual vtkPropertyGetPlaneProperty ()
 Get the plane properties. More...
 
virtual vtkPropertyGetSelectedPlaneProperty ()
 
virtual vtkPropertyGetOutlineProperty ()
 Get the property of the outline. More...
 
virtual vtkPropertyGetSelectedOutlineProperty ()
 
virtual vtkPropertyGetEdgesProperty ()
 Get the property of the intersection edges. More...
 
- Public Member Functions inherited from vtkPolyDataSourceWidget
vtkPolyDataSourceWidgetNewInstance () 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 xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
 Convenience method brought over from vtkPlaneWidget. More...
 
- Public Member Functions inherited from vtk3DWidget
vtk3DWidgetNewInstance () const
 
virtual void SetProp3D (vtkProp3D *)
 Specify a vtkProp3D around which to place the widget. More...
 
virtual vtkProp3DGetProp3D ()
 
virtual void SetInputData (vtkDataSet *)
 Specify the input dataset. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *)
 
virtual vtkDataSetGetInput ()
 
virtual void SetPlaceFactor (double)
 Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...
 
virtual double GetPlaceFactor ()
 
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 ()
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 
virtual void SetPriority (float)
 Set/Get the priority at which events are processed. More...
 
virtual float GetPriority ()
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool GetKeyPressActivation ()
 
virtual void KeyPressActivationOn ()
 
virtual void KeyPressActivationOff ()
 
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 ()
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 
virtual void OnChar ()
 Sets up the keypress-i event. 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 ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImplicitPlaneWidgetNew ()
 Instantiate the object. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitPlaneWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataSourceWidget
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataSourceWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtk3DWidget
static vtkTypeBool IsTypeOf (const char *type)
 
static vtk3DWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorObserver
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (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])
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Types

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

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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
 vtkPolyDataSourceWidget ()
 Empty constructor that calls the parent constructor. More...
 
- Protected Member Functions inherited from vtk3DWidget
 vtk3DWidget ()
 
 ~vtk3DWidget () override
 
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 () override
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 
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])
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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)
 
- 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 ()
 
- 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)
 Handles the char widget activation event. More...
 

Protected Attributes

int State
 
vtkTypeBool NormalToXAxis
 
vtkTypeBool NormalToYAxis
 
vtkTypeBool NormalToZAxis
 
vtkPlanePlane
 
vtkImageDataBox
 
vtkOutlineFilterOutline
 
vtkPolyDataMapperOutlineMapper
 
vtkActorOutlineActor
 
vtkTypeBool OutlineTranslation
 
vtkTypeBool ScaleEnabled
 
vtkTypeBool OutsideBounds
 
vtkCutterCutter
 
vtkPolyDataMapperCutMapper
 
vtkActorCutActor
 
vtkTypeBool DrawPlane
 
vtkFeatureEdgesEdges
 
vtkTubeFilterEdgesTuber
 
vtkPolyDataMapperEdgesMapper
 
vtkActorEdgesActor
 
vtkTypeBool Tubing
 
double DiagonalRatio
 
vtkConeSourceConeSource
 
vtkPolyDataMapperConeMapper
 
vtkActorConeActor
 
vtkLineSourceLineSource
 
vtkPolyDataMapperLineMapper
 
vtkActorLineActor
 
vtkConeSourceConeSource2
 
vtkPolyDataMapperConeMapper2
 
vtkActorConeActor2
 
vtkLineSourceLineSource2
 
vtkPolyDataMapperLineMapper2
 
vtkActorLineActor2
 
vtkSphereSourceSphere
 
vtkPolyDataMapperSphereMapper
 
vtkActorSphereActor
 
vtkTypeBool OriginTranslation
 
vtkCellPickerPicker
 
vtkTransformTransform
 
vtkPropertyNormalProperty
 
vtkPropertySelectedNormalProperty
 
vtkPropertyPlaneProperty
 
vtkPropertySelectedPlaneProperty
 
vtkPropertyOutlineProperty
 
vtkPropertySelectedOutlineProperty
 
vtkPropertyEdgesProperty
 
- Protected Attributes inherited from vtk3DWidget
vtkProp3DProp3D
 
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
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- 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
Examples:
vtkImplicitPlaneWidget (Examples)
Tests:
vtkImplicitPlaneWidget (Tests)

Definition at line 92 of file vtkImplicitPlaneWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 100 of file vtkImplicitPlaneWidget.h.

Member Enumeration Documentation

◆ WidgetState

Enumerator
Start 
MovingPlane 
MovingOutline 
MovingOrigin 
Scaling 
Pushing 
Rotating 
Outside 

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

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

Reimplemented from vtk3DWidget.

Definition at line 109 of file vtkImplicitPlaneWidget.h.

◆ PlaceWidget() [3/3]

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

Reimplemented from vtk3DWidget.

Definition at line 111 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 ( vtkTypeBool  )

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 vtkTypeBool vtkImplicitPlaneWidget::GetNormalToXAxis ( )
virtual

◆ NormalToXAxisOn()

virtual void vtkImplicitPlaneWidget::NormalToXAxisOn ( )
virtual

◆ NormalToXAxisOff()

virtual void vtkImplicitPlaneWidget::NormalToXAxisOff ( )
virtual

◆ SetNormalToYAxis()

void vtkImplicitPlaneWidget::SetNormalToYAxis ( vtkTypeBool  )

◆ GetNormalToYAxis()

virtual vtkTypeBool vtkImplicitPlaneWidget::GetNormalToYAxis ( )
virtual

◆ NormalToYAxisOn()

virtual void vtkImplicitPlaneWidget::NormalToYAxisOn ( )
virtual

◆ NormalToYAxisOff()

virtual void vtkImplicitPlaneWidget::NormalToYAxisOff ( )
virtual

◆ SetNormalToZAxis()

void vtkImplicitPlaneWidget::SetNormalToZAxis ( vtkTypeBool  )

◆ GetNormalToZAxis()

virtual vtkTypeBool vtkImplicitPlaneWidget::GetNormalToZAxis ( )
virtual

◆ NormalToZAxisOn()

virtual void vtkImplicitPlaneWidget::NormalToZAxisOn ( )
virtual

◆ NormalToZAxisOff()

virtual void vtkImplicitPlaneWidget::NormalToZAxisOff ( )
virtual

◆ SetTubing()

virtual void vtkImplicitPlaneWidget::SetTubing ( vtkTypeBool  )
virtual

Turn on/off tubing of the wire outline of the plane.

The tube thickens the line by wrapping with a vtkTubeFilter.

◆ GetTubing()

virtual vtkTypeBool vtkImplicitPlaneWidget::GetTubing ( )
virtual

◆ TubingOn()

virtual void vtkImplicitPlaneWidget::TubingOn ( )
virtual

◆ TubingOff()

virtual void vtkImplicitPlaneWidget::TubingOff ( )
virtual

◆ SetDrawPlane()

void vtkImplicitPlaneWidget::SetDrawPlane ( vtkTypeBool  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 vtkTypeBool vtkImplicitPlaneWidget::GetDrawPlane ( )
virtual

◆ DrawPlaneOn()

virtual void vtkImplicitPlaneWidget::DrawPlaneOn ( )
virtual

◆ DrawPlaneOff()

virtual void vtkImplicitPlaneWidget::DrawPlaneOff ( )
virtual

◆ SetOutlineTranslation()

virtual void vtkImplicitPlaneWidget::SetOutlineTranslation ( vtkTypeBool  )
virtual

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

◆ GetOutlineTranslation()

virtual vtkTypeBool vtkImplicitPlaneWidget::GetOutlineTranslation ( )
virtual

◆ OutlineTranslationOn()

virtual void vtkImplicitPlaneWidget::OutlineTranslationOn ( )
virtual

◆ OutlineTranslationOff()

virtual void vtkImplicitPlaneWidget::OutlineTranslationOff ( )
virtual

◆ SetOutsideBounds()

virtual void vtkImplicitPlaneWidget::SetOutsideBounds ( vtkTypeBool  )
virtual

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

◆ GetOutsideBounds()

virtual vtkTypeBool vtkImplicitPlaneWidget::GetOutsideBounds ( )
virtual

◆ OutsideBoundsOn()

virtual void vtkImplicitPlaneWidget::OutsideBoundsOn ( )
virtual

◆ OutsideBoundsOff()

virtual void vtkImplicitPlaneWidget::OutsideBoundsOff ( )
virtual

◆ SetScaleEnabled()

virtual void vtkImplicitPlaneWidget::SetScaleEnabled ( vtkTypeBool  )
virtual

Turn on/off the ability to scale with the mouse.

◆ GetScaleEnabled()

virtual vtkTypeBool vtkImplicitPlaneWidget::GetScaleEnabled ( )
virtual

◆ ScaleEnabledOn()

virtual void vtkImplicitPlaneWidget::ScaleEnabledOn ( )
virtual

◆ ScaleEnabledOff()

virtual void vtkImplicitPlaneWidget::ScaleEnabledOff ( )
virtual

◆ SetOriginTranslation()

virtual void vtkImplicitPlaneWidget::SetOriginTranslation ( vtkTypeBool  )
virtual

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

◆ GetOriginTranslation()

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

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

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

void vtkImplicitPlaneWidget::SizeHandles ( )
overridevirtual

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

void vtkImplicitPlaneWidget::RegisterPickers ( )
overrideprotectedvirtual

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 293 of file vtkImplicitPlaneWidget.h.

◆ NormalToXAxis

vtkTypeBool vtkImplicitPlaneWidget::NormalToXAxis
protected

Definition at line 320 of file vtkImplicitPlaneWidget.h.

◆ NormalToYAxis

vtkTypeBool vtkImplicitPlaneWidget::NormalToYAxis
protected

Definition at line 321 of file vtkImplicitPlaneWidget.h.

◆ NormalToZAxis

vtkTypeBool vtkImplicitPlaneWidget::NormalToZAxis
protected

Definition at line 322 of file vtkImplicitPlaneWidget.h.

◆ Plane

vtkPlane* vtkImplicitPlaneWidget::Plane
protected

Definition at line 326 of file vtkImplicitPlaneWidget.h.

◆ Box

vtkImageData* vtkImplicitPlaneWidget::Box
protected

Definition at line 329 of file vtkImplicitPlaneWidget.h.

◆ Outline

vtkOutlineFilter* vtkImplicitPlaneWidget::Outline
protected

Definition at line 330 of file vtkImplicitPlaneWidget.h.

◆ OutlineMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::OutlineMapper
protected

Definition at line 331 of file vtkImplicitPlaneWidget.h.

◆ OutlineActor

vtkActor* vtkImplicitPlaneWidget::OutlineActor
protected

Definition at line 332 of file vtkImplicitPlaneWidget.h.

◆ OutlineTranslation

vtkTypeBool vtkImplicitPlaneWidget::OutlineTranslation
protected

Definition at line 334 of file vtkImplicitPlaneWidget.h.

◆ ScaleEnabled

vtkTypeBool vtkImplicitPlaneWidget::ScaleEnabled
protected

Definition at line 335 of file vtkImplicitPlaneWidget.h.

◆ OutsideBounds

vtkTypeBool vtkImplicitPlaneWidget::OutsideBounds
protected

Definition at line 336 of file vtkImplicitPlaneWidget.h.

◆ Cutter

vtkCutter* vtkImplicitPlaneWidget::Cutter
protected

Definition at line 339 of file vtkImplicitPlaneWidget.h.

◆ CutMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::CutMapper
protected

Definition at line 340 of file vtkImplicitPlaneWidget.h.

◆ CutActor

vtkActor* vtkImplicitPlaneWidget::CutActor
protected

Definition at line 341 of file vtkImplicitPlaneWidget.h.

◆ DrawPlane

vtkTypeBool vtkImplicitPlaneWidget::DrawPlane
protected

Definition at line 342 of file vtkImplicitPlaneWidget.h.

◆ Edges

vtkFeatureEdges* vtkImplicitPlaneWidget::Edges
protected

Definition at line 346 of file vtkImplicitPlaneWidget.h.

◆ EdgesTuber

vtkTubeFilter* vtkImplicitPlaneWidget::EdgesTuber
protected

Definition at line 347 of file vtkImplicitPlaneWidget.h.

◆ EdgesMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::EdgesMapper
protected

Definition at line 348 of file vtkImplicitPlaneWidget.h.

◆ EdgesActor

vtkActor* vtkImplicitPlaneWidget::EdgesActor
protected

Definition at line 349 of file vtkImplicitPlaneWidget.h.

◆ Tubing

vtkTypeBool vtkImplicitPlaneWidget::Tubing
protected

Definition at line 350 of file vtkImplicitPlaneWidget.h.

◆ DiagonalRatio

double vtkImplicitPlaneWidget::DiagonalRatio
protected

Definition at line 353 of file vtkImplicitPlaneWidget.h.

◆ ConeSource

vtkConeSource* vtkImplicitPlaneWidget::ConeSource
protected

Definition at line 356 of file vtkImplicitPlaneWidget.h.

◆ ConeMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::ConeMapper
protected

Definition at line 357 of file vtkImplicitPlaneWidget.h.

◆ ConeActor

vtkActor* vtkImplicitPlaneWidget::ConeActor
protected

Definition at line 358 of file vtkImplicitPlaneWidget.h.

◆ LineSource

vtkLineSource* vtkImplicitPlaneWidget::LineSource
protected

Definition at line 362 of file vtkImplicitPlaneWidget.h.

◆ LineMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::LineMapper
protected

Definition at line 363 of file vtkImplicitPlaneWidget.h.

◆ LineActor

vtkActor* vtkImplicitPlaneWidget::LineActor
protected

Definition at line 364 of file vtkImplicitPlaneWidget.h.

◆ ConeSource2

vtkConeSource* vtkImplicitPlaneWidget::ConeSource2
protected

Definition at line 367 of file vtkImplicitPlaneWidget.h.

◆ ConeMapper2

vtkPolyDataMapper* vtkImplicitPlaneWidget::ConeMapper2
protected

Definition at line 368 of file vtkImplicitPlaneWidget.h.

◆ ConeActor2

vtkActor* vtkImplicitPlaneWidget::ConeActor2
protected

Definition at line 369 of file vtkImplicitPlaneWidget.h.

◆ LineSource2

vtkLineSource* vtkImplicitPlaneWidget::LineSource2
protected

Definition at line 372 of file vtkImplicitPlaneWidget.h.

◆ LineMapper2

vtkPolyDataMapper* vtkImplicitPlaneWidget::LineMapper2
protected

Definition at line 373 of file vtkImplicitPlaneWidget.h.

◆ LineActor2

vtkActor* vtkImplicitPlaneWidget::LineActor2
protected

Definition at line 374 of file vtkImplicitPlaneWidget.h.

◆ Sphere

vtkSphereSource* vtkImplicitPlaneWidget::Sphere
protected

Definition at line 377 of file vtkImplicitPlaneWidget.h.

◆ SphereMapper

vtkPolyDataMapper* vtkImplicitPlaneWidget::SphereMapper
protected

Definition at line 378 of file vtkImplicitPlaneWidget.h.

◆ SphereActor

vtkActor* vtkImplicitPlaneWidget::SphereActor
protected

Definition at line 379 of file vtkImplicitPlaneWidget.h.

◆ OriginTranslation

vtkTypeBool vtkImplicitPlaneWidget::OriginTranslation
protected

Definition at line 380 of file vtkImplicitPlaneWidget.h.

◆ Picker

vtkCellPicker* vtkImplicitPlaneWidget::Picker
protected

Definition at line 383 of file vtkImplicitPlaneWidget.h.

◆ Transform

vtkTransform* vtkImplicitPlaneWidget::Transform
protected

Definition at line 389 of file vtkImplicitPlaneWidget.h.

◆ NormalProperty

vtkProperty* vtkImplicitPlaneWidget::NormalProperty
protected

Definition at line 402 of file vtkImplicitPlaneWidget.h.

◆ SelectedNormalProperty

vtkProperty* vtkImplicitPlaneWidget::SelectedNormalProperty
protected

Definition at line 403 of file vtkImplicitPlaneWidget.h.

◆ PlaneProperty

vtkProperty* vtkImplicitPlaneWidget::PlaneProperty
protected

Definition at line 404 of file vtkImplicitPlaneWidget.h.

◆ SelectedPlaneProperty

vtkProperty* vtkImplicitPlaneWidget::SelectedPlaneProperty
protected

Definition at line 405 of file vtkImplicitPlaneWidget.h.

◆ OutlineProperty

vtkProperty* vtkImplicitPlaneWidget::OutlineProperty
protected

Definition at line 406 of file vtkImplicitPlaneWidget.h.

◆ SelectedOutlineProperty

vtkProperty* vtkImplicitPlaneWidget::SelectedOutlineProperty
protected

Definition at line 407 of file vtkImplicitPlaneWidget.h.

◆ EdgesProperty

vtkProperty* vtkImplicitPlaneWidget::EdgesProperty
protected

Definition at line 408 of file vtkImplicitPlaneWidget.h.


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