qSlicerSubjectHierarchyAbstractPlugin.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
  This file was originally developed by Csaba Pinter, PerkLab, Queen's University
  and was supported through the Applied Cancer Research Unit program of Cancer Care
  Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care
 
==============================================================================*/
 
#ifndef __qSlicerSubjectHierarchyAbstractPlugin_h
#define __qSlicerSubjectHierarchyAbstractPlugin_h
 
// Qt includes
#include <QColor>
#include <QMap>
#include <QObject>
#include <QStringList>
#include <QIcon>
#include <QVariant>
 
// MRML includes
#include <vtkMRMLSubjectHierarchyNode.h>
 
#include "qSlicerSubjectHierarchyModuleWidgetsExport.h"
 
class QStandardItem;
class QAction;
class qSlicerAbstractModuleWidget;
class vtkMRMLAbstractViewNode;
 
struct Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerTerminologyMetadata
{
  qSlicerTerminologyMetadata() { this->clear(); }
 
  void clear()
  {
    this->Terminology.clear();
    this->DefaultTerminology.clear();
    this->Name.clear();
    this->NameAutoGenerated = false;
    this->ColorAutoGenerated = true;
    this->GeneratedColor = QColor();
 
    this->HasTerminology = false;
    this->HasDefaultTerminology = false;
    this->HasName = false;
    this->HasNameAutoGenerated = false;
    this->HasColorAutoGenerated = false;
    this->HasGeneratedColor = false;
  }
 
  void setTerminology(const QString& terminology)
  {
    this->Terminology = terminology;
    this->HasTerminology = true;
  }
 
  void setDefaultTerminology(const QString& defaultTerminology)
  {
    this->DefaultTerminology = defaultTerminology;
    this->HasDefaultTerminology = true;
  }
 
  void setName(const QString& name)
  {
    this->Name = name;
    this->HasName = true;
  }
 
  void setNameAutoGenerated(bool nameAutoGenerated)
  {
    this->NameAutoGenerated = nameAutoGenerated;
    this->HasNameAutoGenerated = true;
  }
 
  void setColorAutoGenerated(bool colorAutoGenerated)
  {
    this->ColorAutoGenerated = colorAutoGenerated;
    this->HasColorAutoGenerated = true;
  }
 
  void setGeneratedColor(const QColor& generatedColor)
  {
    this->GeneratedColor = generatedColor;
    this->HasGeneratedColor = true;
  }
 
  bool hasTerminology() const { return this->HasTerminology; }
  bool hasDefaultTerminology() const { return this->HasDefaultTerminology; }
  bool hasName() const { return this->HasName; }
  bool hasNameAutoGenerated() const { return this->HasNameAutoGenerated; }
  bool hasColorAutoGenerated() const { return this->HasColorAutoGenerated; }
  bool hasGeneratedColor() const { return this->HasGeneratedColor; }
 
  const QString& terminology() const { return this->Terminology; }
  const QString& defaultTerminology() const { return this->DefaultTerminology; }
  const QString& name() const { return this->Name; }
  bool nameAutoGenerated() const { return this->NameAutoGenerated; }
  bool colorAutoGenerated() const { return this->ColorAutoGenerated; }
  const QColor& generatedColor() const { return this->GeneratedColor; }
 
private:
  QString Terminology;
  QString DefaultTerminology;
  QString Name;
  bool NameAutoGenerated{ false };
  bool ColorAutoGenerated{ true };
  QColor GeneratedColor;
 
  bool HasTerminology{ false };
  bool HasDefaultTerminology{ false };
  bool HasName{ false };
  bool HasNameAutoGenerated{ false };
  bool HasColorAutoGenerated{ false };
  bool HasGeneratedColor{ false };
};

class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerSubjectHierarchyAbstractPlugin : public QObject
{
  Q_OBJECT
  Q_ENUMS(ActionSectionType)
 
  
  Q_PROPERTY(QString name READ name WRITE setName)
  Q_PROPERTY(QString helpText READ helpText)
 
public:
  typedef QObject Superclass;
  qSlicerSubjectHierarchyAbstractPlugin(QObject* parent = nullptr);
  ~qSlicerSubjectHierarchyAbstractPlugin() override;
 
  // Role-related virtual methods
  // If the subclass plugin does not offer a role, these do not need to be overridden
public:
  Q_INVOKABLE virtual double canOwnSubjectHierarchyItem(vtkIdType itemID) const;

  Q_INVOKABLE virtual const QString roleForPlugin() const;

  virtual const QString helpText() const;

  Q_INVOKABLE virtual QIcon icon(vtkIdType itemID);

  Q_INVOKABLE virtual QIcon visibilityIcon(int visible);

  Q_INVOKABLE virtual QIcon visibilityIconWithParentHidden(int visible);

  Q_INVOKABLE virtual bool canEditProperties(vtkIdType itemID);

  Q_INVOKABLE virtual void editProperties(vtkIdType itemID);

  Q_INVOKABLE virtual QString displayedItemName(vtkIdType itemID) const;

  Q_INVOKABLE virtual QString tooltip(vtkIdType itemID) const;

  Q_INVOKABLE virtual void setDisplayVisibility(vtkIdType itemID, int visible);

  Q_INVOKABLE virtual int getDisplayVisibility(vtkIdType itemID) const;

  Q_INVOKABLE virtual void setDisplayColor( //
    vtkIdType itemID,
    QColor color,
    const qSlicerTerminologyMetadata& terminologyMetadata = qSlicerTerminologyMetadata());

  Q_INVOKABLE void setDisplayColor(vtkIdType itemID, QColor color, QMap<int, QVariant> terminologyMetadata);

  Q_INVOKABLE virtual QColor getDisplayColor(vtkIdType itemID, qSlicerTerminologyMetadata& terminologyMetadata) const;

  Q_INVOKABLE QColor getDisplayColor(vtkIdType itemID, QMap<int, QVariant>& terminologyMetadata) const;

  Q_INVOKABLE QColor getDisplayColor(vtkIdType itemID) const;
 
  // Function related virtual methods
public:
  Q_INVOKABLE virtual QList<QAction*> itemContextMenuActions() const;

  Q_INVOKABLE virtual QList<QAction*> sceneContextMenuActions() const;

  Q_INVOKABLE virtual void showContextMenuActionsForItem(vtkIdType itemID) { Q_UNUSED(itemID); };

  Q_INVOKABLE virtual QList<QAction*> visibilityContextMenuActions() const;

  Q_INVOKABLE virtual void showVisibilityContextMenuActionsForItem(vtkIdType itemID) { Q_UNUSED(itemID); };

  Q_INVOKABLE virtual QList<QAction*> transformContextMenuActions() const;

  Q_INVOKABLE virtual void showTransformContextMenuActionsForItem(vtkIdType itemID) { Q_UNUSED(itemID); };

  Q_INVOKABLE virtual QList<QAction*> viewContextMenuActions() const;

  Q_INVOKABLE virtual void showViewContextMenuActionsForItem(vtkIdType itemID, QVariantMap eventData)
  {
    Q_UNUSED(itemID);
    Q_UNUSED(eventData);
  };
 
  // Parenting related virtual methods with default implementation
public:
  Q_INVOKABLE virtual double canAddNodeToSubjectHierarchy(vtkMRMLNode* node, vtkIdType parentItemID = vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const;

  Q_INVOKABLE virtual bool addNodeToSubjectHierarchy(vtkMRMLNode* node, vtkIdType parentItemID);

  Q_INVOKABLE virtual double canReparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID) const;

  Q_INVOKABLE virtual bool reparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID);

  Q_INVOKABLE virtual bool showItemInView(vtkIdType itemID, vtkMRMLAbstractViewNode* viewNode, vtkIdList* allItemsToShow);
 
  // Utility functions
public:
  Q_INVOKABLE bool isThisPluginOwnerOfItem(vtkIdType itemID) const;

  Q_INVOKABLE static qSlicerAbstractModuleWidget* switchToModule(QString moduleName);

  static QIcon applyParentHiddenEffect(const QIcon& icon);
 
public:
  virtual QString name() const;

  virtual void setName(QString name);
 
  enum ActionSectionType
  {
    SectionTop = -400,         
    SectionInteraction = -300, 
    SectionComponent = -200,   
    SectionNode = -100,        
    SectionDefault = 0,        
    SectionFolder = 100,       
    SectionBottom = 200,       
  };

  Q_INVOKABLE static void setActionPosition(QAction* action, int section, int weight = 0, double weightAdjustment = 0.0);
 
  // @{
  Q_INVOKABLE void setColorAndTerminologyToDisplayableNode(vtkIdType itemID,
                                                           QColor color,
                                                           const qSlicerTerminologyMetadata& terminologyMetadata,
                                                           bool useSelectedColor,
                                                           bool disableScalarVisibility);
  Q_INVOKABLE QColor colorAndTerminologyFromDisplayableNode(vtkIdType itemID, qSlicerTerminologyMetadata& terminologyMetadata, bool useSelectedColor) const;
  // @}
 
signals:
  void requestExpandItem(vtkIdType itemID);

  void requestInvalidateFilter() const;
 
protected:
  void hideAllContextMenuActions() const;
 
protected:
  QString m_Name;
 
private:
  qSlicerSubjectHierarchyAbstractPlugin(const qSlicerSubjectHierarchyAbstractPlugin&); // Not implemented
  void operator=(const qSlicerSubjectHierarchyAbstractPlugin&);                        // Not implemented
  friend class qMRMLSubjectHierarchyTreeView;
  friend class qSlicerSubjectHierarchyPluginLogic;
};
 
#endif