Process interaction events to update state of markup widget nodes. More...

#include <Modules/Loadable/Markups/VTKWidgets/vtkSlicerMarkupsWidget.h>

Inheritance diagram for vtkSlicerMarkupsWidget:

[legend]

Collaboration diagram for vtkSlicerMarkupsWidget:

[legend]

Public Types
enum	{ WidgetEventControlPointPlace = WidgetEventUser , WidgetEventClickAndDragStart , WidgetEventClickAndDragEnd , WidgetEventStopPlace , WidgetEventControlPointMoveStart , WidgetEventControlPointMoveEnd , WidgetEventControlPointDelete , WidgetEventControlPointInsert , WidgetEventControlPointSnapToSlice , WidgetEventReserved , WidgetEventMarkups_Last }
	Widget events. More...

enum	{ WidgetStateDefine = WidgetStateUser , WidgetStateTranslateControlPoint , WidgetStateMarkups_Last }
	Widget states. More...

typedef vtkMRMLAbstractWidget	Superclass
	Standard methods for a VTK class.

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
virtual int	AddNodeOnWidget (const int displayPos[2])

virtual int	AddPointFromWorldCoordinate (const double worldCoordinates[3])
	Add a point to the current active Markup at input World coordinates.

bool	CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &distance2) override
	Return true if the widget can process the event.

virtual void	CreateDefaultRepresentation (vtkMRMLMarkupsDisplayNode markupsDisplayNode, vtkMRMLAbstractViewNode viewNode, vtkRenderer *renderer)=0
	Create the default widget representation and initializes the widget and representation.

virtual vtkSlicerMarkupsWidget *	CreateInstance () const =0
	Create instance of the markups widget.

int	GetActiveComponentIndex ()

int	GetActiveComponentType ()

int	GetActiveControlPoint ()

virtual const char *	GetClassName ()

bool	GetInteractive () override

vtkMRMLMarkupsDisplayNode *	GetMarkupsDisplayNode ()

vtkMRMLMarkupsNode *	GetMarkupsNode ()

vtkSlicerMarkupsWidgetRepresentation *	GetMarkupsRepresentation ()

int	GetMouseCursor () override

virtual int	IsA (const char *type)

bool	IsPointPreviewed ()

void	Leave (vtkMRMLInteractionEventData *eventData) override
	Called when the the widget loses the focus.

virtual bool	PlacePoint (vtkMRMLInteractionEventData *eventData)

void	PrintSelf (ostream &os, vtkIndent indent) override

bool	ProcessInteractionEvent (vtkMRMLInteractionEventData *eventData) override
	Process interaction event.

bool	RemovePreviewPoint ()

vtkMRMLSelectionNode *	selectionNode ()

void	UpdatePreviewPoint (vtkMRMLInteractionEventData eventData, const char associatedNodeID, int positionStatus)
	Add/update a point preview to the current active Markup at the specified position.

void	UpdatePreviewPointIndex (vtkMRMLInteractionEventData *eventData)
	Update a the current index of the point preview being previewed.

Public Member Functions inherited from vtkMRMLAbstractWidget
virtual vtkWidgetEventTranslator *	GetEventTranslator (int widgetState)

virtual bool	GetGrabFocus ()

vtkMRMLInteractionNode *	GetInteractionNode ()

vtkMRMLApplicationLogic *	GetMRMLApplicationLogic ()

virtual bool	GetNeedToRender ()

virtual int	GetNumberOfEventTranslators ()

vtkRenderer *	GetRenderer ()

virtual vtkMRMLAbstractWidgetRepresentation *	GetRepresentation ()
	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 int	IsTypeOf (const char *type)

static vtkSlicerMarkupsWidget *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLAbstractWidget
static int	IsTypeOf (const char *type)

static vtkMRMLAbstractWidget *	SafeDownCast (vtkObject *o)

Protected Member Functions
bool	ConvertDisplayPositionToWorld (const int displayPos[2], double worldPos[3], double worldOrientationMatrix[9], double *refWorldPos=nullptr)

void	EndWidgetInteraction ()

bool	IsAnyControlPointLocked ()

virtual bool	ProcessControlPointDelete (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessControlPointInsert (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessControlPointMoveStart (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessControlPointSnapToSlice (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessEndMouseDrag (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessMouseMove (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetAction (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetJumpCursor (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetMenu (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetReset (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetStopPlace (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetTranslateStart (vtkMRMLInteractionEventData *eventData)

void	StartWidgetInteraction (vtkMRMLInteractionEventData *eventData)

virtual void	TranslatePoint (double eventPos[2], bool snapToSlice=false)

virtual void	TranslateWidget (double eventPos[2])

void	UpdateInteractionAccuratePicker (vtkMRMLInteractionEventData *eventData)

	vtkSlicerMarkupsWidget ()

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

Protected Attributes
double	LastEventPosition [2]

int	PreviewPointIndex

double	StartEventOffsetPosition [2]

Protected Attributes inherited from vtkMRMLAbstractWidget
vtkWeakPointer< vtkMRMLApplicationLogic >	ApplicationLogic

std::vector< vtkSmartPointer< vtkWidgetEventTranslator > >	EventTranslators

vtkWeakPointer< vtkRenderer >	Renderer

vtkSmartPointer< vtkMRMLAbstractWidgetRepresentation >	WidgetRep

int	WidgetState

Detailed Description

Process interaction events to update state of markup widget nodes.

See also: vtkMRMLAbstractWidget vtkSlicerWidgetRepresentation vtkSlicerWidgetEventTranslator

Definition at line 45 of file vtkSlicerMarkupsWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLAbstractWidget vtkSlicerMarkupsWidget::Superclass

Standard methods for a VTK class.

Definition at line 49 of file vtkSlicerMarkupsWidget.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Widget events.

Enumerator
WidgetEventControlPointPlace
WidgetEventClickAndDragStart
WidgetEventClickAndDragEnd
WidgetEventStopPlace
WidgetEventControlPointMoveStart
WidgetEventControlPointMoveEnd
WidgetEventControlPointDelete
WidgetEventControlPointInsert
WidgetEventControlPointSnapToSlice
WidgetEventReserved
WidgetEventMarkups_Last

Definition at line 67 of file vtkSlicerMarkupsWidget.h.

◆ anonymous enum

anonymous enum

Widget states.

Enumerator
WidgetStateDefine
WidgetStateTranslateControlPoint
WidgetStateMarkups_Last

Definition at line 59 of file vtkSlicerMarkupsWidget.h.

Constructor & Destructor Documentation

◆ vtkSlicerMarkupsWidget()

vtkSlicerMarkupsWidget::vtkSlicerMarkupsWidget ( )

protected

◆ ~vtkSlicerMarkupsWidget()

vtkSlicerMarkupsWidget::~vtkSlicerMarkupsWidget ( )

overrideprotected

Member Function Documentation

◆ AddNodeOnWidget()

virtual int vtkSlicerMarkupsWidget::AddNodeOnWidget ( const int displayPos[2] )

virtual

Given a specific X, Y pixel location, add a new node on the widget at this location.

◆ AddPointFromWorldCoordinate()

virtual int vtkSlicerMarkupsWidget::AddPointFromWorldCoordinate ( const double worldCoordinates[3] )

virtual

Add a point to the current active Markup at input World coordinates.

◆ CanProcessInteractionEvent()

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

overridevirtual

Return true if the widget can process the event.

Reimplemented from vtkMRMLAbstractWidget.

Reimplemented in vtkSlicerPlaneWidget.

◆ ConvertDisplayPositionToWorld()

bool vtkSlicerMarkupsWidget::ConvertDisplayPositionToWorld	(	const int	displayPos[2],
		double	worldPos[3],
		double	worldOrientationMatrix[9],
		double *	refWorldPos = nullptr )

protected

◆ CreateDefaultRepresentation()

virtual void vtkSlicerMarkupsWidget::CreateDefaultRepresentation	(	vtkMRMLMarkupsDisplayNode *	markupsDisplayNode,
		vtkMRMLAbstractViewNode *	viewNode,
		vtkRenderer *	renderer )

pure virtual

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

Implemented in vtkSlicerAngleWidget, vtkSlicerCurveWidget, vtkSlicerLineWidget, vtkSlicerPlaneWidget, vtkSlicerPointsWidget, and vtkSlicerROIWidget.

◆ CreateInstance()

virtual vtkSlicerMarkupsWidget * vtkSlicerMarkupsWidget::CreateInstance ( ) const

pure virtual

Create instance of the markups widget.

◆ EndWidgetInteraction()

void vtkSlicerMarkupsWidget::EndWidgetInteraction ( )

protected

◆ GetActiveComponentIndex()

int vtkSlicerMarkupsWidget::GetActiveComponentIndex ( )

◆ GetActiveComponentType()

int vtkSlicerMarkupsWidget::GetActiveComponentType ( )

◆ GetActiveControlPoint()

int vtkSlicerMarkupsWidget::GetActiveControlPoint ( )

◆ GetClassName()

virtual const char * vtkSlicerMarkupsWidget::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractWidget.

Reimplemented in vtkSlicerAngleWidget, vtkSlicerCurveWidget, vtkSlicerLineWidget, vtkSlicerPlaneWidget, vtkSlicerPointsWidget, and vtkSlicerROIWidget.

◆ GetInteractive()

bool vtkSlicerMarkupsWidget::GetInteractive ( )

overridevirtual

Reimplemented from vtkMRMLAbstractWidget.

◆ GetMarkupsDisplayNode()

vtkMRMLMarkupsDisplayNode * vtkSlicerMarkupsWidget::GetMarkupsDisplayNode ( )

◆ GetMarkupsNode()

vtkMRMLMarkupsNode * vtkSlicerMarkupsWidget::GetMarkupsNode ( )

◆ GetMarkupsRepresentation()

vtkSlicerMarkupsWidgetRepresentation * vtkSlicerMarkupsWidget::GetMarkupsRepresentation ( )

◆ GetMouseCursor()

int vtkSlicerMarkupsWidget::GetMouseCursor ( )

overridevirtual

Reimplemented from vtkMRMLAbstractWidget.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLAbstractWidget.

Reimplemented in vtkSlicerAngleWidget, vtkSlicerCurveWidget, vtkSlicerLineWidget, vtkSlicerPlaneWidget, vtkSlicerPointsWidget, and vtkSlicerROIWidget.

◆ IsAnyControlPointLocked()

bool vtkSlicerMarkupsWidget::IsAnyControlPointLocked ( )

protected

◆ IsPointPreviewed()

bool vtkSlicerMarkupsWidget::IsPointPreviewed ( )

◆ IsTypeOf()

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

static

◆ Leave()

void vtkSlicerMarkupsWidget::Leave ( vtkMRMLInteractionEventData * eventData )

overridevirtual

Called when the the widget loses the focus.

Reimplemented from vtkMRMLAbstractWidget.

◆ PlacePoint()

virtual bool vtkSlicerMarkupsWidget::PlacePoint ( vtkMRMLInteractionEventData * eventData )

virtual

Reimplemented in vtkSlicerPlaneWidget.

◆ PrintSelf()

void vtkSlicerMarkupsWidget::PrintSelf	(	ostream &	os,
		vtkIndent	indent )

override

◆ ProcessControlPointDelete()

virtual bool vtkSlicerMarkupsWidget::ProcessControlPointDelete ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

◆ ProcessControlPointInsert()

virtual bool vtkSlicerMarkupsWidget::ProcessControlPointInsert ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

Reimplemented in vtkSlicerCurveWidget.

◆ ProcessControlPointMoveStart()

virtual bool vtkSlicerMarkupsWidget::ProcessControlPointMoveStart ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

◆ ProcessControlPointSnapToSlice()

virtual bool vtkSlicerMarkupsWidget::ProcessControlPointSnapToSlice ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

◆ ProcessEndMouseDrag()

virtual bool vtkSlicerMarkupsWidget::ProcessEndMouseDrag ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

Reimplemented in vtkSlicerPlaneWidget.

◆ ProcessInteractionEvent()

bool vtkSlicerMarkupsWidget::ProcessInteractionEvent ( vtkMRMLInteractionEventData * eventData )

overridevirtual

Process interaction event.

Reimplemented from vtkMRMLAbstractWidget.

Reimplemented in vtkSlicerPlaneWidget.

◆ ProcessMouseMove()

virtual bool vtkSlicerMarkupsWidget::ProcessMouseMove ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

Reimplemented in vtkSlicerPlaneWidget.

◆ ProcessWidgetAction()

virtual bool vtkSlicerMarkupsWidget::ProcessWidgetAction ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

◆ ProcessWidgetJumpCursor()

virtual bool vtkSlicerMarkupsWidget::ProcessWidgetJumpCursor ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

◆ ProcessWidgetMenu()

virtual bool vtkSlicerMarkupsWidget::ProcessWidgetMenu ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

◆ ProcessWidgetReset()

virtual bool vtkSlicerMarkupsWidget::ProcessWidgetReset ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

◆ ProcessWidgetStopPlace()

virtual bool vtkSlicerMarkupsWidget::ProcessWidgetStopPlace ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

Reimplemented in vtkSlicerPlaneWidget.

◆ ProcessWidgetTranslateStart()

virtual bool vtkSlicerMarkupsWidget::ProcessWidgetTranslateStart ( vtkMRMLInteractionEventData * eventData )

protectedvirtual

◆ RemovePreviewPoint()

bool vtkSlicerMarkupsWidget::RemovePreviewPoint ( )

Remove the point preview to the current active Markup. Returns true is preview point existed and now it is removed.

◆ SafeDownCast()

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

static

◆ selectionNode()

vtkMRMLSelectionNode * vtkSlicerMarkupsWidget::selectionNode ( )

◆ StartWidgetInteraction()

void vtkSlicerMarkupsWidget::StartWidgetInteraction ( vtkMRMLInteractionEventData * eventData )

protected

◆ TranslatePoint()

virtual void vtkSlicerMarkupsWidget::TranslatePoint	(	double	eventPos[2],
		bool	snapToSlice = false )

protectedvirtual

◆ TranslateWidget()

virtual void vtkSlicerMarkupsWidget::TranslateWidget ( double eventPos[2] )

protectedvirtual

◆ UpdateInteractionAccuratePicker()

void vtkSlicerMarkupsWidget::UpdateInteractionAccuratePicker ( vtkMRMLInteractionEventData * eventData )

protected

Give the 3D representation the view's shared accurate picker (from the interaction event data) for the duration of this event, so all widgets in the view reuse one picker and one set of cell locators. Must be called at the start of every ProcessInteractionEvent() override that can lead to a pick (AccuratePick / ConvertDisplayPositionToWorld).

◆ UpdatePreviewPoint()

void vtkSlicerMarkupsWidget::UpdatePreviewPoint	(	vtkMRMLInteractionEventData *	eventData,
		const char *	associatedNodeID,
		int	positionStatus )

Add/update a point preview to the current active Markup at the specified position.

◆ UpdatePreviewPointIndex()

void vtkSlicerMarkupsWidget::UpdatePreviewPointIndex ( vtkMRMLInteractionEventData * eventData )

Update a the current index of the point preview being previewed.

Member Data Documentation

◆ LastEventPosition

double vtkSlicerMarkupsWidget::LastEventPosition[2]

protected

Definition at line 179 of file vtkSlicerMarkupsWidget.h.

◆ PreviewPointIndex

int vtkSlicerMarkupsWidget::PreviewPointIndex

protected

Index of the control point that is currently being previewed (follows the mouse pointer). If <0 it means that there is currently no point being previewed.

Definition at line 160 of file vtkSlicerMarkupsWidget.h.

◆ StartEventOffsetPosition

double vtkSlicerMarkupsWidget::StartEventOffsetPosition[2]

protected

Definition at line 180 of file vtkSlicerMarkupsWidget.h.

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

Modules/Loadable/Markups/VTKWidgets/vtkSlicerMarkupsWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkSlicerMarkupsWidget()

◆ ~vtkSlicerMarkupsWidget()

Member Function Documentation

◆ AddNodeOnWidget()

◆ AddPointFromWorldCoordinate()

◆ CanProcessInteractionEvent()

◆ ConvertDisplayPositionToWorld()

◆ CreateDefaultRepresentation()

◆ CreateInstance()

◆ EndWidgetInteraction()

◆ GetActiveComponentIndex()

◆ GetActiveComponentType()

◆ GetActiveControlPoint()

◆ GetClassName()

◆ GetInteractive()

◆ GetMarkupsDisplayNode()

◆ GetMarkupsNode()

◆ GetMarkupsRepresentation()

◆ GetMouseCursor()

◆ IsA()

◆ IsAnyControlPointLocked()

◆ IsPointPreviewed()

◆ IsTypeOf()

◆ Leave()

◆ PlacePoint()

◆ PrintSelf()

◆ ProcessControlPointDelete()

◆ ProcessControlPointInsert()

◆ ProcessControlPointMoveStart()

◆ ProcessControlPointSnapToSlice()

◆ ProcessEndMouseDrag()

◆ ProcessInteractionEvent()

◆ ProcessMouseMove()

◆ ProcessWidgetAction()

◆ ProcessWidgetJumpCursor()

◆ ProcessWidgetMenu()

◆ ProcessWidgetReset()

◆ ProcessWidgetStopPlace()

◆ ProcessWidgetTranslateStart()

◆ RemovePreviewPoint()

◆ SafeDownCast()

◆ selectionNode()

◆ StartWidgetInteraction()

◆ TranslatePoint()

◆ TranslateWidget()

◆ UpdateInteractionAccuratePicker()

◆ UpdatePreviewPoint()

◆ UpdatePreviewPointIndex()

Member Data Documentation

◆ LastEventPosition

◆ PreviewPointIndex

◆ StartEventOffsetPosition