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
 
- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 
- Public Types inherited from vtkInteractorObserver
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkImplicitPlaneWidget2NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetRepresentation (vtkImplicitPlaneRepresentation *rep)
 
void SetEnabled (int enabling)
 
void SetLockNormalToCamera (int lock)
 
vtkImplicitPlaneRepresentationGetImplicitPlaneRepresentation ()
 
void CreateDefaultRepresentation ()
 
- Public Member Functions inherited from vtkAbstractWidget
vtkAbstractWidgetNewInstance () const
 
virtual void SetProcessEvents (int)
 
virtual int GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
vtkWidgetEventTranslatorGetEventTranslator ()
 
void Render ()
 
void SetParent (vtkAbstractWidget *parent)
 
virtual vtkAbstractWidgetGetParent ()
 
vtkWidgetRepresentationGetRepresentation ()
 
virtual void SetManagesCursor (int)
 
virtual int GetManagesCursor ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
virtual void SetPriority (float)
 
- Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 
virtual vtkRenderWindowInteractorGetInteractor ()
 
virtual float GetPriority ()
 
virtual void PickingManagedOn ()
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool)
 
virtual bool GetPickingManaged ()
 
virtual void SetKeyPressActivation (int)
 
virtual int GetKeyPressActivation ()
 
virtual void KeyPressActivationOn ()
 
virtual void KeyPressActivationOff ()
 
virtual void SetKeyPressActivationValue (char)
 
virtual char GetKeyPressActivationValue ()
 
virtual vtkRendererGetDefaultRenderer ()
 
virtual void SetDefaultRenderer (vtkRenderer *)
 
virtual vtkRendererGetCurrentRenderer ()
 
virtual void SetCurrentRenderer (vtkRenderer *)
 
virtual void OnChar ()
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void ReleaseFocus ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkImplicitPlaneWidget2New ()
 
static int IsTypeOf (const char *type)
 
static vtkImplicitPlaneWidget2SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkInteractorObserver
static int IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (vtkObjectBase *o)
 
static void ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
 
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Types

enum  _WidgetState { Start =0, Active }
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImplicitPlaneWidget2 ()
 
 ~vtkImplicitPlaneWidget2 ()
 
int UpdateCursorShape (int interactionState)
 
void InvokeInteractionCallback ()
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget ()
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver ()
 
virtual void StartInteraction ()
 
virtual void EndInteraction ()
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 
virtual void RegisterPickers ()
 
void UnRegisterPickers ()
 
virtual void PickersModified ()
 
vtkPickingManagerGetPickingManager ()
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 
int RequestCursorShape (int requestedShape)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void SelectAction (vtkAbstractWidget *)
 
static void TranslateAction (vtkAbstractWidget *)
 
static void ScaleAction (vtkAbstractWidget *)
 
static void EndSelectAction (vtkAbstractWidget *)
 
static void MoveAction (vtkAbstractWidget *)
 
static void MovePlaneAction (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)
 

Protected Attributes

int WidgetState
 
vtkInteractionCallbackInteractionCallback
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
int 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
vtkAtomicInt32 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). Variuos 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 plane normal is selected:
  LeftButtonPressEvent - select normal
  LeftButtonReleaseEvent - release normal
  MouseMoveEvent - orient the normal vector
If the origin point is selected:
  LeftButtonPressEvent - select slider (if on slider)
  LeftButtonReleaseEvent - release slider (if selected)
  MouseMoveEvent - move the origin point (constrained to the plane)
If the plane is selected:
  LeftButtonPressEvent - select slider (if on slider)
  LeftButtonReleaseEvent - release slider (if selected)
  MouseMoveEvent - move the plane
If the outline is selected:
  LeftButtonPressEvent - select slider (if on slider)
  LeftButtonReleaseEvent - release slider (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 slider 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
Events:
vtkCommand::UpdateEvent vtkCommand::StartInteractionEvent vtkCommand::InteractionEvent vtkCommand::EndInteractionEvent
Tests:
vtkImplicitPlaneWidget2 (Tests)

Definition at line 106 of file vtkImplicitPlaneWidget2.h.

Member Typedef Documentation

◆ Superclass

Standard vtkObject methods

Definition at line 116 of file vtkImplicitPlaneWidget2.h.

Member Enumeration Documentation

◆ _WidgetState

Enumerator
Start 
Active 

Definition at line 149 of file vtkImplicitPlaneWidget2.h.

Constructor & Destructor Documentation

◆ vtkImplicitPlaneWidget2()

vtkImplicitPlaneWidget2::vtkImplicitPlaneWidget2 ( )
protected

◆ ~vtkImplicitPlaneWidget2()

vtkImplicitPlaneWidget2::~vtkImplicitPlaneWidget2 ( )
protected

Member Function Documentation

◆ New()

static vtkImplicitPlaneWidget2* vtkImplicitPlaneWidget2::New ( )
static

Instantiate the object.

◆ IsTypeOf()

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

◆ IsA()

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from 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  )
virtual

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 136 of file vtkImplicitPlaneWidget2.h.

◆ CreateDefaultRepresentation()

void vtkImplicitPlaneWidget2::CreateDefaultRepresentation ( )
virtual

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

◆ 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 108 of file vtkImplicitPlaneWidget2.h.

Member Data Documentation

◆ WidgetState

int vtkImplicitPlaneWidget2::WidgetState
protected

Definition at line 148 of file vtkImplicitPlaneWidget2.h.

◆ InteractionCallback

vtkInteractionCallback* vtkImplicitPlaneWidget2::InteractionCallback
protected

Handle the interaction callback that may come from the representation

Definition at line 166 of file vtkImplicitPlaneWidget2.h.


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