#include <Modules/Loadable/Segmentations/SubjectHierarchyPlugins/qSlicerSubjectHierarchySegmentsPlugin.h>

Inheritance diagram for qSlicerSubjectHierarchySegmentsPlugin:

Collaboration diagram for qSlicerSubjectHierarchySegmentsPlugin:

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	canOwnSubjectHierarchyItem (vtkIdType itemID) const override

double	canReparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) 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

int	getDisplayVisibility (vtkIdType itemID) const override

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

QIcon	icon (vtkIdType itemID) override

QList< QAction * >	itemContextMenuActions () const override
	Get item context menu item actions to add to tree view. More...

	qSlicerSubjectHierarchySegmentsPlugin (QObject *parent=nullptr)

bool	reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) override

Q_INVOKABLE const QString	roleForPlugin () const override

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

void	setDisplayVisibility (vtkIdType itemID, int visible) override
	Set display visibility of a owned subject hierarchy item. More...

void	showContextMenuActionsForItem (vtkIdType itemID) override

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

void	showVisibilityContextMenuActionsForItem (vtkIdType itemID) override

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

QList< QAction * >	visibilityContextMenuActions () const override

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

	~qSlicerSubjectHierarchySegmentsPlugin () override

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

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

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

virtual QString	displayedItemName (vtkIdType itemID) const

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

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

	qSlicerSubjectHierarchyAbstractPlugin (QObject *parent=nullptr)

virtual Q_INVOKABLE QList< QAction * >	sceneContextMenuActions () const

virtual void	setName (QString name)

virtual Q_INVOKABLE void	showViewContextMenuActionsForItem (vtkIdType itemID, QVariantMap eventData)

virtual Q_INVOKABLE QList< QAction * >	viewContextMenuActions () const

	~qSlicerSubjectHierarchyAbstractPlugin () override

Protected Slots
void	cloneSegment ()
	Clone the selected segment. More...

void	jumpSlices ()
	Jump to slices in slice views to show current segment. More...

void	showAllSegments ()
	Show all segments in segmentation. More...

void	showOnlyCurrentSegment ()
	Show only selected segment, hide all others in segmentation. More...

Protected Attributes
QScopedPointer< qSlicerSubjectHierarchySegmentsPluginPrivate >	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 qSlicerSubjectHierarchySegmentsPlugin.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerSubjectHierarchyAbstractPlugin qSlicerSubjectHierarchySegmentsPlugin::Superclass

Definition at line 40 of file qSlicerSubjectHierarchySegmentsPlugin.h.

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchySegmentsPlugin()

qSlicerSubjectHierarchySegmentsPlugin::qSlicerSubjectHierarchySegmentsPlugin ( QObject * parent = nullptr )

◆ ~qSlicerSubjectHierarchySegmentsPlugin()

qSlicerSubjectHierarchySegmentsPlugin::~qSlicerSubjectHierarchySegmentsPlugin ( )

override

Member Function Documentation

◆ canOwnSubjectHierarchyItem()

double qSlicerSubjectHierarchySegmentsPlugin::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.

◆ canReparentItemInsideSubjectHierarchy()

double qSlicerSubjectHierarchySegmentsPlugin::canReparentItemInsideSubjectHierarchy	(	vtkIdType	itemID,
		vtkIdType	parentItemID
	)		const

overridevirtual

Determines if a subject hierarchy item can be reparented in the hierarchy using the current plugin, and gets a confidence value for the reparented item. Most plugins do not perform steps additional to the default, so the default implementation returns a 0 confidence value, which can be overridden in plugins that do handle special cases.

Parameters

itemID	Item to be reparented in the hierarchy
parentItemID	Prospective parent of the item to reparent.

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ cloneSegment

void qSlicerSubjectHierarchySegmentsPlugin::cloneSegment ( )

protectedslot

Clone the selected segment.

◆ editProperties()

void qSlicerSubjectHierarchySegmentsPlugin::editProperties ( vtkIdType itemID )

overridevirtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ getDisplayColor()

QColor qSlicerSubjectHierarchySegmentsPlugin::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.

◆ getDisplayVisibility()

int qSlicerSubjectHierarchySegmentsPlugin::getDisplayVisibility ( vtkIdType itemID ) const

overridevirtual

Get display visibility of a owned subject hierarchy item

Returns: Display visibility (0: hidden, 1: shown, 2: partially shown)

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ helpText()

const QString qSlicerSubjectHierarchySegmentsPlugin::helpText ( ) const

overridevirtual

Get help text for plugin to be added in subject hierarchy module widget help box.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ icon()

QIcon qSlicerSubjectHierarchySegmentsPlugin::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.

◆ itemContextMenuActions()

QList<QAction*> qSlicerSubjectHierarchySegmentsPlugin::itemContextMenuActions ( ) const

overridevirtual

Get item context menu item actions to add to tree view.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ jumpSlices

void qSlicerSubjectHierarchySegmentsPlugin::jumpSlices ( )

protectedslot

Jump to slices in slice views to show current segment.

◆ reparentItemInsideSubjectHierarchy()

bool qSlicerSubjectHierarchySegmentsPlugin::reparentItemInsideSubjectHierarchy	(	vtkIdType	itemID,
		vtkIdType	parentItemID
	)

overridevirtual

Reparent an item that was already in the subject hierarchy under a new parent.

Returns: True if reparented successfully, false otherwise

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ roleForPlugin()

Q_INVOKABLE const QString qSlicerSubjectHierarchySegmentsPlugin::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 qSlicerSubjectHierarchySegmentsPlugin::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.

◆ setDisplayVisibility()

void qSlicerSubjectHierarchySegmentsPlugin::setDisplayVisibility	(	vtkIdType	itemID,
		int	visible
	)

overridevirtual

Set display visibility of a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showAllSegments

void qSlicerSubjectHierarchySegmentsPlugin::showAllSegments ( )

protectedslot

Show all segments in segmentation.

◆ showContextMenuActionsForItem()

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

◆ showItemInView()

bool qSlicerSubjectHierarchySegmentsPlugin::showItemInView	(	vtkIdType	itemID,
		vtkMRMLAbstractViewNode *	viewNode,
		vtkIdList *	allItemsToShow
	)

overridevirtual

Show a segment item in a selected view. Overridden here to create closed surface representation for display in 3D views. Returns true on success. Implemented by calling the segmentation plugin.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showOnlyCurrentSegment

void qSlicerSubjectHierarchySegmentsPlugin::showOnlyCurrentSegment ( )

protectedslot

Show only selected segment, hide all others in segmentation.

◆ showVisibilityContextMenuActionsForItem()

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

◆ tooltip()

QString qSlicerSubjectHierarchySegmentsPlugin::tooltip ( vtkIdType itemID ) const

overridevirtual

Generate tooltip for a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ visibilityContextMenuActions()

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

overridevirtual

Get visibility context menu item actions to add to tree view. These item visibility context menu actions can be shown in the implementations of

See also: showVisibilityContextMenuActionsForItem

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ visibilityIcon()

QIcon qSlicerSubjectHierarchySegmentsPlugin::visibilityIcon ( int visible )

overridevirtual

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSubjectHierarchySegmentsPluginPrivate> qSlicerSubjectHierarchySegmentsPlugin::d_ptr

protected

Definition at line 146 of file qSlicerSubjectHierarchySegmentsPlugin.h.

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

Modules/Loadable/Segmentations/SubjectHierarchyPlugins/qSlicerSubjectHierarchySegmentsPlugin.h

Public Types

Public Member Functions

Protected Slots

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchySegmentsPlugin()

◆ ~qSlicerSubjectHierarchySegmentsPlugin()

Member Function Documentation

◆ canOwnSubjectHierarchyItem()

◆ canReparentItemInsideSubjectHierarchy()

◆ cloneSegment

◆ editProperties()

◆ getDisplayColor()

◆ getDisplayVisibility()

◆ helpText()

◆ icon()

◆ itemContextMenuActions()

◆ jumpSlices

◆ reparentItemInsideSubjectHierarchy()

◆ roleForPlugin()

◆ setDisplayColor()

◆ setDisplayVisibility()

◆ showAllSegments

◆ showContextMenuActionsForItem()

◆ showItemInView()

◆ showOnlyCurrentSegment

◆ showVisibilityContextMenuActionsForItem()

◆ tooltip()

◆ visibilityContextMenuActions()

◆ visibilityIcon()

Member Data Documentation

◆ d_ptr