qSlicerSubjectHierarchyFolderPlugin.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 __qSlicerSubjectHierarchyFolderPlugin_h
#define __qSlicerSubjectHierarchyFolderPlugin_h
 
// SubjectHierarchy Plugins includes
#include "qSlicerSubjectHierarchyAbstractPlugin.h"
 
#include "qSlicerSubjectHierarchyModuleWidgetsExport.h"
 
// CTK includes
#include <ctkVTKObject.h>
 
class qMRMLSubjectHierarchyTreeView;
class qSlicerSubjectHierarchyFolderPluginPrivate;
 
class vtkMRMLDisplayNode;

class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerSubjectHierarchyFolderPlugin : public qSlicerSubjectHierarchyAbstractPlugin
{
public:
  Q_OBJECT
  QVTK_OBJECT
 
public:
  typedef qSlicerSubjectHierarchyAbstractPlugin Superclass;
  qSlicerSubjectHierarchyFolderPlugin(QObject* parent = nullptr);
  ~qSlicerSubjectHierarchyFolderPlugin() override;
 
public:
  double canAddNodeToSubjectHierarchy(vtkMRMLNode* node, vtkIdType parentItemID = vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const override;

  bool addNodeToSubjectHierarchy(vtkMRMLNode* node, vtkIdType parentItemID) override;

  double canOwnSubjectHierarchyItem(vtkIdType itemID) const override;

  Q_INVOKABLE const QString roleForPlugin() const override;

  QIcon icon(vtkIdType itemID) override;

  QIcon visibilityIcon(int visible) override;

  void editProperties(vtkIdType itemID) override;

  void setDisplayVisibility(vtkIdType itemID, int visible) override;

  int getDisplayVisibility(vtkIdType itemID) const override;

  void setDisplayColor(vtkIdType itemID, QColor color, QMap<int, QVariant> terminologyMetaData) override;

  QColor getDisplayColor(vtkIdType itemID, QMap<int, QVariant>& terminologyMetaData) const override;

  QList<QAction*> itemContextMenuActions() const override;

  QList<QAction*> sceneContextMenuActions() const override;

  void showContextMenuActionsForItem(vtkIdType itemID) override;

  QList<QAction*> visibilityContextMenuActions() const override;

  void showVisibilityContextMenuActionsForItem(vtkIdType itemID) override;
 
public:
  Q_INVOKABLE vtkIdType createFolderUnderItem(vtkIdType parentItemID);

  Q_INVOKABLE QString colorItemAttributeName() const { return "Color"; };

  vtkMRMLDisplayNode* createDisplayNodeForItem(vtkIdType itemID);

  void emptyFolderCreatedFromTreeView(qMRMLSubjectHierarchyTreeView* treeView);
 
protected slots:
  void createFolderUnderScene();

  void createFolderUnderCurrentNode();

  void onApplyColorToBranchToggled(bool);

  void onShowEmptyFoldersToggled(bool);
 
protected:
  vtkMRMLDisplayNode* displayNodeForItem(vtkIdType itemID) const;

  bool isApplyColorToBranchEnabledForItem(vtkIdType itemID) const;
  void setApplyColorToBranchEnabledForItem(vtkIdType itemID, bool enabled);

  void updateShowEmptyFoldersAction();
 
protected:
  QScopedPointer<qSlicerSubjectHierarchyFolderPluginPrivate> d_ptr;
 
private:
  Q_DECLARE_PRIVATE(qSlicerSubjectHierarchyFolderPlugin);
  Q_DISABLE_COPY(qSlicerSubjectHierarchyFolderPlugin);
};
 
#endif