Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
vtkMRMLTransformHandleWidget Class Reference

Process interaction events to update state of interaction widgets. More...

#include <Modules/Loadable/Transforms/MRMLDM/vtkMRMLTransformHandleWidget.h>

Inheritance diagram for vtkMRMLTransformHandleWidget:
Collaboration diagram for vtkMRMLTransformHandleWidget:

Public Types

enum  { WidgetStateTranslateTransformCenter = WidgetStateInteraction_Last }
 The state of the widget. More...
 
enum  { WidgetEventTranslateTransformCenterStart = WidgetEventInteraction_Last , WidgetEventTranslateTransformCenterEnd }
 
- Public Types inherited from vtkMRMLInteractionWidget
enum  {
  WidgetEventInteraction_First = WidgetEventUser , WidgetEventReserved = WidgetEventInteraction_First , WidgetEventUniformScaleStart , WidgetEventUniformScaleEnd ,
  WidgetEventCancel , WidgetEventInteraction_Last
}
 Widget events. More...
 
enum  { InteractionNone , InteractionTranslationHandle , InteractionRotationHandle , InteractionScaleHandle }
 
enum  {
  WidgetStateInteraction_First = WidgetStateUser , WidgetStateOnTranslationHandle = WidgetStateInteraction_First , WidgetStateOnRotationHandle , WidgetStateOnScaleHandle ,
  WidgetStateUniformScale , WidgetStateInteraction_Last
}
 Widget states. More...
 
typedef vtkMRMLAbstractWidget Superclass
 
- Public Types inherited from vtkMRMLAbstractWidget
enum  {
  WidgetStateAny , WidgetStateIdle , WidgetStateOnWidget , WidgetStateTranslate ,
  WidgetStateRotate , WidgetStateScale , WidgetStateUser
}
 The state of the widget. More...
 
typedef vtkObject Superclass
 Standard methods for a VTK class.
 
enum  WidgetEvents {
  WidgetEventNone , WidgetEventMouseMove , WidgetEventTranslateStart , WidgetEventTranslateEnd ,
  WidgetEventRotateStart , WidgetEventRotateEnd , WidgetEventScaleStart , WidgetEventScaleEnd ,
  WidgetEventPick , WidgetEventJumpCursor , WidgetEventAction , WidgetEventCustomAction1 ,
  WidgetEventCustomAction2 , WidgetEventCustomAction3 , WidgetEventCustomAction4 , WidgetEventCustomAction5 ,
  WidgetEventCustomAction6 , WidgetEventSelect , WidgetEventUnselect , WidgetEventToggleSelect ,
  WidgetEventMenu , WidgetEventReset , WidgetEventUser
}
 Widget events. More...
 

Public Member Functions

bool CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &distance2) override
 Return true if the widget can process the event.
 
virtual void CreateDefaultRepresentation (vtkMRMLTransformDisplayNode *displayNode, vtkMRMLAbstractViewNode *viewNode, vtkRenderer *renderer)
 Create the default widget representation and initializes the widget and representation.
 
virtual vtkMRMLTransformDisplayNodeGetDisplayNode ()
 
virtual vtkMRMLTransformNodeGetTransformNode ()
 
bool ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData) override
 Process interaction event.
 
- Public Member Functions inherited from vtkMRMLInteractionWidget
virtual int GetActiveComponentIndex ()
 
virtual int GetActiveComponentType ()
 
bool GetInteractive () override
 Allows the widget to request interactive mode (faster updates)
 
int GetMouseCursor () override
 Allows the widget to request a cursor shape.
 
void Leave (vtkMRMLInteractionEventData *eventData) override
 Called when the the widget loses the focus.
 
virtual void SetActiveComponentIndex (int index)
 
virtual void SetActiveComponentType (int type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkMRMLAbstractWidget
virtual vtkWidgetEventTranslator * GetEventTranslator (int widgetState)
 
virtual bool GetGrabFocus ()
 
vtkMRMLInteractionNodeGetInteractionNode ()
 
vtkMRMLApplicationLogicGetMRMLApplicationLogic ()
 
virtual bool GetNeedToRender ()
 
virtual int GetNumberOfEventTranslators ()
 
vtkRenderer * GetRenderer ()
 
virtual vtkMRMLAbstractWidgetRepresentationGetRepresentation ()
 Get the representation.
 
virtual int GetWidgetState ()
 Convenient method to determine the state of the method.
 
virtual void NeedToRenderOff ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetEventTranslation (int widgetState, unsigned long interactionEvent, int modifiers, unsigned long widgetEvent)
 
void SetEventTranslation (unsigned long interactionEvent, int modifiers, unsigned long widgetEvent)
 
void SetEventTranslationClickAndDrag (int widgetState, unsigned long startInteractionEvent, int modifiers, int widgetStateDragging, unsigned long widgetStartEvent, unsigned long widgetEndEvent)
 
void SetKeyboardEventTranslation (int modifier, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent)
 
void SetKeyboardEventTranslation (int widgetState, int modifier, char keyCode, int repeatCount, const char *keySym, unsigned long widgetEvent)
 
virtual void SetMRMLApplicationLogic (vtkMRMLApplicationLogic *applicationLogic)
 
void SetRenderer (vtkRenderer *renderer)
 
virtual void SetRepresentation (vtkMRMLAbstractWidgetRepresentation *r)
 
virtual void SetWidgetState (int)
 Convenient method to change what state the widget is in.
 
virtual unsigned long TranslateInteractionEventToWidgetEvent (vtkMRMLInteractionEventData *eventData)
 Get widget event from translation event.
 
virtual void UpdateFromMRML (vtkMRMLNode *caller, unsigned long event, void *callData=nullptr)
 Build the actors of the representation with the info stored in the MRML scene.
 

Static Public Member Functions

static vtkMRMLTransformHandleWidgetNew ()
 Instantiate this class.
 
static int IsTypeOf (const char *type)
 
static vtkMRMLInteractionWidgetSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractWidgetSafeDownCast (vtkObject *o)
 

Protected Member Functions

void ApplyTransform (vtkTransform *transform) override
 
vtkMRMLNodeGetMRMLNode () override
 
bool ProcessEndMouseDrag (vtkMRMLInteractionEventData *eventData) override
 
bool ProcessJumpCursor (vtkMRMLInteractionEventData *eventData) override
 
bool ProcessMouseMove (vtkMRMLInteractionEventData *eventData) override
 
bool ProcessWidgetMenu (vtkMRMLInteractionEventData *eventData) override
 
virtual bool ProcessWidgetTranslateTransformCenterStart (vtkMRMLInteractionEventData *eventData)
 
virtual void TranslateTransformCenter (double eventPos[2])
 
 vtkMRMLTransformHandleWidget ()
 
 ~vtkMRMLTransformHandleWidget () override
 
- Protected Member Functions inherited from vtkMRMLInteractionWidget
void EndWidgetInteraction ()
 
virtual bool GetClosestPointOnInteractionAxis (int type, int index, const double inputDisplay[2], double outputIntersectionWorld[3])
 
virtual bool GetIntersectionOnAxisPlane (int type, int index, const double inputDisplay[2], double outputIntersectionWorld[3])
 
virtual bool JumpToHandlePosition (int type, int index)
 
virtual bool ProcessCancelEvent (vtkMRMLInteractionEventData *eventData)
 
virtual bool ProcessWidgetMenuDisplayNodeTypeAndIndex (vtkMRMLInteractionEventData *eventData, vtkMRMLDisplayNode *displayNode, int type, int index)
 
virtual bool ProcessWidgetRotateStart (vtkMRMLInteractionEventData *eventData)
 
virtual bool ProcessWidgetScaleStart (vtkMRMLInteractionEventData *eventData)
 
virtual bool ProcessWidgetTranslateStart (vtkMRMLInteractionEventData *eventData)
 
virtual bool ProcessWidgetUniformScaleStart (vtkMRMLInteractionEventData *eventData)
 
virtual void RestoreInitialState ()
 
virtual void RotateWidget (double eventPos[2])
 
virtual void SaveInitialState ()
 
virtual void ScaleWidget (double eventPos[2], bool uniform=false)
 
void StartWidgetInteraction (vtkMRMLInteractionEventData *eventData)
 
virtual void TranslateWidget (double eventPos[2])
 
 vtkMRMLInteractionWidget ()
 
 ~vtkMRMLInteractionWidget () override
 
- Protected Member Functions inherited from vtkMRMLAbstractWidget
bool CanProcessButtonClickEvent (vtkMRMLInteractionEventData *eventData, double &distance2)
 Generate a button click event and checks if it can be processed with CanProcessInteractionEvent.
 
const char * GetAssociatedNodeID (vtkMRMLInteractionEventData *eventData)
 
virtual int ProcessButtonClickEvent (vtkMRMLInteractionEventData *eventData)
 
unsigned long TranslateInteractionEventToWidgetEvent (vtkWidgetEventTranslator *translator, vtkMRMLInteractionEventData *eventData)
 Helper function that attempts to translate an event with a specific translator only.
 
 vtkMRMLAbstractWidget ()
 
 ~vtkMRMLAbstractWidget () override
 
typedef vtkMRMLInteractionWidget Superclass
 
static int IsTypeOf (const char *type)
 
static vtkMRMLTransformHandleWidgetSafeDownCast (vtkObject *o)
 
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 

Additional Inherited Members

- Protected Attributes inherited from vtkMRMLInteractionWidget
double LastEventPosition [2]
 Variables for translate/rotate/scale.
 
vtkSmartPointer< vtkMRMLNodeOriginalStateNode { nullptr }
 
int PreviewPointIndex
 
- Protected Attributes inherited from vtkMRMLAbstractWidget
vtkWeakPointer< vtkMRMLApplicationLogicApplicationLogic
 
std::vector< vtkSmartPointer< vtkWidgetEventTranslator > > EventTranslators
 
vtkWeakPointer< vtkRenderer > Renderer
 
vtkSmartPointer< vtkMRMLAbstractWidgetRepresentationWidgetRep
 
int WidgetState
 

Detailed Description

Process interaction events to update state of interaction widgets.

See also
vtkMRMLAbstractWidget vtkSlicerWidgetRepresentation vtkSlicerWidgetEventTranslator

Definition at line 47 of file vtkMRMLTransformHandleWidget.h.

Member Typedef Documentation

◆ Superclass

Standard VTK class macros.

Definition at line 56 of file vtkMRMLTransformHandleWidget.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The state of the widget.

Enumerator
WidgetStateTranslateTransformCenter 

mouse move transforms the center of transformation

Definition at line 61 of file vtkMRMLTransformHandleWidget.h.

◆ anonymous enum

anonymous enum
Enumerator
WidgetEventTranslateTransformCenterStart 
WidgetEventTranslateTransformCenterEnd 

Definition at line 66 of file vtkMRMLTransformHandleWidget.h.

Constructor & Destructor Documentation

◆ vtkMRMLTransformHandleWidget()

vtkMRMLTransformHandleWidget::vtkMRMLTransformHandleWidget ( )
protected

◆ ~vtkMRMLTransformHandleWidget()

vtkMRMLTransformHandleWidget::~vtkMRMLTransformHandleWidget ( )
overrideprotected

Member Function Documentation

◆ ApplyTransform()

void vtkMRMLTransformHandleWidget::ApplyTransform ( vtkTransform * transform)
overrideprotectedvirtual

◆ CanProcessInteractionEvent()

bool vtkMRMLTransformHandleWidget::CanProcessInteractionEvent ( vtkMRMLInteractionEventData * eventData,
double & distance2 )
overridevirtual

Return true if the widget can process the event.

Reimplemented from vtkMRMLInteractionWidget.

◆ CreateDefaultRepresentation()

virtual void vtkMRMLTransformHandleWidget::CreateDefaultRepresentation ( vtkMRMLTransformDisplayNode * displayNode,
vtkMRMLAbstractViewNode * viewNode,
vtkRenderer * renderer )
virtual

Create the default widget representation and initializes the widget and representation.

◆ GetClassName()

virtual const char * vtkMRMLTransformHandleWidget::GetClassName ( )
virtual

Reimplemented from vtkMRMLInteractionWidget.

◆ GetDisplayNode()

virtual vtkMRMLTransformDisplayNode * vtkMRMLTransformHandleWidget::GetDisplayNode ( )
virtual

◆ GetMRMLNode()

vtkMRMLNode * vtkMRMLTransformHandleWidget::GetMRMLNode ( )
overrideprotectedvirtual

◆ GetTransformNode()

virtual vtkMRMLTransformNode * vtkMRMLTransformHandleWidget::GetTransformNode ( )
virtual

◆ IsA()

virtual int vtkMRMLTransformHandleWidget::IsA ( const char * type)
virtual

Reimplemented from vtkMRMLInteractionWidget.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLTransformHandleWidget * vtkMRMLTransformHandleWidget::New ( )
static

Instantiate this class.

◆ PrintSelf()

void vtkMRMLTransformHandleWidget::PrintSelf ( ostream & os,
vtkIndent indent )
override

◆ ProcessEndMouseDrag()

bool vtkMRMLTransformHandleWidget::ProcessEndMouseDrag ( vtkMRMLInteractionEventData * eventData)
overrideprotectedvirtual

Reimplemented from vtkMRMLInteractionWidget.

◆ ProcessInteractionEvent()

bool vtkMRMLTransformHandleWidget::ProcessInteractionEvent ( vtkMRMLInteractionEventData * eventData)
overridevirtual

Process interaction event.

Reimplemented from vtkMRMLInteractionWidget.

◆ ProcessJumpCursor()

bool vtkMRMLTransformHandleWidget::ProcessJumpCursor ( vtkMRMLInteractionEventData * eventData)
overrideprotectedvirtual

Reimplemented from vtkMRMLInteractionWidget.

◆ ProcessMouseMove()

bool vtkMRMLTransformHandleWidget::ProcessMouseMove ( vtkMRMLInteractionEventData * eventData)
overrideprotectedvirtual

Callback interface to capture events when placing the widget. Return true if the event is processed.

Reimplemented from vtkMRMLInteractionWidget.

◆ ProcessWidgetMenu()

bool vtkMRMLTransformHandleWidget::ProcessWidgetMenu ( vtkMRMLInteractionEventData * eventData)
overrideprotectedvirtual

◆ ProcessWidgetTranslateTransformCenterStart()

virtual bool vtkMRMLTransformHandleWidget::ProcessWidgetTranslateTransformCenterStart ( vtkMRMLInteractionEventData * eventData)
protectedvirtual

◆ SafeDownCast()

static vtkMRMLTransformHandleWidget * vtkMRMLTransformHandleWidget::SafeDownCast ( vtkObject * o)
static

◆ TranslateTransformCenter()

virtual void vtkMRMLTransformHandleWidget::TranslateTransformCenter ( double eventPos[2])
protectedvirtual

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