Create an ROI representation. More...

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

Inheritance diagram for vtkSlicerROIWidget:

Collaboration diagram for vtkSlicerROIWidget:

Public Types
enum	{ WidgetStateSymmetricScale = WidgetStateMarkups_Last, WidgetStateMarkupsROI_Last }
	Widget states. More...

enum	{ WidgetEventSymmetricScaleStart = WidgetEventMarkups_Last, WidgetEventSymmetricScaleEnd, WidgetEventMarkupsROI_Last }

typedef vtkSlicerMarkupsWidget	Superclass
	Standard methods for a VTK class. More...

Public Types inherited from vtkSlicerMarkupsWidget
enum	{ WidgetStateDefine = WidgetStateUser, WidgetStateTranslateControlPoint, WidgetStateOnTranslationHandle, WidgetStateOnRotationHandle, WidgetStateOnScaleHandle, WidgetStateMarkups_Last }
	Widget states. More...

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

typedef vtkMRMLAbstractWidget	Superclass
	Standard methods for a VTK class. More...

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. More...

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
void	CreateDefaultRepresentation (vtkMRMLMarkupsDisplayNode markupsDisplayNode, vtkMRMLAbstractViewNode viewNode, vtkRenderer *renderer) override
	Create the default widget representation and initializes the widget and representation. More...

void	FlipROIHandles (bool flipLRHandle, bool flipAPHandle, bool flipISHandle)

virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

	vtkSlicerMarkupsWidgetCreateInstanceMacro (vtkSlicerROIWidget)
	Create instance of the markups widget. More...

Public Member Functions inherited from vtkSlicerMarkupsWidget
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. More...

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

int	GetActiveComponentIndex ()

int	GetActiveComponentType ()

int	GetActiveControlPoint ()

bool	GetInteractive () override

vtkMRMLMarkupsDisplayNode *	GetMarkupsDisplayNode ()

vtkMRMLMarkupsNode *	GetMarkupsNode ()

vtkSlicerMarkupsWidgetRepresentation *	GetMarkupsRepresentation ()

int	GetMouseCursor () override

bool	IsPointPreviewed ()

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

virtual bool	PlacePoint (vtkMRMLInteractionEventData *eventData)

void	PrintSelf (ostream &os, vtkIndent indent) override

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. More...

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

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. More...

virtual int	GetWidgetState ()
	Convenient method to determine the state of the method. More...

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. More...

virtual unsigned long	TranslateInteractionEventToWidgetEvent (vtkMRMLInteractionEventData *eventData)
	Get widget event from translation event. More...

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. More...

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

static vtkSlicerROIWidget *	New ()
	Instantiate this class. More...

static vtkSlicerROIWidget *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSlicerMarkupsWidget
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	CanProcessInteractionEvent (vtkMRMLInteractionEventData *eventData, double &distance2) override
	Return true if the widget can process the event. More...

bool	ProcessEndMouseDrag (vtkMRMLInteractionEventData *eventData) override

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

bool	ProcessMouseMove (vtkMRMLInteractionEventData *eventData) override

bool	ProcessWidgetSymmetricScaleStart (vtkMRMLInteractionEventData *eventData)

void	ScaleWidget (double eventPos[2]) override

void	ScaleWidget (double eventPos[2], bool symmetricScale)

	vtkSlicerROIWidget ()

	~vtkSlicerROIWidget () override

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

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

bool	IsAnyControlPointLocked ()

virtual bool	ProcessControlPointDelete (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessControlPointInsert (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessControlPointMoveStart (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessControlPointSnapToSlice (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetAction (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetJumpCursor (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetMenu (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetReset (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetRotateStart (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetScaleStart (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetStopPlace (vtkMRMLInteractionEventData *eventData)

virtual bool	ProcessWidgetTranslateStart (vtkMRMLInteractionEventData *eventData)

virtual void	RotateWidget (double eventPos[2])

void	StartWidgetInteraction (vtkMRMLInteractionEventData *eventData)

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

virtual void	TranslateWidget (double eventPos[2])

	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. More...

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. More...

	vtkMRMLAbstractWidget ()

	~vtkMRMLAbstractWidget () override

Additional Inherited Members
Protected Attributes inherited from vtkSlicerMarkupsWidget
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

Create an ROI representation.

The vtkSlicerROIWidget is used to create an ROI widget.

Definition at line 35 of file vtkSlicerROIWidget.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSlicerMarkupsWidget vtkSlicerROIWidget::Superclass

Standard methods for a VTK class.

Definition at line 42 of file vtkSlicerROIWidget.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Widget states.

Enumerator
WidgetStateSymmetricScale
WidgetStateMarkupsROI_Last

Definition at line 45 of file vtkSlicerROIWidget.h.

◆ anonymous enum

anonymous enum

Enumerator
WidgetEventSymmetricScaleStart
WidgetEventSymmetricScaleEnd
WidgetEventMarkupsROI_Last

Definition at line 52 of file vtkSlicerROIWidget.h.

Constructor & Destructor Documentation

◆ vtkSlicerROIWidget()

vtkSlicerROIWidget::vtkSlicerROIWidget ( )

protected

◆ ~vtkSlicerROIWidget()

vtkSlicerROIWidget::~vtkSlicerROIWidget ( )

overrideprotected

Member Function Documentation

◆ CanProcessInteractionEvent()

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

overrideprotectedvirtual

Return true if the widget can process the event.

Reimplemented from vtkSlicerMarkupsWidget.

◆ CreateDefaultRepresentation()

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

overridevirtual

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

Implements vtkSlicerMarkupsWidget.

◆ FlipROIHandles()

void vtkSlicerROIWidget::FlipROIHandles	(	bool	flipLRHandle,
		bool	flipAPHandle,
		bool	flipISHandle
	)

Flip the selected index across the specified axis. Ex. Switch between L–R face. Used when the user drags an ROI handle across the ROI origin.

◆ GetClassName()

virtual const char* vtkSlicerROIWidget::GetClassName ( )

virtual

Reimplemented from vtkSlicerMarkupsWidget.

◆ IsA()

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

virtual

Reimplemented from vtkSlicerMarkupsWidget.

◆ IsTypeOf()

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

static

◆ New()

static vtkSlicerROIWidget* vtkSlicerROIWidget::New ( )

static

Instantiate this class.

◆ ProcessEndMouseDrag()

bool vtkSlicerROIWidget::ProcessEndMouseDrag ( vtkMRMLInteractionEventData * eventData )

overrideprotectedvirtual

Reimplemented from vtkSlicerMarkupsWidget.

◆ ProcessInteractionEvent()

bool vtkSlicerROIWidget::ProcessInteractionEvent ( vtkMRMLInteractionEventData * eventData )

overrideprotectedvirtual

Process interaction event.

Reimplemented from vtkSlicerMarkupsWidget.

◆ ProcessMouseMove()

bool vtkSlicerROIWidget::ProcessMouseMove ( vtkMRMLInteractionEventData * eventData )

overrideprotectedvirtual

Reimplemented from vtkSlicerMarkupsWidget.

◆ ProcessWidgetSymmetricScaleStart()

bool vtkSlicerROIWidget::ProcessWidgetSymmetricScaleStart ( vtkMRMLInteractionEventData * eventData )

protected

◆ SafeDownCast()

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

static

◆ ScaleWidget() [1/2]

void vtkSlicerROIWidget::ScaleWidget ( double eventPos[2] )

overrideprotectedvirtual

Reimplemented from vtkSlicerMarkupsWidget.

◆ ScaleWidget() [2/2]

void vtkSlicerROIWidget::ScaleWidget	(	double	eventPos[2],
		bool	symmetricScale
	)

protected

◆ vtkSlicerMarkupsWidgetCreateInstanceMacro()

vtkSlicerROIWidget::vtkSlicerMarkupsWidgetCreateInstanceMacro ( vtkSlicerROIWidget )

Create instance of the markups widget.

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

Modules/Loadable/Markups/VTKWidgets/vtkSlicerROIWidget.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkSlicerROIWidget()

◆ ~vtkSlicerROIWidget()

Member Function Documentation

◆ CanProcessInteractionEvent()

◆ CreateDefaultRepresentation()

◆ FlipROIHandles()

◆ GetClassName()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ ProcessEndMouseDrag()

◆ ProcessInteractionEvent()

◆ ProcessMouseMove()

◆ ProcessWidgetSymmetricScaleStart()

◆ SafeDownCast()

◆ ScaleWidget() [1/2]

◆ ScaleWidget() [2/2]

◆ vtkSlicerMarkupsWidgetCreateInstanceMacro()