qSlicerSimpleMarkupsWidget Class Reference

#include <Modules/Loadable/Markups/Widgets/qSlicerSimpleMarkupsWidget.h>

Inheritance diagram for qSlicerSimpleMarkupsWidget:

Collaboration diagram for qSlicerSimpleMarkupsWidget:

Public Types
typedef qSlicerWidget	Superclass

Properties
QColor	defaultNodeColor
bool	enterPlaceModeOnNodeChange
bool	jumpToSliceEnabled
QColor	nodeColor
bool	nodeSelectorVisible
bool	optionsVisible
int	viewGroup

Public Slots
void	activate ()
	Set the currently selected markups node to be the active markups node in the Slicer scene. More...
void	highlightNthControlPoint (int n)
	Scrolls to and selects the Nth control point in the table of control points. More...
void	highlightNthFiducial (int n)
void	placeActive (bool place)
	Set the currently selected markups node to be the active markups node in the Slicer scene. The argument place is true then also interaction mode is set to place mode. More...
void	setCurrentNode (vtkMRMLNode *currentNode)
	Set the currently selected markups node. More...
void	setDefaultNodeColor (QColor color)
	Set the default color that is assigned to newly created markups nodes in the combo box. More...
void	setEnterPlaceModeOnNodeChange (bool)
	Accessors to control place mode behavior. More...
void	setInteractionNode (vtkMRMLInteractionNode *interactionNode)
void	setJumpToSliceEnabled (bool)
	If enabled then the control point will be shown in all slice views when a control point is selected. More...
void	setMRMLScene (vtkMRMLScene *scene) override
void	setNodeBaseName (const QString &newNodeBaseName)
	Set the default name of the markups node created in the combo box. More...
void	setNodeColor (QColor color)
	Set the selected color of the currently selected markups node. More...
void	setNodeSelectorVisible (bool)
	Show/hide the markup node selector widget. More...
void	setOptionsVisible (bool)
	Show/hide options (place, activate, color, etc buttons). More...
Public Slots inherited from qSlicerWidget
void	setMRMLScene (vtkMRMLScene *scene) override

Signals
void	activeMarkupsFiducialPlaceModeChanged (bool enabled)
void	activeMarkupsPlaceModeChanged (bool enabled)
void	currentMarkupsControlPointSelectionChanged (int markupIndex)
void	currentMarkupsFiducialSelectionChanged (int markupIndex)
void	markupsFiducialNodeChanged ()
void	markupsNodeChanged ()
	The signal is emitted when a different markup node is selected. More...
void	updateFinished ()
Signals inherited from qSlicerWidget
void	mrmlSceneChanged (vtkMRMLScene *)

Public Member Functions
Q_INVOKABLE vtkMRMLNode *	currentNode () const
	Get the currently selected markups node. More...
QColor	defaultNodeColor () const
	Get the default node color that is applied to newly created nodes. More...
bool	enterPlaceModeOnNodeChange () const
	Accessors to control place mode behavior. More...
Q_INVOKABLE vtkMRMLNode *	getCurrentNode ()
Q_INVOKABLE vtkMRMLInteractionNode *	interactionNode () const
bool	jumpToSliceEnabled () const
Q_INVOKABLE qSlicerMarkupsPlaceWidget *	markupsPlaceWidget () const
	Get the markups placement widget (containing place and delete button) More...
Q_INVOKABLE qMRMLNodeComboBox *	markupsSelectorComboBox () const
	Get the markup node selector combo box. More...
QColor	nodeColor () const
	Get the selected color of the currently selected markups node. More...
bool	nodeSelectorVisible () const
	Show/hide the markup node selector widget. More...
bool	optionsVisible () const
	Show/hide options (place, activate, color, etc buttons). More...
	qSlicerSimpleMarkupsWidget (QWidget *parent=nullptr)
void	setViewGroup (int newViewGroup)
Q_INVOKABLE QTableWidget *	tableWidget () const
	Get the markups table widget. More...
int	viewGroup () const
	Get view group where slice positions will be updated. More...
	~qSlicerSimpleMarkupsWidget () override
Public Member Functions inherited from qSlicerWidget
vtkSlicerApplicationLogic *	appLogic () const
vtkMRMLAbstractLogic *	moduleLogic (const QString &moduleName) const
	qSlicerWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	~qSlicerWidget () override
Public Member Functions inherited from qSlicerObject
vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene. More...
	qSlicerObject ()
virtual void	setMRMLScene (vtkMRMLScene *)
	Set the current MRML scene to the widget. More...
virtual	~qSlicerObject ()

Protected Slots
void	onMarkupsControlPointEdited (int row, int column)
	Edit the name or position of the currently selected markups node. More...
void	onMarkupsControlPointSelected (int row, int column)
	Clicked on a control point or used keyboard to move between control points in the table. More...
void	onMarkupsControlPointsTableContextMenu (const QPoint &position)
	Create context menu for the table displaying the currently selected markups node. More...
void	onMarkupsNodeAdded (vtkMRMLNode *)
	Setup a newly created markups node - add display node, set color. More...
void	onMarkupsNodeChanged ()
	Update the widget when a different markups node is selected by the combo box. More...
void	onPointAdded ()
	Update the GUI to reflect the currently selected markups node. More...
void	updateWidget ()
	Update the GUI to reflect the currently selected markups node. More...

Protected Member Functions
virtual void	setup ()

Protected Attributes
QScopedPointer< qSlicerSimpleMarkupsWidgetPrivate >	d_ptr
Protected Attributes inherited from qSlicerWidget
QScopedPointer< qSlicerWidgetPrivate >	d_ptr
Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate >	d_ptr

Detailed Description

Definition at line 37 of file qSlicerSimpleMarkupsWidget.h.

Member Typedef Documentation

Superclass

typedef qSlicerWidget qSlicerSimpleMarkupsWidget::Superclass

Definition at line 50 of file qSlicerSimpleMarkupsWidget.h.

Property Documentation

defaultNodeColor

QColor qSlicerSimpleMarkupsWidget::defaultNodeColor

readwrite

Definition at line 46 of file qSlicerSimpleMarkupsWidget.h.

enterPlaceModeOnNodeChange

bool qSlicerSimpleMarkupsWidget::enterPlaceModeOnNodeChange

readwrite

Definition at line 41 of file qSlicerSimpleMarkupsWidget.h.

jumpToSliceEnabled

bool qSlicerSimpleMarkupsWidget::jumpToSliceEnabled

readwrite

Definition at line 42 of file qSlicerSimpleMarkupsWidget.h.

nodeColor

QColor qSlicerSimpleMarkupsWidget::nodeColor

readwrite

Definition at line 45 of file qSlicerSimpleMarkupsWidget.h.

nodeSelectorVisible

bool qSlicerSimpleMarkupsWidget::nodeSelectorVisible

readwrite

Definition at line 43 of file qSlicerSimpleMarkupsWidget.h.

optionsVisible

bool qSlicerSimpleMarkupsWidget::optionsVisible

readwrite

Definition at line 44 of file qSlicerSimpleMarkupsWidget.h.

viewGroup

int qSlicerSimpleMarkupsWidget::viewGroup

readwrite

Definition at line 47 of file qSlicerSimpleMarkupsWidget.h.

Constructor & Destructor Documentation

qSlicerSimpleMarkupsWidget()

qSlicerSimpleMarkupsWidget::qSlicerSimpleMarkupsWidget

(

QWidget *

parent = nullptr

)

~qSlicerSimpleMarkupsWidget()

qSlicerSimpleMarkupsWidget::~qSlicerSimpleMarkupsWidget ( )

override

Member Function Documentation

activate

void qSlicerSimpleMarkupsWidget::activate ( )

slot

Set the currently selected markups node to be the active markups node in the Slicer scene.

activeMarkupsFiducialPlaceModeChanged

void qSlicerSimpleMarkupsWidget::activeMarkupsFiducialPlaceModeChanged ( bool  enabled )

signal

Deprecated:

Use activeMarkupsPlaceModeChanged instead

activeMarkupsPlaceModeChanged

void qSlicerSimpleMarkupsWidget::activeMarkupsPlaceModeChanged ( bool  enabled )

signal

This signal is emitted when place mode for the active markup is changed to enabled or disabled. The argument enabled is true if the currently selected markups node is active and in place mode. The argument enabled is false if the currently selected markups node is not active or not in place mode.

currentMarkupsControlPointSelectionChanged

void qSlicerSimpleMarkupsWidget::currentMarkupsControlPointSelectionChanged ( int  markupIndex )

signal

This signal is emitted when a different markup point is selected in the table. The argument markupIndex is the index of the selected markup.

currentMarkupsFiducialSelectionChanged

void qSlicerSimpleMarkupsWidget::currentMarkupsFiducialSelectionChanged ( int  markupIndex )

signal

Deprecated:

Use currentMarkupsControlPointSelectionChanged instead

currentNode()

Q_INVOKABLE vtkMRMLNode* qSlicerSimpleMarkupsWidget::currentNode

(

)

const

Get the currently selected markups node.

defaultNodeColor()

QColor qSlicerSimpleMarkupsWidget::defaultNodeColor

(

)

const

Get the default node color that is applied to newly created nodes.

enterPlaceModeOnNodeChange()

bool qSlicerSimpleMarkupsWidget::enterPlaceModeOnNodeChange

(

)

const

Accessors to control place mode behavior.

getCurrentNode()

Q_INVOKABLE vtkMRMLNode* qSlicerSimpleMarkupsWidget::getCurrentNode

(

)

Deprecated:

Use currentNode() instead.

highlightNthControlPoint

void qSlicerSimpleMarkupsWidget::highlightNthControlPoint ( int  n )

slot

Scrolls to and selects the Nth control point in the table of control points.

highlightNthFiducial

void qSlicerSimpleMarkupsWidget::highlightNthFiducial ( int  n )

slot

Deprecated:

Use highlightNthControlPoint instead

interactionNode()

Q_INVOKABLE vtkMRMLInteractionNode* qSlicerSimpleMarkupsWidget::interactionNode

(

)

const

Get interaction node.

See also

setInteractionNode()

jumpToSliceEnabled()

bool qSlicerSimpleMarkupsWidget::jumpToSliceEnabled

(

)

const

If enabled then the control point will be shown in all slice views when a caontrol point is selected /sa setViewGroup

markupsFiducialNodeChanged

void qSlicerSimpleMarkupsWidget::markupsFiducialNodeChanged ( )

signal

Deprecated:

Use markupsNodeChanged instead.

markupsNodeChanged

void qSlicerSimpleMarkupsWidget::markupsNodeChanged ( )

signal

The signal is emitted when a different markup node is selected.

markupsPlaceWidget()

Q_INVOKABLE qSlicerMarkupsPlaceWidget* qSlicerSimpleMarkupsWidget::markupsPlaceWidget

(

)

const

Get the markups placement widget (containing place and delete button)

markupsSelectorComboBox()

Q_INVOKABLE qMRMLNodeComboBox* qSlicerSimpleMarkupsWidget::markupsSelectorComboBox

(

)

const

Get the markup node selector combo box.

nodeColor()

QColor qSlicerSimpleMarkupsWidget::nodeColor

(

)

const

Get the selected color of the currently selected markups node.

nodeSelectorVisible()

bool qSlicerSimpleMarkupsWidget::nodeSelectorVisible

(

)

const

Show/hide the markup node selector widget.

onMarkupsControlPointEdited

void qSlicerSimpleMarkupsWidget::onMarkupsControlPointEdited ( int  row, int  column  )

protectedslot

Edit the name or position of the currently selected markups node.

onMarkupsControlPointSelected

void qSlicerSimpleMarkupsWidget::onMarkupsControlPointSelected ( int  row, int  column  )

protectedslot

Clicked on a control point or used keyboard to move between control points in the table.

onMarkupsControlPointsTableContextMenu

void qSlicerSimpleMarkupsWidget::onMarkupsControlPointsTableContextMenu ( const QPoint &  position )

protectedslot

Create context menu for the table displaying the currently selected markups node.

onMarkupsNodeAdded

void qSlicerSimpleMarkupsWidget::onMarkupsNodeAdded ( vtkMRMLNode *  )

protectedslot

Setup a newly created markups node - add display node, set color.

onMarkupsNodeChanged

void qSlicerSimpleMarkupsWidget::onMarkupsNodeChanged ( )

protectedslot

Update the widget when a different markups node is selected by the combo box.

onPointAdded

void qSlicerSimpleMarkupsWidget::onPointAdded ( )

protectedslot

Update the GUI to reflect the currently selected markups node.

optionsVisible()

bool qSlicerSimpleMarkupsWidget::optionsVisible

(

)

const

Show/hide options (place, activate, color, etc buttons).

placeActive

void qSlicerSimpleMarkupsWidget::placeActive ( bool  place )

slot

Set the currently selected markups node to be the active markups node in the Slicer scene. The argument place is true then also interaction mode is set to place mode.

setCurrentNode

void qSlicerSimpleMarkupsWidget::setCurrentNode ( vtkMRMLNode *  currentNode )

slot

Set the currently selected markups node.

setDefaultNodeColor

void qSlicerSimpleMarkupsWidget::setDefaultNodeColor ( QColor  color )

slot

Set the default color that is assigned to newly created markups nodes in the combo box.

setEnterPlaceModeOnNodeChange

void qSlicerSimpleMarkupsWidget::setEnterPlaceModeOnNodeChange ( bool  )

slot

Accessors to control place mode behavior.

setInteractionNode

void qSlicerSimpleMarkupsWidget::setInteractionNode ( vtkMRMLInteractionNode *  interactionNode )

slot

Set interaction node used to update the widget.

See also

interactionNode()

setJumpToSliceEnabled

void qSlicerSimpleMarkupsWidget::setJumpToSliceEnabled ( bool  )

slot

If enabled then the control point will be shown in all slice views when a control point is selected.

setMRMLScene

void qSlicerSimpleMarkupsWidget::setMRMLScene ( vtkMRMLScene *  scene )

overrideslot

setNodeBaseName

void qSlicerSimpleMarkupsWidget::setNodeBaseName ( const QString &  newNodeBaseName )

slot

Set the default name of the markups node created in the combo box.

setNodeColor

void qSlicerSimpleMarkupsWidget::setNodeColor ( QColor  color )

slot

Set the selected color of the currently selected markups node.

setNodeSelectorVisible

void qSlicerSimpleMarkupsWidget::setNodeSelectorVisible ( bool  )

slot

Show/hide the markup node selector widget.

setOptionsVisible

void qSlicerSimpleMarkupsWidget::setOptionsVisible ( bool  )

slot

Show/hide options (place, activate, color, etc buttons).

setup()

virtual void qSlicerSimpleMarkupsWidget::setup ( )

protectedvirtual

setViewGroup()

void qSlicerSimpleMarkupsWidget::setViewGroup

(

int

newViewGroup

)

Set views where slice positions will be updated on jump to slice. If it is set to -1 (by default it is) then all slices will be jumped.

tableWidget()

Q_INVOKABLE QTableWidget* qSlicerSimpleMarkupsWidget::tableWidget

(

)

const

Get the markups table widget.

updateFinished

void qSlicerSimpleMarkupsWidget::updateFinished ( )

signal

This signal is emitted if updates to the widget have finished. It is called after control points are changed (added, position modified, etc).

updateWidget

void qSlicerSimpleMarkupsWidget::updateWidget ( )

protectedslot

Update the GUI to reflect the currently selected markups node.

viewGroup()

int qSlicerSimpleMarkupsWidget::viewGroup

(

)

const

Get view group where slice positions will be updated.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerSimpleMarkupsWidgetPrivate> qSlicerSimpleMarkupsWidget::d_ptr

protected

Definition at line 192 of file qSlicerSimpleMarkupsWidget.h.

---

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

• Modules/Loadable/Markups/Widgets/qSlicerSimpleMarkupsWidget.h