qSlicerSubjectHierarchyVolumesPlugin Class Reference

#include <Modules/Loadable/Volumes/SubjectHierarchyPlugins/qSlicerSubjectHierarchyVolumesPlugin.h>

Inheritance diagram for qSlicerSubjectHierarchyVolumesPlugin:

Collaboration diagram for qSlicerSubjectHierarchyVolumesPlugin:

Public Types
typedef qSlicerSubjectHierarchyAbstractPlugin	Superclass
Public Types inherited from qSlicerSubjectHierarchyAbstractPlugin
typedef QObject	Superclass

Public Member Functions
virtual double	canAddNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const
virtual double	canOwnSubjectHierarchyItem (vtkIdType itemID) const
void	collectShownVolumes (QSet< vtkIdType > &shownVolumeItemIDs, int layer=vtkMRMLApplicationLogic::BackgroundLayer|vtkMRMLApplicationLogic::ForegroundLayer|vtkMRMLApplicationLogic::LabelLayer) const
virtual int	getDisplayVisibility (vtkIdType itemID) const
void	hideVolumeFromAllViews (vtkMRMLScalarVolumeNode *node)
	Hide given volume from all layers of all slice views. More...
virtual QIcon	icon (vtkIdType itemID)
virtual QList< QAction * >	itemContextMenuActions () const
	Get item context menu item actions to add to tree view. More...
	qSlicerSubjectHierarchyVolumesPlugin (QObject *parent=NULL)
virtual Q_INVOKABLE const QString	roleForPlugin () const
virtual void	setDisplayVisibility (vtkIdType itemID, int visible)
	Set display visibility of a owned subject hierarchy item. More...
virtual void	showContextMenuActionsForItem (vtkIdType itemID)
void	showVolumeInAllViews (vtkMRMLScalarVolumeNode *node, int layer=vtkMRMLApplicationLogic::BackgroundLayer)
virtual QString	tooltip (vtkIdType itemID) const
	Generate tooltip for a owned subject hierarchy item. More...
virtual QIcon	visibilityIcon (int visible)
	Get visibility icon for a visibility state. More...
virtual	~qSlicerSubjectHierarchyVolumesPlugin ()
Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
virtual bool	addNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID)
virtual double	canReparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) const
virtual QString	displayedItemName (vtkIdType itemID) const
virtual Q_INVOKABLE void	editProperties (vtkIdType itemID)
	Open module belonging to item and set inputs in opened module. More...
virtual Q_INVOKABLE QColor	getDisplayColor (vtkIdType itemID, QMap< int, QVariant > &terminologyMetaData) 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 QString	name () const
	Get the name of the plugin. More...
	qSlicerSubjectHierarchyAbstractPlugin (QObject *parent=NULL)
virtual bool	reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID)
virtual Q_INVOKABLE QList< QAction * >	sceneContextMenuActions () const
virtual Q_INVOKABLE void	setDisplayColor (vtkIdType itemID, QColor color, QMap< int, QVariant > terminologyMetaData)
virtual void	setName (QString name)
virtual Q_INVOKABLE void	showVisibilityContextMenuActionsForItem (vtkIdType itemID)
virtual Q_INVOKABLE QList< QAction * >	visibilityContextMenuActions () const
virtual	~qSlicerSubjectHierarchyAbstractPlugin ()

Protected Slots
void	onLayoutChanged ()
void	onLayoutChanged (int layout)
	Variant of. More...
void	onSliceCompositeNodeModified ()
void	showVolumesInBranch ()

Protected Attributes
QScopedPointer< qSlicerSubjectHierarchyVolumesPluginPrivate >	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 qSlicerAbstractModuleWidget *	switchToModule (QString moduleName)
Protected Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
void	hideAllContextMenuActions () const

Detailed Description

Definition at line 47 of file qSlicerSubjectHierarchyVolumesPlugin.h.

Member Typedef Documentation

Superclass

typedef qSlicerSubjectHierarchyAbstractPlugin qSlicerSubjectHierarchyVolumesPlugin::Superclass

Definition at line 54 of file qSlicerSubjectHierarchyVolumesPlugin.h.

Constructor & Destructor Documentation

qSlicerSubjectHierarchyVolumesPlugin()

qSlicerSubjectHierarchyVolumesPlugin::qSlicerSubjectHierarchyVolumesPlugin

(

QObject *

parent = NULL

)

~qSlicerSubjectHierarchyVolumesPlugin()

virtual qSlicerSubjectHierarchyVolumesPlugin::~qSlicerSubjectHierarchyVolumesPlugin ( )

virtual

Member Function Documentation

canAddNodeToSubjectHierarchy()

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

virtual

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

virtual double qSlicerSubjectHierarchyVolumesPlugin::canOwnSubjectHierarchyItem ( vtkIdType  itemID ) const

virtual

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.

collectShownVolumes()

void qSlicerSubjectHierarchyVolumesPlugin::collectShownVolumes	(	QSet< vtkIdType > &	shownVolumeItemIDs,
		int	layer = vtkMRMLApplicationLogic::BackgroundLayer|vtkMRMLApplicationLogic::ForegroundLayer|vtkMRMLApplicationLogic::LabelLayer
	)		const

Collect subject hierarchy item IDs of all volumes that are shown in any slice view

Parameters

shownVolumeItemIDs	Output argument for subject hierarchy item IDs of shown volumes
layer	Layer(s) from which the shown volumes are collected. By default it's all layers

getDisplayVisibility()

virtual int qSlicerSubjectHierarchyVolumesPlugin::getDisplayVisibility ( vtkIdType  itemID ) const

virtual

Get display visibility of a owned subject hierarchy item

Returns

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

hideVolumeFromAllViews()

void qSlicerSubjectHierarchyVolumesPlugin::hideVolumeFromAllViews

(

vtkMRMLScalarVolumeNode *

node

)

Hide given volume from all layers of all slice views.

icon()

virtual QIcon qSlicerSubjectHierarchyVolumesPlugin::icon ( vtkIdType  itemID )

virtual

Get icon of an owned subject hierarchy item

Returns

Icon to set, empty icon if nothing to set

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

itemContextMenuActions()

virtual QList<QAction*> qSlicerSubjectHierarchyVolumesPlugin::itemContextMenuActions ( ) const

virtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

onLayoutChanged [1/2]

void qSlicerSubjectHierarchyVolumesPlugin::onLayoutChanged ( )

protectedslot

Re-connect slice composite node events so that visibility icons are updated when volumes are shown/hidden from outside subject hierarchy

onLayoutChanged [2/2]

void qSlicerSubjectHierarchyVolumesPlugin::onLayoutChanged ( int  layout )

protectedslot

Variant of.

See also

onLayoutChanged so that it can be connected to the event which has the layout as parameter

onSliceCompositeNodeModified

void qSlicerSubjectHierarchyVolumesPlugin::onSliceCompositeNodeModified ( )

protectedslot

Trigger updating all volume visibility icons when composite node changes Note: Update all and not just the volumes in the composite node, because it is impossible to know after a Modified event if a volume was hidden in the process

roleForPlugin()

virtual Q_INVOKABLE const QString qSlicerSubjectHierarchyVolumesPlugin::roleForPlugin ( ) const

virtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

setDisplayVisibility()

virtual void qSlicerSubjectHierarchyVolumesPlugin::setDisplayVisibility ( vtkIdType  itemID, int  visible  )

virtual

Set display visibility of a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

showContextMenuActionsForItem()

virtual void qSlicerSubjectHierarchyVolumesPlugin::showContextMenuActionsForItem ( vtkIdType  itemID )

virtual

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.

showVolumeInAllViews()

void qSlicerSubjectHierarchyVolumesPlugin::showVolumeInAllViews	(	vtkMRMLScalarVolumeNode *	node,
		int	layer = vtkMRMLApplicationLogic::BackgroundLayer
	)

Show volume in all slice views. The argument node replaces any volume shown on the specified layer

Parameters

node	Volume node to show
layer	Layer to show volume on. Only one layer can be specified. By default it's the background layer

showVolumesInBranch

void qSlicerSubjectHierarchyVolumesPlugin::showVolumesInBranch ( )

protectedslot

Show volumes in study. The first two scalar volumes are shown if there are more. Hides other volumes if there are less in the current study.

tooltip()

virtual QString qSlicerSubjectHierarchyVolumesPlugin::tooltip ( vtkIdType  itemID ) const

virtual

Generate tooltip for a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

visibilityIcon()

virtual QIcon qSlicerSubjectHierarchyVolumesPlugin::visibilityIcon ( int  visible )

virtual

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerSubjectHierarchyVolumesPluginPrivate> qSlicerSubjectHierarchyVolumesPlugin::d_ptr

protected

Definition at line 138 of file qSlicerSubjectHierarchyVolumesPlugin.h.

---

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

• Modules/Loadable/Volumes/SubjectHierarchyPlugins/qSlicerSubjectHierarchyVolumesPlugin.h