#include <Modules/Loadable/Markups/SubjectHierarchyPlugins/qSlicerSubjectHierarchyMarkupsPlugin.h>

Inheritance diagram for qSlicerSubjectHierarchyMarkupsPlugin:

Collaboration diagram for qSlicerSubjectHierarchyMarkupsPlugin:

Public Types
typedef qSlicerSubjectHierarchyAbstractPlugin	Superclass

Public Types inherited from qSlicerSubjectHierarchyAbstractPlugin
enum	ActionSectionType { SectionTop = -400, SectionInteraction = -300, SectionComponent = -200, SectionNode = -100, SectionDefault = 0, SectionFolder = 100, SectionBottom = 200 }

typedef QObject	Superclass

Public Member Functions
double	canAddNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const override

double	canOwnSubjectHierarchyItem (vtkIdType itemID) const override

void	editProperties (vtkIdType itemID) override
	Open module belonging to item and set inputs in opened module. More...

QColor	getDisplayColor (vtkIdType itemID, QMap< int, QVariant > &terminologyMetaData) const override

QIcon	icon (vtkIdType itemID) override

	qSlicerSubjectHierarchyMarkupsPlugin (QObject *parent=nullptr)

Q_INVOKABLE const QString	roleForPlugin () const override

void	setDisplayColor (vtkIdType itemID, QColor color, QMap< int, QVariant > terminologyMetaData) override

void	showContextMenuActionsForItem (vtkIdType itemID) override

void	showViewContextMenuActionsForItem (vtkIdType itemID, QVariantMap eventData) override

void	showVisibilityContextMenuActionsForItem (vtkIdType itemID) override

QList< QAction * >	viewContextMenuActions () const override

QList< QAction * >	visibilityContextMenuActions () const override

QIcon	visibilityIcon (int visible) override
	Get visibility icon for a visibility state. More...

	~qSlicerSubjectHierarchyMarkupsPlugin () override

Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
virtual bool	addNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID)

virtual Q_INVOKABLE bool	canEditProperties (vtkIdType itemID)
	Returns true if the module can edit properties of this item using editProperties. More...

virtual double	canReparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) const

virtual QString	displayedItemName (vtkIdType itemID) const

virtual Q_INVOKABLE int	getDisplayVisibility (vtkIdType itemID) const

virtual const QString	helpText () const
	Get help text for plugin to be added in subject hierarchy module widget help box. More...

Q_INVOKABLE bool	isThisPluginOwnerOfItem (vtkIdType itemID) const
	Determines if the item is owned by this plugin. More...

virtual Q_INVOKABLE QList< QAction * >	itemContextMenuActions () const

virtual QString	name () const
	Get the name of the plugin. More...

	qSlicerSubjectHierarchyAbstractPlugin (QObject *parent=nullptr)

virtual bool	reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID)

virtual Q_INVOKABLE QList< QAction * >	sceneContextMenuActions () const

virtual Q_INVOKABLE void	setDisplayVisibility (vtkIdType itemID, int visible)
	Set display visibility of an owned subject hierarchy item. More...

virtual void	setName (QString name)

virtual bool	showItemInView (vtkIdType itemID, vtkMRMLAbstractViewNode viewNode, vtkIdList allItemsToShow)

virtual Q_INVOKABLE QString	tooltip (vtkIdType itemID) const
	Generate tooltip for a owned subject hierarchy item. More...

	~qSlicerSubjectHierarchyAbstractPlugin () override

Protected Slots
void	deletePoint ()
	Called when clicking on delete point action. More...

void	editNodeTerminology ()
	Called when clicking on edit terminology action. More...

void	jumpToClosestPoint ()
	Called when clicking on jump to closest point action. More...

void	jumpToNextPoint ()
	Called when clicking on jump to next point action. More...

void	jumpToPreviousPoint ()
	Called when clicking on jump to previous point action. More...

void	refocusCamera ()
	Called when clicking on refocus camera action. More...

void	removeNodesToBeDeleted ()

void	renamePoint ()
	Called when clicking on rename point action. More...

void	requestDeleteNode ()
	Called when clicking on delete node action. More...

void	toggleCurrentItemHandleInteractive ()
	toggle handle interactive for the current subject hierarchy item More...

void	toggleCurrentItemHandleTypeVisibility ()
	toggle the visibility of the interaction handle type for the current subject hierarchy item More...

void	toggleHandleInteractive ()
	Called when clicking on handle interactive action in view. More...

void	toggleHandleTypeVisibility ()
	toggle the visibility of the interaction handle type for the active node in view More...

void	toggleSelectPoint ()
	Called when clicking on toggle select point action. More...

Protected Attributes
QScopedPointer< qSlicerSubjectHierarchyMarkupsPluginPrivate >	d_ptr

Protected Attributes inherited from qSlicerSubjectHierarchyAbstractPlugin
QString	m_Name
	Name of the plugin. More...

Additional Inherited Members
Properties inherited from qSlicerSubjectHierarchyAbstractPlugin
QString	name

Signals inherited from qSlicerSubjectHierarchyAbstractPlugin
void	requestExpandItem (vtkIdType itemID)
	Signal requesting expanding of the subject hierarchy tree item belonging to an item. More...

void	requestInvalidateFilter () const

Static Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
static Q_INVOKABLE void	setActionPosition (QAction *action, int section, int weight=0, double weightAdjustment=0.0)

static Q_INVOKABLE qSlicerAbstractModuleWidget *	switchToModule (QString moduleName)

Protected Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
void	hideAllContextMenuActions () const

Detailed Description

Definition at line 34 of file qSlicerSubjectHierarchyMarkupsPlugin.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerSubjectHierarchyAbstractPlugin qSlicerSubjectHierarchyMarkupsPlugin::Superclass

Definition at line 40 of file qSlicerSubjectHierarchyMarkupsPlugin.h.

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchyMarkupsPlugin()

qSlicerSubjectHierarchyMarkupsPlugin::qSlicerSubjectHierarchyMarkupsPlugin ( QObject * parent = nullptr )

◆ ~qSlicerSubjectHierarchyMarkupsPlugin()

qSlicerSubjectHierarchyMarkupsPlugin::~qSlicerSubjectHierarchyMarkupsPlugin ( )

override

Member Function Documentation

◆ canAddNodeToSubjectHierarchy()

double qSlicerSubjectHierarchyMarkupsPlugin::canAddNodeToSubjectHierarchy	(	vtkMRMLNode *	node,
		vtkIdType	parentItemID = `vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID`
	)		const

overridevirtual

Determines if a data node can be placed in the hierarchy using the actual plugin, and gets a confidence value for a certain MRML node (usually the type and possibly attributes are checked).

Parameters

node	Node to be added to the hierarchy
parentItemID	Prospective parent of the node to add. Default value is invalid. In that case the parent will be ignored, the confidence numbers are got based on the to-be child node alone.

Returns: Floating point confidence number between 0 and 1, where 0 means that the plugin cannot handle the node, and 1 means that the plugin is the only one that can handle the node (by node type or identifier attribute)

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ canOwnSubjectHierarchyItem()

double qSlicerSubjectHierarchyMarkupsPlugin::canOwnSubjectHierarchyItem ( vtkIdType itemID ) const

overridevirtual

Determines if the actual plugin can handle a subject hierarchy item. The plugin with the highest confidence number will "own" the item in the subject hierarchy (set icon, tooltip, set context menu etc.)

Parameters

item	Item to handle in the subject hierarchy tree

Returns: Floating point confidence number between 0 and 1, where 0 means that the plugin cannot handle the item, and 1 means that the plugin is the only one that can handle the item (by node type or identifier attribute)

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ deletePoint

void qSlicerSubjectHierarchyMarkupsPlugin::deletePoint ( )

protectedslot

Called when clicking on delete point action.

◆ editNodeTerminology

void qSlicerSubjectHierarchyMarkupsPlugin::editNodeTerminology ( )

protectedslot

Called when clicking on edit terminology action.

◆ editProperties()

void qSlicerSubjectHierarchyMarkupsPlugin::editProperties ( vtkIdType itemID )

overridevirtual

Open module belonging to item and set inputs in opened module.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ getDisplayColor()

QColor qSlicerSubjectHierarchyMarkupsPlugin::getDisplayColor	(	vtkIdType	itemID,
		QMap< int, QVariant > &	terminologyMetaData
	)		const

overridevirtual

Get display color of an owned subject hierarchy item

Parameters

terminologyMetaData Output map containing terminology meta data. Contents: qSlicerTerminologyItemDelegate::TerminologyRole : string qSlicerTerminologyItemDelegate::NameRole : string qSlicerTerminologyItemDelegate::NameAutoGeneratedRole : bool qSlicerTerminologyItemDelegate::ColorAutoGeneratedRole : bool

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ icon()

QIcon qSlicerSubjectHierarchyMarkupsPlugin::icon ( vtkIdType itemID )

overridevirtual

Get icon of an owned subject hierarchy item

Returns: Icon to set, empty icon if nothing to set

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ jumpToClosestPoint

void qSlicerSubjectHierarchyMarkupsPlugin::jumpToClosestPoint ( )

protectedslot

Called when clicking on jump to closest point action.

◆ jumpToNextPoint

void qSlicerSubjectHierarchyMarkupsPlugin::jumpToNextPoint ( )

protectedslot

Called when clicking on jump to next point action.

◆ jumpToPreviousPoint

void qSlicerSubjectHierarchyMarkupsPlugin::jumpToPreviousPoint ( )

protectedslot

Called when clicking on jump to previous point action.

◆ refocusCamera

void qSlicerSubjectHierarchyMarkupsPlugin::refocusCamera ( )

protectedslot

Called when clicking on refocus camera action.

◆ removeNodesToBeDeleted

void qSlicerSubjectHierarchyMarkupsPlugin::removeNodesToBeDeleted ( )

protectedslot

Called by a timer to remove those nodes from the scene that were requested to be deleted. (because node cannot be deleted while a node event is being processed)

◆ renamePoint

void qSlicerSubjectHierarchyMarkupsPlugin::renamePoint ( )

protectedslot

Called when clicking on rename point action.

◆ requestDeleteNode

void qSlicerSubjectHierarchyMarkupsPlugin::requestDeleteNode ( )

protectedslot

Called when clicking on delete node action.

◆ roleForPlugin()

Q_INVOKABLE const QString qSlicerSubjectHierarchyMarkupsPlugin::roleForPlugin ( ) const

overridevirtual

Get role that the plugin assigns to the subject hierarchy item. Each plugin should provide only one role.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ setDisplayColor()

void qSlicerSubjectHierarchyMarkupsPlugin::setDisplayColor	(	vtkIdType	itemID,
		QColor	color,
		QMap< int, QVariant >	terminologyMetaData
	)

overridevirtual

Set display color of an owned subject hierarchy item

Parameters

color	Display color to set
terminologyMetaData	Map containing terminology meta data. Contents: qSlicerTerminologyItemDelegate::TerminologyRole : string qSlicerTerminologyItemDelegate::NameRole : string qSlicerTerminologyItemDelegate::NameAutoGeneratedRole : bool qSlicerTerminologyItemDelegate::ColorAutoGeneratedRole : bool

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showContextMenuActionsForItem()

void qSlicerSubjectHierarchyMarkupsPlugin::showContextMenuActionsForItem ( vtkIdType itemID )

overridevirtual

Show context menu actions valid for a given subject hierarchy item.

Parameters

itemID Subject Hierarchy item to show the context menu items for

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showViewContextMenuActionsForItem()

void qSlicerSubjectHierarchyMarkupsPlugin::showViewContextMenuActionsForItem	(	vtkIdType	itemID,
		QVariantMap	eventData
	)

overridevirtual

Show context menu actions valid for a given subject hierarchy item to be shown in the view.

Parameters

itemID	Subject Hierarchy item to show the context menu items for
eventData	Supplementary data for the item that may be considered for the menu (sub-item ID, attribute, etc.)

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showVisibilityContextMenuActionsForItem()

void qSlicerSubjectHierarchyMarkupsPlugin::showVisibilityContextMenuActionsForItem ( vtkIdType itemID )

overridevirtual

Show visibility context menu actions valid for a given subject hierarchy item.

Parameters

itemID Subject Hierarchy item to show the visibility context menu items for

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ toggleCurrentItemHandleInteractive

void qSlicerSubjectHierarchyMarkupsPlugin::toggleCurrentItemHandleInteractive ( )

protectedslot

toggle handle interactive for the current subject hierarchy item

◆ toggleCurrentItemHandleTypeVisibility

void qSlicerSubjectHierarchyMarkupsPlugin::toggleCurrentItemHandleTypeVisibility ( )

protectedslot

toggle the visibility of the interaction handle type for the current subject hierarchy item

◆ toggleHandleInteractive

void qSlicerSubjectHierarchyMarkupsPlugin::toggleHandleInteractive ( )

protectedslot

Called when clicking on handle interactive action in view.

◆ toggleHandleTypeVisibility

void qSlicerSubjectHierarchyMarkupsPlugin::toggleHandleTypeVisibility ( )

protectedslot

toggle the visibility of the interaction handle type for the active node in view

◆ toggleSelectPoint

void qSlicerSubjectHierarchyMarkupsPlugin::toggleSelectPoint ( )

protectedslot

Called when clicking on toggle select point action.

◆ viewContextMenuActions()

QList<QAction*> qSlicerSubjectHierarchyMarkupsPlugin::viewContextMenuActions ( ) const

overridevirtual

Get view context menu item actions that are available when right-clicking an object in the views. These item context menu actions can be shown in the implementations of

See also: showViewContextMenuActionsForItem

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ visibilityContextMenuActions()

QList<QAction*> qSlicerSubjectHierarchyMarkupsPlugin::visibilityContextMenuActions ( ) const

overridevirtual

Get view context menu item actions that are available when right-clicking an object in the views. These item context menu actions can be shown in the implementations of

See also: showViewContextMenuActionsForItem

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ visibilityIcon()

QIcon qSlicerSubjectHierarchyMarkupsPlugin::visibilityIcon ( int visible )

overridevirtual

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSubjectHierarchyMarkupsPluginPrivate> qSlicerSubjectHierarchyMarkupsPlugin::d_ptr

protected

Definition at line 145 of file qSlicerSubjectHierarchyMarkupsPlugin.h.

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

Modules/Loadable/Markups/SubjectHierarchyPlugins/qSlicerSubjectHierarchyMarkupsPlugin.h

Public Types

Public Member Functions

Protected Slots

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchyMarkupsPlugin()

◆ ~qSlicerSubjectHierarchyMarkupsPlugin()

Member Function Documentation

◆ canAddNodeToSubjectHierarchy()

◆ canOwnSubjectHierarchyItem()

◆ deletePoint

◆ editNodeTerminology

◆ editProperties()

◆ getDisplayColor()

◆ icon()

◆ jumpToClosestPoint

◆ jumpToNextPoint

◆ jumpToPreviousPoint

◆ refocusCamera

◆ removeNodesToBeDeleted

◆ renamePoint

◆ requestDeleteNode

◆ roleForPlugin()

◆ setDisplayColor()

◆ showContextMenuActionsForItem()

◆ showViewContextMenuActionsForItem()

◆ showVisibilityContextMenuActionsForItem()

◆ toggleCurrentItemHandleInteractive

◆ toggleCurrentItemHandleTypeVisibility

◆ toggleHandleInteractive

◆ toggleHandleTypeVisibility

◆ toggleSelectPoint

◆ viewContextMenuActions()

◆ visibilityContextMenuActions()

◆ visibilityIcon()

Member Data Documentation

◆ d_ptr