Slicer  5.0
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
qSlicerSubjectHierarchyTransformsPlugin Class Reference

#include <Modules/Loadable/Transforms/SubjectHierarchyPlugins/qSlicerSubjectHierarchyTransformsPlugin.h>

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

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 canAddNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const override
 
double canOwnSubjectHierarchyItem (vtkIdType itemID) const override
 
double canReparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) const override
 
QIcon icon (vtkIdType itemID) override
 
QList< QAction * > itemContextMenuActions () const override
 Get item context menu item actions to add to tree view. More...
 
 qSlicerSubjectHierarchyTransformsPlugin (QObject *parent=nullptr)
 
bool reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) override
 
Q_INVOKABLE const QString roleForPlugin () const override
 
void showContextMenuActionsForItem (vtkIdType itemID) 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...
 
 ~qSlicerSubjectHierarchyTransformsPlugin () override
 
- Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
virtual bool addNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID)
 
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
 
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 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. 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=nullptr)
 
virtual Q_INVOKABLE QList< QAction * > sceneContextMenuActions () const
 
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. More...
 
virtual void setName (QString name)
 
virtual bool showItemInView (vtkIdType itemID, vtkMRMLAbstractViewNode *viewNode, vtkIdList *allItemsToShow)
 
virtual Q_INVOKABLE void showViewContextMenuActionsForItem (vtkIdType itemID, QVariantMap eventData)
 
virtual Q_INVOKABLE QList< QAction * > viewContextMenuActions () const
 
 ~qSlicerSubjectHierarchyAbstractPlugin () override
 

Protected Slots

void identity ()
 Set transform to identity (only available for linear transforms) More...
 
void invert ()
 Invert selected transform. More...
 
void toggleInteractionBox (bool)
 Toggle interaction box. More...
 

Protected Attributes

QScopedPointer< qSlicerSubjectHierarchyTransformsPluginPrivate > 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 qSlicerAbstractModuleWidgetswitchToModule (QString moduleName)
 
- Protected Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
void hideAllContextMenuActions () const
 

Detailed Description

Definition at line 34 of file qSlicerSubjectHierarchyTransformsPlugin.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file qSlicerSubjectHierarchyTransformsPlugin.h.

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchyTransformsPlugin()

qSlicerSubjectHierarchyTransformsPlugin::qSlicerSubjectHierarchyTransformsPlugin ( QObject *  parent = nullptr)

◆ ~qSlicerSubjectHierarchyTransformsPlugin()

qSlicerSubjectHierarchyTransformsPlugin::~qSlicerSubjectHierarchyTransformsPlugin ( )
override

Member Function Documentation

◆ canAddNodeToSubjectHierarchy()

double qSlicerSubjectHierarchyTransformsPlugin::canAddNodeToSubjectHierarchy ( vtkMRMLNode node,
vtkIdType  parentItemID = vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID 
) const
overridevirtual

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

double qSlicerSubjectHierarchyTransformsPlugin::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
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()

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

◆ icon()

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

◆ identity

void qSlicerSubjectHierarchyTransformsPlugin::identity ( )
protectedslot

Set transform to identity (only available for linear transforms)

◆ invert

void qSlicerSubjectHierarchyTransformsPlugin::invert ( )
protectedslot

Invert selected transform.

◆ itemContextMenuActions()

QList<QAction*> qSlicerSubjectHierarchyTransformsPlugin::itemContextMenuActions ( ) const
overridevirtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ reparentItemInsideSubjectHierarchy()

bool qSlicerSubjectHierarchyTransformsPlugin::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 qSlicerSubjectHierarchyTransformsPlugin::roleForPlugin ( ) const
overridevirtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showContextMenuActionsForItem()

void qSlicerSubjectHierarchyTransformsPlugin::showContextMenuActionsForItem ( vtkIdType  itemID)
overridevirtual

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

void qSlicerSubjectHierarchyTransformsPlugin::showVisibilityContextMenuActionsForItem ( vtkIdType  itemID)
overridevirtual

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.

◆ toggleInteractionBox

void qSlicerSubjectHierarchyTransformsPlugin::toggleInteractionBox ( bool  )
protectedslot

Toggle interaction box.

◆ tooltip()

QString qSlicerSubjectHierarchyTransformsPlugin::tooltip ( vtkIdType  itemID) const
overridevirtual

Generate tooltip for a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ visibilityContextMenuActions()

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

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSubjectHierarchyTransformsPluginPrivate> qSlicerSubjectHierarchyTransformsPlugin::d_ptr
protected

Definition at line 118 of file qSlicerSubjectHierarchyTransformsPlugin.h.


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