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

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

#include <vtkImplicitPlaneWidget2.h>

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

Public Types

typedef vtkAbstractWidget Superclass
 Standard vtkObject methods. More...
 
- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 Standard macros implementing standard VTK methods. More...
 
- 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...
 
vtkImplicitPlaneWidget2NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetRepresentation (vtkImplicitPlaneRepresentation *rep)
 Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
void SetEnabled (int enabling) override
 Methods for activating this widget. More...
 
void SetLockNormalToCamera (int lock)
 Observe/Unobserve the camera if the widget is locked/unlocked to update the vtkImplicitePlaneRepresentation's normal. More...
 
vtkImplicitPlaneRepresentationGetImplicitPlaneRepresentation ()
 Return the representation as a vtkImplicitPlaneRepresentation. More...
 
void CreateDefaultRepresentation () override
 Create the default widget representation if one is not set. More...
 
- Public Member Functions inherited from vtkAbstractWidget
vtkAbstractWidgetNewInstance () const
 
virtual void SetProcessEvents (vtkTypeBool)
 Methods to change whether the widget responds to interaction. More...
 
virtual vtkTypeBool GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
vtkWidgetEventTranslatorGetEventTranslator ()
 Get the event translator. More...
 
void Render ()
 This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...
 
void SetParent (vtkAbstractWidget *parent)
 Specifying a parent to this widget is used when creating composite widgets. More...
 
virtual vtkAbstractWidgetGetParent ()
 
vtkWidgetRepresentationGetRepresentation ()
 Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
 
virtual void SetManagesCursor (vtkTypeBool)
 Turn on or off the management of the cursor. More...
 
virtual vtkTypeBool GetManagesCursor ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
void SetPriority (float) override
 Override the superclass method. More...
 
- 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 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 vtkImplicitPlaneWidget2New ()
 Instantiate the object. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImplicitPlaneWidget2SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractWidget
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (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, Active }
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImplicitPlaneWidget2 ()
 
 ~vtkImplicitPlaneWidget2 () override
 
int UpdateCursorShape (int interactionState)
 Update the cursor shape based on the interaction state. More...
 
void InvokeInteractionCallback ()
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget () override
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 
- 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])
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
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 SelectAction (vtkAbstractWidget *)
 
static void TranslateAction (vtkAbstractWidget *)
 
static void ScaleAction (vtkAbstractWidget *)
 
static void EndSelectAction (vtkAbstractWidget *)
 
static void MoveAction (vtkAbstractWidget *)
 
static void MovePlaneAction (vtkAbstractWidget *)
 
static void SelectAction3D (vtkAbstractWidget *)
 
static void EndSelectAction3D (vtkAbstractWidget *)
 
static void MoveAction3D (vtkAbstractWidget *)
 
static void TranslationAxisLock (vtkAbstractWidget *)
 
static void TranslationAxisUnLock (vtkAbstractWidget *)
 
- Static Protected Member Functions inherited from vtkAbstractWidget
static void ProcessEventsHandler (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 WidgetState
 
vtkInteractionCallbackInteractionCallback
 Handle the interaction callback that may come from the representation. More...
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
vtkTypeBool ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
vtkTypeBool ProcessEvents
 
- 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
 

Friends

class vtkInteractionCallback
 

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 assumed to consist of four parts: 1) a plane contained in a 2) bounding box, with a 3) plane normal, which is rooted at a 4) point on the plane. (The representation paired with this widget determines the actual geometry of the widget.)

To use this widget, you generally pair it with a vtkImplicitPlaneRepresentation (or a subclass). Various options are available for controlling how the representation appears, and how the widget functions.

Event Bindings:
By default, the widget responds to the following VTK events (i.e., it watches the vtkRenderWindowInteractor for these events):
If the mouse is over the plane normal:
  LeftButtonPressEvent - select normal
  LeftButtonReleaseEvent - release normal
  MouseMoveEvent - orient the normal vector
If the mouse is over the origin point (handle):
  LeftButtonPressEvent - select handle
  LeftButtonReleaseEvent - release handle (if selected)
  MouseMoveEvent - move the origin point (constrained to the plane)
If the mouse is over the plane:
  LeftButtonPressEvent - select plane
  LeftButtonReleaseEvent - release plane (if selected)
  MouseMoveEvent - move the plane
If the mouse is over the outline:
  LeftButtonPressEvent - select outline
  LeftButtonReleaseEvent - release outline (if selected)
  MouseMoveEvent - move the outline
If the keypress characters are used
  'Down/Left' Move plane down
  'Up/Right' Move plane up
In all the cases, independent of what is picked, the widget responds to the
following VTK events:
  MiddleButtonPressEvent - move the plane
  MiddleButtonReleaseEvent - release the plane
  RightButtonPressEvent - scale the widget's representation
  RightButtonReleaseEvent - stop scaling the widget
  MouseMoveEvent - scale (if right button) or move (if middle button) the widget
Event Bindings:
Note that the event bindings described above can be changed using this class's vtkWidgetEventTranslator. This class translates VTK events into the vtkImplicitPlaneWidget2's widget events:
  vtkWidgetEvent::Select -- some part of the widget has been selected
  vtkWidgetEvent::EndSelect -- the selection process has completed
  vtkWidgetEvent::Move -- a request for widget motion has been invoked
  vtkWidgetEvent::Up and vtkWidgetEvent::Down -- MovePlaneAction
Event Bindings:
In turn, when these widget events are processed, the vtkImplicitPlaneWidget2 invokes the following VTK events on itself (which observers can listen for):
  vtkCommand::StartInteractionEvent (on vtkWidgetEvent::Select)
  vtkCommand::EndInteractionEvent (on vtkWidgetEvent::EndSelect)
  vtkCommand::InteractionEvent (on vtkWidgetEvent::Move)
Event Bindings:
This class, and vtkImplicitPlaneRepresentation, are next generation VTK widgets. An earlier version of this functionality was defined in the class vtkImplicitPlaneWidget.
See also
vtk3DWidget vtkBoxWidget vtkPlaneWidget vtkLineWidget vtkPointWidget vtkSphereWidget vtkImagePlaneWidget vtkImplicitCylinderWidget

Definition at line 101 of file vtkImplicitPlaneWidget2.h.

Member Typedef Documentation

◆ Superclass

Standard vtkObject methods.

Definition at line 115 of file vtkImplicitPlaneWidget2.h.

Member Enumeration Documentation

◆ _WidgetState

Enumerator
Start 
Active 

Definition at line 156 of file vtkImplicitPlaneWidget2.h.

Constructor & Destructor Documentation

◆ vtkImplicitPlaneWidget2()

vtkImplicitPlaneWidget2::vtkImplicitPlaneWidget2 ( )
protected

◆ ~vtkImplicitPlaneWidget2()

vtkImplicitPlaneWidget2::~vtkImplicitPlaneWidget2 ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImplicitPlaneWidget2* vtkImplicitPlaneWidget2::New ( )
static

Instantiate the object.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkImplicitPlaneWidget2::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 vtkAbstractWidget.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitPlaneWidget2::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractWidget.

◆ NewInstance()

vtkImplicitPlaneWidget2* vtkImplicitPlaneWidget2::NewInstance ( ) const

◆ PrintSelf()

void vtkImplicitPlaneWidget2::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 vtkAbstractWidget.

◆ SetRepresentation()

void vtkImplicitPlaneWidget2::SetRepresentation ( vtkImplicitPlaneRepresentation rep)

Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.

Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.

◆ SetEnabled()

void vtkImplicitPlaneWidget2::SetEnabled ( int  )
overridevirtual

Methods for activating this widget.

Note that the widget representation must be specified or the widget will not appear. ProcessEvents (On by default) must be On for Enabled widget to respond to interaction. If ProcessEvents is Off, enabling/disabling a widget merely affects the visibility of the representation.

Reimplemented from vtkAbstractWidget.

◆ SetLockNormalToCamera()

void vtkImplicitPlaneWidget2::SetLockNormalToCamera ( int  lock)

Observe/Unobserve the camera if the widget is locked/unlocked to update the vtkImplicitePlaneRepresentation's normal.

◆ GetImplicitPlaneRepresentation()

vtkImplicitPlaneRepresentation* vtkImplicitPlaneWidget2::GetImplicitPlaneRepresentation ( )
inline

Return the representation as a vtkImplicitPlaneRepresentation.

Definition at line 140 of file vtkImplicitPlaneWidget2.h.

◆ CreateDefaultRepresentation()

void vtkImplicitPlaneWidget2::CreateDefaultRepresentation ( )
overridevirtual

Create the default widget representation if one is not set.

Implements vtkAbstractWidget.

◆ SelectAction()

static void vtkImplicitPlaneWidget2::SelectAction ( vtkAbstractWidget )
staticprotected

◆ TranslateAction()

static void vtkImplicitPlaneWidget2::TranslateAction ( vtkAbstractWidget )
staticprotected

◆ ScaleAction()

static void vtkImplicitPlaneWidget2::ScaleAction ( vtkAbstractWidget )
staticprotected

◆ EndSelectAction()

static void vtkImplicitPlaneWidget2::EndSelectAction ( vtkAbstractWidget )
staticprotected

◆ MoveAction()

static void vtkImplicitPlaneWidget2::MoveAction ( vtkAbstractWidget )
staticprotected

◆ MovePlaneAction()

static void vtkImplicitPlaneWidget2::MovePlaneAction ( vtkAbstractWidget )
staticprotected

◆ SelectAction3D()

static void vtkImplicitPlaneWidget2::SelectAction3D ( vtkAbstractWidget )
staticprotected

◆ EndSelectAction3D()

static void vtkImplicitPlaneWidget2::EndSelectAction3D ( vtkAbstractWidget )
staticprotected

◆ MoveAction3D()

static void vtkImplicitPlaneWidget2::MoveAction3D ( vtkAbstractWidget )
staticprotected

◆ TranslationAxisLock()

static void vtkImplicitPlaneWidget2::TranslationAxisLock ( vtkAbstractWidget )
staticprotected

◆ TranslationAxisUnLock()

static void vtkImplicitPlaneWidget2::TranslationAxisUnLock ( vtkAbstractWidget )
staticprotected

◆ UpdateCursorShape()

int vtkImplicitPlaneWidget2::UpdateCursorShape ( int  interactionState)
protected

Update the cursor shape based on the interaction state.

Returns 1 if the cursor shape requested is different from the existing one.

◆ InvokeInteractionCallback()

void vtkImplicitPlaneWidget2::InvokeInteractionCallback ( )
protected

Friends And Related Function Documentation

◆ vtkInteractionCallback

friend class vtkInteractionCallback
friend

Definition at line 103 of file vtkImplicitPlaneWidget2.h.

Member Data Documentation

◆ WidgetState

int vtkImplicitPlaneWidget2::WidgetState
protected

Definition at line 155 of file vtkImplicitPlaneWidget2.h.

◆ InteractionCallback

vtkInteractionCallback* vtkImplicitPlaneWidget2::InteractionCallback
protected

Handle the interaction callback that may come from the representation.

Definition at line 185 of file vtkImplicitPlaneWidget2.h.


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