qSlicerSubjectHierarchyColorLegendPlugin Class Reference

#include <Modules/Loadable/Colors/SubjectHierarchyPlugins/qSlicerSubjectHierarchyColorLegendPlugin.h>

Inheritance diagram for qSlicerSubjectHierarchyColorLegendPlugin:

Collaboration diagram for qSlicerSubjectHierarchyColorLegendPlugin:

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
	qSlicerSubjectHierarchyColorLegendPlugin (QObject *parent=nullptr)
bool	showColorLegendInSlice (bool show, vtkIdType itemID, vtkMRMLSliceNode *sliceNode=nullptr)
bool	showColorLegendInView (bool show, vtkIdType itemID, vtkMRMLViewNode *viewNode=nullptr)
bool	showItemInView (vtkIdType itemID, vtkMRMLAbstractViewNode *viewNode, vtkIdList *allItemsToShow) override
void	showVisibilityContextMenuActionsForItem (vtkIdType itemID) override
QList< QAction * >	visibilityContextMenuActions () const override
	~qSlicerSubjectHierarchyColorLegendPlugin () override
Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
virtual Q_INVOKABLE bool	addNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID)
virtual Q_INVOKABLE 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.
virtual Q_INVOKABLE double	canOwnSubjectHierarchyItem (vtkIdType itemID) const
virtual Q_INVOKABLE double	canReparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) const
Q_INVOKABLE QColor	colorAndTerminologyFromDisplayableNode (vtkIdType itemID, QMap< int, QVariant > &terminologyMetaData, bool useSelectedColor) const
virtual Q_INVOKABLE QString	displayedItemName (vtkIdType itemID) const
virtual Q_INVOKABLE void	editProperties (vtkIdType itemID)
	Open module belonging to item and set inputs in opened module.
virtual Q_INVOKABLE QColor	getDisplayColor (vtkIdType itemID, QMap< int, QVariant > &terminologyMetaData) 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.
virtual Q_INVOKABLE QIcon	icon (vtkIdType itemID)
Q_INVOKABLE bool	isThisPluginOwnerOfItem (vtkIdType itemID) const
	Determines if the item is owned by this plugin.
virtual Q_INVOKABLE QList< QAction * >	itemContextMenuActions () const
virtual QString	name () const
	Get the name of the plugin.
	qSlicerSubjectHierarchyAbstractPlugin (QObject *parent=nullptr)
virtual Q_INVOKABLE bool	reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID)
virtual Q_INVOKABLE const QString	roleForPlugin () const
virtual Q_INVOKABLE QList< QAction * >	sceneContextMenuActions () const
Q_INVOKABLE void	setColorAndTerminologyToDisplayableNode (vtkIdType itemID, QColor color, QMap< int, QVariant > terminologyMetaData, bool useSelectedColor, bool disableScalarVisibility)
virtual Q_INVOKABLE void	setDisplayColor (vtkIdType itemID, QColor color, QMap< int, QVariant > terminologyMetaData)
virtual Q_INVOKABLE void	setDisplayVisibility (vtkIdType itemID, int visible)
	Set display visibility of an owned subject hierarchy item.
virtual void	setName (QString name)
virtual Q_INVOKABLE void	showContextMenuActionsForItem (vtkIdType itemID)
virtual Q_INVOKABLE void	showTransformContextMenuActionsForItem (vtkIdType itemID)
virtual Q_INVOKABLE void	showViewContextMenuActionsForItem (vtkIdType itemID, QVariantMap eventData)
virtual Q_INVOKABLE QString	tooltip (vtkIdType itemID) const
	Generate tooltip for a owned subject hierarchy item.
virtual Q_INVOKABLE QList< QAction * >	transformContextMenuActions () const
virtual Q_INVOKABLE QList< QAction * >	viewContextMenuActions () const
virtual Q_INVOKABLE QIcon	visibilityIcon (int visible)
	Get visibility icon for a visibility state.
	~qSlicerSubjectHierarchyAbstractPlugin () override

Protected Slots
void	toggleVisibilityForCurrentItem (bool)
	Toggle color legend option for current volume item.

Protected Attributes
QScopedPointer< qSlicerSubjectHierarchyColorLegendPluginPrivate >	d_ptr
Protected Attributes inherited from qSlicerSubjectHierarchyAbstractPlugin
QString	m_Name
	Name of the plugin.

Additional Inherited Members
Properties inherited from qSlicerSubjectHierarchyAbstractPlugin
QString	helpText
QString	name
Signals inherited from qSlicerSubjectHierarchyAbstractPlugin
void	requestExpandItem (vtkIdType itemID)
	Signal requesting expanding of the subject hierarchy tree item belonging to an item.
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 33 of file qSlicerSubjectHierarchyColorLegendPlugin.h.

Member Typedef Documentation

Superclass

typedef qSlicerSubjectHierarchyAbstractPlugin qSlicerSubjectHierarchyColorLegendPlugin::Superclass

Definition at line 39 of file qSlicerSubjectHierarchyColorLegendPlugin.h.

Constructor & Destructor Documentation

qSlicerSubjectHierarchyColorLegendPlugin()

qSlicerSubjectHierarchyColorLegendPlugin::qSlicerSubjectHierarchyColorLegendPlugin

(

QObject *

parent = nullptr

)

~qSlicerSubjectHierarchyColorLegendPlugin()

qSlicerSubjectHierarchyColorLegendPlugin::~qSlicerSubjectHierarchyColorLegendPlugin ( )

override

Member Function Documentation

showColorLegendInSlice()

bool qSlicerSubjectHierarchyColorLegendPlugin::showColorLegendInSlice	(	bool	show,
		vtkIdType	itemID,
		vtkMRMLSliceNode *	sliceNode = nullptr )

showColorLegendInView()

bool qSlicerSubjectHierarchyColorLegendPlugin::showColorLegendInView	(	bool	show,
		vtkIdType	itemID,
		vtkMRMLViewNode *	viewNode = nullptr )

Show/hide color legend in a view. If viewNode is nullptr then it is displayed in all views in the current layout.

showItemInView()

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

overridevirtual

Show an item in a selected view. Calls Volumes plugin's showItemInView implementation and adds support for showing a color legend in 2D and 3D views. Returns true on success.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

showVisibilityContextMenuActionsForItem()

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

toggleVisibilityForCurrentItem

void qSlicerSubjectHierarchyColorLegendPlugin::toggleVisibilityForCurrentItem ( bool )

protectedslot

Toggle color legend option for current volume item.

visibilityContextMenuActions()

QList< QAction * > qSlicerSubjectHierarchyColorLegendPlugin::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.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerSubjectHierarchyColorLegendPluginPrivate> qSlicerSubjectHierarchyColorLegendPlugin::d_ptr

protected

Definition at line 68 of file qSlicerSubjectHierarchyColorLegendPlugin.h.

---

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

• Modules/Loadable/Colors/SubjectHierarchyPlugins/qSlicerSubjectHierarchyColorLegendPlugin.h