Slicer  4.10
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Protected Slots | Protected Attributes
qSlicerSubjectHierarchySegmentsPlugin Class Reference

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

Inheritance diagram for qSlicerSubjectHierarchySegmentsPlugin:
Inheritance graph
[legend]
Collaboration diagram for qSlicerSubjectHierarchySegmentsPlugin:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

virtual double canOwnSubjectHierarchyItem (vtkIdType itemID) const
 
virtual double canReparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) const
 
virtual void editProperties (vtkIdType itemID)
 Open module belonging to item and set inputs in opened module. More...
 
virtual QColor getDisplayColor (vtkIdType itemID, QMap< int, QVariant > &terminologyMetaData) const
 
virtual 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...
 
virtual QIcon icon (vtkIdType itemID)
 
 qSlicerSubjectHierarchySegmentsPlugin (QObject *parent=NULL)
 
virtual bool reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID)
 
virtual Q_INVOKABLE const QString roleForPlugin () const
 
virtual void setDisplayColor (vtkIdType itemID, QColor color, QMap< int, QVariant > terminologyMetaData)
 
virtual void setDisplayVisibility (vtkIdType itemID, int visible)
 Set display visibility of a owned subject hierarchy item. More...
 
virtual void showVisibilityContextMenuActionsForItem (vtkIdType itemID)
 
virtual QString tooltip (vtkIdType itemID) const
 Generate tooltip for a owned subject hierarchy item. More...
 
virtual QList< QAction * > visibilityContextMenuActions () const
 
virtual QIcon visibilityIcon (int visible)
 Get visibility icon for a visibility state. More...
 
virtual ~qSlicerSubjectHierarchySegmentsPlugin ()
 
- 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 QString displayedItemName (vtkIdType itemID) const
 
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=NULL)
 
virtual Q_INVOKABLE QList< QAction * > sceneContextMenuActions () const
 
virtual void setName (QString name)
 
virtual Q_INVOKABLE void showContextMenuActionsForItem (vtkIdType itemID)
 
virtual ~qSlicerSubjectHierarchyAbstractPlugin ()
 

Protected Slots

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

Definition at line 40 of file qSlicerSubjectHierarchySegmentsPlugin.h.

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchySegmentsPlugin()

qSlicerSubjectHierarchySegmentsPlugin::qSlicerSubjectHierarchySegmentsPlugin ( QObject *  parent = NULL)

◆ ~qSlicerSubjectHierarchySegmentsPlugin()

virtual qSlicerSubjectHierarchySegmentsPlugin::~qSlicerSubjectHierarchySegmentsPlugin ( )
virtual

Member Function Documentation

◆ canOwnSubjectHierarchyItem()

virtual double qSlicerSubjectHierarchySegmentsPlugin::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
itemItem 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()

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

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
itemIDItem to be reparented in the hierarchy
parentItemIDProspective 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.

◆ editProperties()

virtual void qSlicerSubjectHierarchySegmentsPlugin::editProperties ( vtkIdType  itemID)
virtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ getDisplayColor()

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

Get display color of an owned subject hierarchy item

Parameters
terminologyMetaDataOutput map containing terminology meta data. Contents: qSlicerTerminologyItemDelegate::TerminologyRole : string qSlicerTerminologyItemDelegate::NameRole : string qSlicerTerminologyItemDelegate::NameAutoGeneratedRole : bool qSlicerTerminologyItemDelegate::ColorAutoGeneratedRole : bool

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ getDisplayVisibility()

virtual int qSlicerSubjectHierarchySegmentsPlugin::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.

◆ helpText()

virtual const QString qSlicerSubjectHierarchySegmentsPlugin::helpText ( ) const
virtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ icon()

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

◆ jumpSlices

void qSlicerSubjectHierarchySegmentsPlugin::jumpSlices ( )
protectedslot

Jump to slices in slice views to show current segment.

◆ reparentItemInsideSubjectHierarchy()

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

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

virtual Q_INVOKABLE const QString qSlicerSubjectHierarchySegmentsPlugin::roleForPlugin ( ) const
virtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ setDisplayColor()

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

Set display color of an owned subject hierarchy item

Parameters
colorDisplay color to set
terminologyMetaDataMap containing terminology meta data. Contents: qSlicerTerminologyItemDelegate::TerminologyRole : string qSlicerTerminologyItemDelegate::NameRole : string qSlicerTerminologyItemDelegate::NameAutoGeneratedRole : bool qSlicerTerminologyItemDelegate::ColorAutoGeneratedRole : bool

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ setDisplayVisibility()

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

Set display visibility of a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showAllSegments

void qSlicerSubjectHierarchySegmentsPlugin::showAllSegments ( )
protectedslot

Show all segments in segmentation.

◆ showOnlyCurrentSegment

void qSlicerSubjectHierarchySegmentsPlugin::showOnlyCurrentSegment ( )
protectedslot

Show only selected segment, hide all others in segmentation.

◆ showVisibilityContextMenuActionsForItem()

virtual void qSlicerSubjectHierarchySegmentsPlugin::showVisibilityContextMenuActionsForItem ( vtkIdType  itemID)
virtual

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

Parameters
itemIDSubject Hierarchy item to show the visibility context menu items for

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ tooltip()

virtual QString qSlicerSubjectHierarchySegmentsPlugin::tooltip ( vtkIdType  itemID) const
virtual

Generate tooltip for a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ visibilityContextMenuActions()

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

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

virtual QIcon qSlicerSubjectHierarchySegmentsPlugin::visibilityIcon ( int  visible)
virtual

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSubjectHierarchySegmentsPluginPrivate> qSlicerSubjectHierarchySegmentsPlugin::d_ptr
protected

Definition at line 130 of file qSlicerSubjectHierarchySegmentsPlugin.h.


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