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

Inheritance diagram for qSlicerSubjectHierarchyTransformsPlugin:

[legend]

Collaboration diagram for qSlicerSubjectHierarchyTransformsPlugin:

[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.

	qSlicerSubjectHierarchyTransformsPlugin (QObject *parent=nullptr)

bool	reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) override

Q_INVOKABLE const QString	roleForPlugin () const override

void	showContextMenuActionsForItem (vtkIdType itemID) override

void	showTransformContextMenuActionsForItem (vtkIdType itemID) override
	Show context menu actions valid for given subject hierarchy item.

void	showViewContextMenuActionsForItem (vtkIdType itemID, QVariantMap eventData) override

void	showVisibilityContextMenuActionsForItem (vtkIdType itemID) override

QString	tooltip (vtkIdType itemID) const override
	Generate tooltip for a owned subject hierarchy item.

QList< QAction * >	transformContextMenuActions () const override

int	transformListSection () const

QList< QAction * >	viewContextMenuActions () const override

QList< QAction * >	visibilityContextMenuActions () const override

QIcon	visibilityIcon (int visible) override
	Get visibility icon for a visibility state.

	~qSlicerSubjectHierarchyTransformsPlugin () override

Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
virtual Q_INVOKABLE 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.

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.

Q_INVOKABLE bool	isThisPluginOwnerOfItem (vtkIdType itemID) const
	Determines if the item is owned by this plugin.

virtual QString	name () const
	Get the name of the plugin.

	qSlicerSubjectHierarchyAbstractPlugin (QObject *parent=nullptr)

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 bool	showItemInView (vtkIdType itemID, vtkMRMLAbstractViewNode viewNode, vtkIdList allItemsToShow)

	~qSlicerSubjectHierarchyAbstractPlugin () override

Protected Slots
void	identity ()
	Set transform to identity (only available for linear transforms)

void	invert ()
	Invert selected transform.

virtual void	onCreateNewTransform ()

virtual void	onHardenTransformOnBranchOfCurrentItem ()

virtual void	onRemoveTransformsFromBranchOfCurrentItem ()

virtual void	onTransformActionSelected ()

virtual void	onTransformEditProperties ()

virtual void	onTransformInteractionInViewToggled (bool show)

void	resetCenterOfTransformationAllTransformedNodeBounds ()

void	resetCenterOfTransformationLocal ()
	Reset the center of transformation.

void	resetCenterOfTransformationTransformedNodeBounds ()

void	resetCenterOfTransformationWorld ()

void	toggleCurrentItemHandleTypeVisibility (bool)

void	toggleInteractionBox (bool)
	Toggle interaction box.

Protected Attributes
QScopedPointer< qSlicerSubjectHierarchyTransformsPluginPrivate >	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 qSlicerSubjectHierarchyTransformsPlugin.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerSubjectHierarchyAbstractPlugin qSlicerSubjectHierarchyTransformsPlugin::Superclass

Definition at line 39 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

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

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

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.

◆ 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

itemID	Item to be reparented in the hierarchy
parentItemID	Prospective 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.

◆ onCreateNewTransform

virtual void qSlicerSubjectHierarchyTransformsPlugin::onCreateNewTransform ( )

protectedvirtualslot

◆ onHardenTransformOnBranchOfCurrentItem

virtual void qSlicerSubjectHierarchyTransformsPlugin::onHardenTransformOnBranchOfCurrentItem ( )

protectedvirtualslot

◆ onRemoveTransformsFromBranchOfCurrentItem

virtual void qSlicerSubjectHierarchyTransformsPlugin::onRemoveTransformsFromBranchOfCurrentItem ( )

protectedvirtualslot

◆ onTransformActionSelected

virtual void qSlicerSubjectHierarchyTransformsPlugin::onTransformActionSelected ( )

protectedvirtualslot

◆ onTransformEditProperties

virtual void qSlicerSubjectHierarchyTransformsPlugin::onTransformEditProperties ( )

protectedvirtualslot

◆ onTransformInteractionInViewToggled

virtual void qSlicerSubjectHierarchyTransformsPlugin::onTransformInteractionInViewToggled ( bool show )

protectedvirtualslot

◆ 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.

◆ resetCenterOfTransformationAllTransformedNodeBounds

void qSlicerSubjectHierarchyTransformsPlugin::resetCenterOfTransformationAllTransformedNodeBounds ( )

protectedslot

◆ resetCenterOfTransformationLocal

void qSlicerSubjectHierarchyTransformsPlugin::resetCenterOfTransformationLocal ( )

protectedslot

Reset the center of transformation.

◆ resetCenterOfTransformationTransformedNodeBounds

void qSlicerSubjectHierarchyTransformsPlugin::resetCenterOfTransformationTransformedNodeBounds ( )

protectedslot

◆ resetCenterOfTransformationWorld

void qSlicerSubjectHierarchyTransformsPlugin::resetCenterOfTransformationWorld ( )

protectedslot

◆ 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

itemID Subject Hierarchy item to show the context menu items for

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showTransformContextMenuActionsForItem()

void qSlicerSubjectHierarchyTransformsPlugin::showTransformContextMenuActionsForItem ( vtkIdType itemID )

overridevirtual

Show context menu actions valid for given subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showViewContextMenuActionsForItem()

void qSlicerSubjectHierarchyTransformsPlugin::showViewContextMenuActionsForItem	(	vtkIdType	itemID,
		QVariantMap	eventData )

overridevirtual

Show context menu actions valid for a given subject hierarchy item to be shown in the view.

Parameters

itemID	Subject Hierarchy item to show the context menu items for
eventData	Supplementary data for the item that may be considered for the menu (sub-item ID, attribute, etc.)

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showVisibilityContextMenuActionsForItem()

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

◆ toggleCurrentItemHandleTypeVisibility

void qSlicerSubjectHierarchyTransformsPlugin::toggleCurrentItemHandleTypeVisibility ( bool )

protectedslot

◆ 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.

◆ transformContextMenuActions()

QList< QAction * > qSlicerSubjectHierarchyTransformsPlugin::transformContextMenuActions ( ) const

overridevirtual

Get transform context menu item actions to add to tree view. These item transform context menu actions can be shown in the implementations of

See also: showTransformContextMenuActionsForItem

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ transformListSection()

int qSlicerSubjectHierarchyTransformsPlugin::transformListSection ( ) const

Menu section where transform nodes are listed. It can be useful for positioning menu items above or below in other plugins using qSlicerSubjectHierarchyAbstractPlugin::setActionPosition.

◆ viewContextMenuActions()

QList< QAction * > qSlicerSubjectHierarchyTransformsPlugin::viewContextMenuActions ( ) const

overridevirtual

Get view context menu item actions that are available when right-clicking an object in the views. These item context menu actions can be shown in the implementations of

See also: showViewContextMenuActionsForItem

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 153 of file qSlicerSubjectHierarchyTransformsPlugin.h.

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

Modules/Loadable/Transforms/SubjectHierarchyPlugins/qSlicerSubjectHierarchyTransformsPlugin.h

Public Types

Public Member Functions

Protected Slots

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchyTransformsPlugin()

◆ ~qSlicerSubjectHierarchyTransformsPlugin()

Member Function Documentation

◆ canAddNodeToSubjectHierarchy()

◆ canOwnSubjectHierarchyItem()

◆ canReparentItemInsideSubjectHierarchy()

◆ icon()

◆ identity

◆ invert

◆ itemContextMenuActions()

◆ onCreateNewTransform

◆ onHardenTransformOnBranchOfCurrentItem

◆ onRemoveTransformsFromBranchOfCurrentItem

◆ onTransformActionSelected

◆ onTransformEditProperties

◆ onTransformInteractionInViewToggled

◆ reparentItemInsideSubjectHierarchy()

◆ resetCenterOfTransformationAllTransformedNodeBounds

◆ resetCenterOfTransformationLocal

◆ resetCenterOfTransformationTransformedNodeBounds

◆ resetCenterOfTransformationWorld

◆ roleForPlugin()

◆ showContextMenuActionsForItem()

◆ showTransformContextMenuActionsForItem()

◆ showViewContextMenuActionsForItem()

◆ showVisibilityContextMenuActionsForItem()

◆ toggleCurrentItemHandleTypeVisibility

◆ toggleInteractionBox

◆ tooltip()

◆ transformContextMenuActions()

◆ transformListSection()

◆ viewContextMenuActions()

◆ visibilityContextMenuActions()

◆ visibilityIcon()

Member Data Documentation

◆ d_ptr