qSlicerMarkupsPlaceWidget Class Reference

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

Inheritance diagram for qSlicerMarkupsPlaceWidget:

Collaboration diagram for qSlicerMarkupsPlaceWidget:

Public Types
enum	PlaceMultipleMarkupsType { ShowPlaceMultipleMarkupsOption, HidePlaceMultipleMarkupsOption, ForcePlaceSingleMarkup, ForcePlaceMultipleMarkups }
typedef qSlicerWidget	Superclass

Properties
bool	buttonsVisible
bool	currentNodeActive
QColor	defaultNodeColor
bool	deleteAllMarkupsOptionVisible
QColor	nodeColor
bool	placeModeEnabled
bool	placeModePersistency
PlaceMultipleMarkupsType	placeMultipleMarkups

Public Slots
void	deleteAllMarkups ()
void	deleteAllPoints ()
	Delete all points from the markups node. More...
void	deleteLastMarkup ()
void	deleteLastPoint ()
	Delete last placed markup point. More...
void	setButtonsVisible (bool visible)
	Show/hide all buttons. Useful for showing/hiding all buttons except specific ones. More...
void	setCurrentNode (vtkMRMLNode *currentNode)
	Set the currently selected markups node. More...
void	setCurrentNodeActive (bool active)
	Set the currently selected markups node to be the active markups node in the Slicer scene. Does not change place mode. More...
void	setDefaultNodeColor (QColor color)
void	setDeleteAllMarkupsOptionVisible (bool visible)
	Set visibility of Delete all markups option. More...
void	setInteractionNode (vtkMRMLInteractionNode *interactionNode)
void	setMRMLScene (vtkMRMLScene *scene) override
void	setNodeColor (QColor color)
void	setPlaceModeEnabled (bool enable)
	Enable/disable place mode. If place mode is enabled then current markups node is set active, too. More...
void	setPlaceModePersistency (bool)
	Set place mode to persistent (remains active until deactivated). Does not enable or disable placement mode. More...
void	setPlaceMultipleMarkups (PlaceMultipleMarkupsType option)
	Configures multiplicity of markups placement. More...
Public Slots inherited from qSlicerWidget
void	setMRMLScene (vtkMRMLScene *scene) override

Signals
void	activeMarkupsFiducialPlaceModeChanged (bool enabled)
void	activeMarkupsPlaceModeChanged (bool enabled)
Signals inherited from qSlicerWidget
void	mrmlSceneChanged (vtkMRMLScene *)

Public Member Functions
bool	buttonsVisible () const
	Returns true if all buttons are visible. More...
Q_INVOKABLE vtkMRMLMarkupsFiducialNode *	currentMarkupsFiducialNode () const
Q_INVOKABLE vtkMRMLMarkupsNode *	currentMarkupsNode () const
Q_INVOKABLE vtkMRMLNode *	currentNode () const
	Get the currently selected markups node. More...
bool	currentNodeActive () const
	Returns true if the current markups node is the active markups node in the scene. More...
QColor	defaultNodeColor () const
	Get the default node color that is shown when no node is selected. More...
bool	deleteAllMarkupsOptionVisible () const
	Returns true if the Delete all option on the Delete button is visible. More...
Q_INVOKABLE QToolButton *	deleteButton () const
Q_INVOKABLE vtkMRMLInteractionNode *	interactionNode () const
QColor	nodeColor () const
	Get the selected color of the currently selected markups node. More...
Q_INVOKABLE QToolButton *	placeButton () const
bool	placeModeEnabled () const
	Returns true if place mode enabled and current node is active. More...
bool	placeModePersistency () const
	Returns true if placement mode is persistent, regardless if place mode is enabled or not. More...
PlaceMultipleMarkupsType	placeMultipleMarkups () const
	Returns markup placement multiplicity option. More...
	qSlicerMarkupsPlaceWidget (QWidget *parent=nullptr)
	~qSlicerMarkupsPlaceWidget () override
Public Member Functions inherited from qSlicerWidget
vtkSlicerApplicationLogic *	appLogic () const
vtkMRMLAbstractLogic *	moduleLogic (const QString &moduleName) const
	qSlicerWidget (QWidget *parent=nullptr, Qt::WindowFlags f=nullptr)
	~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	onColorButtonChanged (QColor)
	Update the currently selected markups node to have its selected color changed. More...
void	onLockedButtonClicked ()
	Toggle whether the current markups node is locked. More...
void	onPlacePersistent (bool enable)
void	onVisibilityButtonClicked ()
	Toggle the visibility of the markups in the viewers. More...
void	updateWidget ()
	Update the GUI to reflect the currently selected markups node. More...

Protected Member Functions
virtual void	setup ()

Protected Attributes
QScopedPointer< qSlicerMarkupsPlaceWidgetPrivate >	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 40 of file qSlicerMarkupsPlaceWidget.h.

Member Typedef Documentation

Superclass

typedef qSlicerWidget qSlicerMarkupsPlaceWidget::Superclass

Definition at line 55 of file qSlicerMarkupsPlaceWidget.h.

Member Enumeration Documentation

PlaceMultipleMarkupsType

enum qSlicerMarkupsPlaceWidget::PlaceMultipleMarkupsType

Enumerator
ShowPlaceMultipleMarkupsOption
HidePlaceMultipleMarkupsOption
ForcePlaceSingleMarkup
ForcePlaceMultipleMarkups

Definition at line 59 of file qSlicerMarkupsPlaceWidget.h.

Property Documentation

buttonsVisible

bool qSlicerMarkupsPlaceWidget::buttonsVisible

readwrite

Definition at line 45 of file qSlicerMarkupsPlaceWidget.h.

currentNodeActive

bool qSlicerMarkupsPlaceWidget::currentNodeActive

readwrite

Definition at line 50 of file qSlicerMarkupsPlaceWidget.h.

defaultNodeColor

QColor qSlicerMarkupsPlaceWidget::defaultNodeColor

readwrite

Definition at line 49 of file qSlicerMarkupsPlaceWidget.h.

deleteAllMarkupsOptionVisible

bool qSlicerMarkupsPlaceWidget::deleteAllMarkupsOptionVisible

readwrite

Definition at line 46 of file qSlicerMarkupsPlaceWidget.h.

nodeColor

QColor qSlicerMarkupsPlaceWidget::nodeColor

readwrite

Definition at line 48 of file qSlicerMarkupsPlaceWidget.h.

placeModeEnabled

bool qSlicerMarkupsPlaceWidget::placeModeEnabled

readwrite

Definition at line 51 of file qSlicerMarkupsPlaceWidget.h.

placeModePersistency

bool qSlicerMarkupsPlaceWidget::placeModePersistency

readwrite

Definition at line 52 of file qSlicerMarkupsPlaceWidget.h.

placeMultipleMarkups

PlaceMultipleMarkupsType qSlicerMarkupsPlaceWidget::placeMultipleMarkups

readwrite

Definition at line 47 of file qSlicerMarkupsPlaceWidget.h.

Constructor & Destructor Documentation

qSlicerMarkupsPlaceWidget()

qSlicerMarkupsPlaceWidget::qSlicerMarkupsPlaceWidget

(

QWidget *

parent = nullptr

)

~qSlicerMarkupsPlaceWidget()

qSlicerMarkupsPlaceWidget::~qSlicerMarkupsPlaceWidget ( )

override

Member Function Documentation

activeMarkupsFiducialPlaceModeChanged

void qSlicerMarkupsPlaceWidget::activeMarkupsFiducialPlaceModeChanged ( bool  enabled )

signal

Deprecated:

Use activeMarkupsPlaceModeChanged instead.

activeMarkupsPlaceModeChanged

void qSlicerMarkupsPlaceWidget::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.

buttonsVisible()

bool qSlicerMarkupsPlaceWidget::buttonsVisible

(

)

const

Returns true if all buttons are visible.

currentMarkupsFiducialNode()

Q_INVOKABLE vtkMRMLMarkupsFiducialNode* qSlicerMarkupsPlaceWidget::currentMarkupsFiducialNode

(

)

const

currentMarkupsNode()

Q_INVOKABLE vtkMRMLMarkupsNode* qSlicerMarkupsPlaceWidget::currentMarkupsNode

(

)

const

currentNode()

Q_INVOKABLE vtkMRMLNode* qSlicerMarkupsPlaceWidget::currentNode

(

)

const

Get the currently selected markups node.

currentNodeActive()

bool qSlicerMarkupsPlaceWidget::currentNodeActive

(

)

const

Returns true if the current markups node is the active markups node in the scene.

defaultNodeColor()

QColor qSlicerMarkupsPlaceWidget::defaultNodeColor

(

)

const

Get the default node color that is shown when no node is selected.

deleteAllMarkups

void qSlicerMarkupsPlaceWidget::deleteAllMarkups ( )

slot

Deprecated:

Use deleteLastPoint instead.

deleteAllMarkupsOptionVisible()

bool qSlicerMarkupsPlaceWidget::deleteAllMarkupsOptionVisible

(

)

const

Returns true if the Delete all option on the Delete button is visible.

deleteAllPoints

void qSlicerMarkupsPlaceWidget::deleteAllPoints ( )

slot

Delete all points from the markups node.

deleteButton()

Q_INVOKABLE QToolButton* qSlicerMarkupsPlaceWidget::deleteButton

(

)

const

deleteLastMarkup

void qSlicerMarkupsPlaceWidget::deleteLastMarkup ( )

slot

Deprecated:

Use deleteLastPoint instead.

deleteLastPoint

void qSlicerMarkupsPlaceWidget::deleteLastPoint ( )

slot

Delete last placed markup point.

interactionNode()

Q_INVOKABLE vtkMRMLInteractionNode* qSlicerMarkupsPlaceWidget::interactionNode

(

)

const

Get interaction node.

See also

setInteractionNode()

nodeColor()

QColor qSlicerMarkupsPlaceWidget::nodeColor

(

)

const

Get the selected color of the currently selected markups node.

onColorButtonChanged

void qSlicerMarkupsPlaceWidget::onColorButtonChanged ( QColor  )

protectedslot

Update the currently selected markups node to have its selected color changed.

onLockedButtonClicked

void qSlicerMarkupsPlaceWidget::onLockedButtonClicked ( )

protectedslot

Toggle whether the current markups node is locked.

onPlacePersistent

void qSlicerMarkupsPlaceWidget::onPlacePersistent ( bool  enable )

protectedslot

onVisibilityButtonClicked

void qSlicerMarkupsPlaceWidget::onVisibilityButtonClicked ( )

protectedslot

Toggle the visibility of the markups in the viewers.

placeButton()

Q_INVOKABLE QToolButton* qSlicerMarkupsPlaceWidget::placeButton

(

)

const

placeModeEnabled()

bool qSlicerMarkupsPlaceWidget::placeModeEnabled

(

)

const

Returns true if place mode enabled and current node is active.

placeModePersistency()

bool qSlicerMarkupsPlaceWidget::placeModePersistency

(

)

const

Returns true if placement mode is persistent, regardless if place mode is enabled or not.

placeMultipleMarkups()

PlaceMultipleMarkupsType qSlicerMarkupsPlaceWidget::placeMultipleMarkups

(

)

const

Returns markup placement multiplicity option.

setButtonsVisible

void qSlicerMarkupsPlaceWidget::setButtonsVisible ( bool  visible )

slot

Show/hide all buttons. Useful for showing/hiding all buttons except specific ones.

setCurrentNode

void qSlicerMarkupsPlaceWidget::setCurrentNode ( vtkMRMLNode *  currentNode )

slot

Set the currently selected markups node.

setCurrentNodeActive

void qSlicerMarkupsPlaceWidget::setCurrentNodeActive ( bool  active )

slot

Set the currently selected markups node to be the active markups node in the Slicer scene. Does not change place mode.

setDefaultNodeColor

void qSlicerMarkupsPlaceWidget::setDefaultNodeColor ( QColor  color )

slot

setDeleteAllMarkupsOptionVisible

void qSlicerMarkupsPlaceWidget::setDeleteAllMarkupsOptionVisible ( bool  visible )

slot

Set visibility of Delete all markups option.

setInteractionNode

void qSlicerMarkupsPlaceWidget::setInteractionNode ( vtkMRMLInteractionNode *  interactionNode )

slot

Set interaction node used to update the widget.

See also

interactionNode()

setMRMLScene

void qSlicerMarkupsPlaceWidget::setMRMLScene ( vtkMRMLScene *  scene )

overrideslot

setNodeColor

void qSlicerMarkupsPlaceWidget::setNodeColor ( QColor  color )

slot

setPlaceModeEnabled

void qSlicerMarkupsPlaceWidget::setPlaceModeEnabled ( bool  enable )

slot

Enable/disable place mode. If place mode is enabled then current markups node is set active, too.

setPlaceModePersistency

void qSlicerMarkupsPlaceWidget::setPlaceModePersistency ( bool  )

slot

Set place mode to persistent (remains active until deactivated). Does not enable or disable placement mode.

setPlaceMultipleMarkups

void qSlicerMarkupsPlaceWidget::setPlaceMultipleMarkups ( PlaceMultipleMarkupsType  option )

slot

Configures multiplicity of markups placement.

setup()

virtual void qSlicerMarkupsPlaceWidget::setup ( )

protectedvirtual

updateWidget

void qSlicerMarkupsPlaceWidget::updateWidget ( )

protectedslot

Update the GUI to reflect the currently selected markups node.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerMarkupsPlaceWidgetPrivate> qSlicerMarkupsPlaceWidget::d_ptr

protected

Definition at line 174 of file qSlicerMarkupsPlaceWidget.h.

---

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

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