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

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

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

Public Types

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

Public Slots

void onSegmentAdded (vtkObject *caller, void *callData)
 
void onSegmentModified (vtkObject *caller, void *callData)
 
void onSegmentRemoved (vtkObject *caller, void *callData)
 
void onSubjectHierarchyItemAboutToBeRemoved (vtkObject *caller, void *callData)
 
void onSubjectHierarchyItemModified (vtkObject *caller, void *callData)
 

Public Member Functions

virtual bool addNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID)
 Creates subject hierarchy item using default method and updates all segments. More...
 
virtual double canAddNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const
 
virtual double canOwnSubjectHierarchyItem (vtkIdType itemID) 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)
 
virtual QList< QAction * > itemContextMenuActions () const
 Get item context menu item actions to add to tree view. More...
 
 qSlicerSubjectHierarchySegmentationsPlugin (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)
 
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 ~qSlicerSubjectHierarchySegmentationsPlugin ()
 
- Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
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...
 
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 void setName (QString name)
 
virtual ~qSlicerSubjectHierarchyAbstractPlugin ()
 

Protected Slots

void exportToBinaryLabelmap ()
 Export to binary labelmap. More...
 
void exportToClosedSurface ()
 Export to closed surface. More...
 
void toggle2DFillVisibility (bool)
 Toggle 2D fill visibility for the current segmentation. More...
 
void toggle2DOutlineVisibility (bool)
 Toggle 2D outline visibility for the current segmentation. More...
 
void toggle3DVisibility (bool)
 Toggle 3D visibility for the current segmentation. More...
 

Protected Member Functions

void updateAllSegmentsFromMRML (vtkMRMLSegmentationNode *segmentationNode)
 
- Protected Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
void hideAllContextMenuActions () const
 

Protected Attributes

QScopedPointer< qSlicerSubjectHierarchySegmentationsPluginPrivate > 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)
 

Detailed Description

Definition at line 33 of file qSlicerSubjectHierarchySegmentationsPlugin.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file qSlicerSubjectHierarchySegmentationsPlugin.h.

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchySegmentationsPlugin()

qSlicerSubjectHierarchySegmentationsPlugin::qSlicerSubjectHierarchySegmentationsPlugin ( QObject *  parent = NULL)

◆ ~qSlicerSubjectHierarchySegmentationsPlugin()

virtual qSlicerSubjectHierarchySegmentationsPlugin::~qSlicerSubjectHierarchySegmentationsPlugin ( )
virtual

Member Function Documentation

◆ addNodeToSubjectHierarchy()

virtual bool qSlicerSubjectHierarchySegmentationsPlugin::addNodeToSubjectHierarchy ( vtkMRMLNode node,
vtkIdType  parentItemID 
)
virtual

Creates subject hierarchy item using default method and updates all segments.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ canAddNodeToSubjectHierarchy()

virtual double qSlicerSubjectHierarchySegmentationsPlugin::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
nodeNode to be added to the hierarchy
parentItemIDProspective 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 qSlicerSubjectHierarchySegmentationsPlugin::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.

◆ exportToBinaryLabelmap

void qSlicerSubjectHierarchySegmentationsPlugin::exportToBinaryLabelmap ( )
protectedslot

Export to binary labelmap.

◆ exportToClosedSurface

void qSlicerSubjectHierarchySegmentationsPlugin::exportToClosedSurface ( )
protectedslot

Export to closed surface.

◆ getDisplayVisibility()

virtual int qSlicerSubjectHierarchySegmentationsPlugin::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 qSlicerSubjectHierarchySegmentationsPlugin::helpText ( ) const
virtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ icon()

virtual QIcon qSlicerSubjectHierarchySegmentationsPlugin::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*> qSlicerSubjectHierarchySegmentationsPlugin::itemContextMenuActions ( ) const
virtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ onSegmentAdded

void qSlicerSubjectHierarchySegmentationsPlugin::onSegmentAdded ( vtkObject *  caller,
void *  callData 
)
slot

Called when segment is added in an observed segmentation node Adds per-segment subject hierarchy node

◆ onSegmentModified

void qSlicerSubjectHierarchySegmentationsPlugin::onSegmentModified ( vtkObject *  caller,
void *  callData 
)
slot

Called when segment is modified in an observed segmentation node. Renames per-segment subject hierarchy node if necessary

◆ onSegmentRemoved

void qSlicerSubjectHierarchySegmentationsPlugin::onSegmentRemoved ( vtkObject *  caller,
void *  callData 
)
slot

Called when segment is removed in an observed segmentation node. Removes per-segment subject hierarchy node

◆ onSubjectHierarchyItemAboutToBeRemoved

void qSlicerSubjectHierarchySegmentationsPlugin::onSubjectHierarchyItemAboutToBeRemoved ( vtkObject *  caller,
void *  callData 
)
slot

Called when a subject hierarchy item is about to be removed. Removes segment from parent segmentation if the removed item belongs to a segment

◆ onSubjectHierarchyItemModified

void qSlicerSubjectHierarchySegmentationsPlugin::onSubjectHierarchyItemModified ( vtkObject *  caller,
void *  callData 
)
slot

Called when a subject hierarchy item is modified. Renames segment if the modified item belongs to a segment

◆ roleForPlugin()

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

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ setDisplayVisibility()

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

Set display visibility of a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showContextMenuActionsForItem()

virtual void qSlicerSubjectHierarchySegmentationsPlugin::showContextMenuActionsForItem ( vtkIdType  itemID)
virtual

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

Parameters
itemIDSubject Hierarchy item to show the context menu items for

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showVisibilityContextMenuActionsForItem()

virtual void qSlicerSubjectHierarchySegmentationsPlugin::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.

◆ toggle2DFillVisibility

void qSlicerSubjectHierarchySegmentationsPlugin::toggle2DFillVisibility ( bool  )
protectedslot

Toggle 2D fill visibility for the current segmentation.

◆ toggle2DOutlineVisibility

void qSlicerSubjectHierarchySegmentationsPlugin::toggle2DOutlineVisibility ( bool  )
protectedslot

Toggle 2D outline visibility for the current segmentation.

◆ toggle3DVisibility

void qSlicerSubjectHierarchySegmentationsPlugin::toggle3DVisibility ( bool  )
protectedslot

Toggle 3D visibility for the current segmentation.

◆ tooltip()

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

Generate tooltip for a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ updateAllSegmentsFromMRML()

void qSlicerSubjectHierarchySegmentationsPlugin::updateAllSegmentsFromMRML ( vtkMRMLSegmentationNode segmentationNode)
protected

◆ visibilityContextMenuActions()

virtual QList<QAction*> qSlicerSubjectHierarchySegmentationsPlugin::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 qSlicerSubjectHierarchySegmentationsPlugin::visibilityIcon ( int  visible)
virtual

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSubjectHierarchySegmentationsPluginPrivate> qSlicerSubjectHierarchySegmentationsPlugin::d_ptr
protected

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