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>

// MRML includes
#include <vtkMRMLHierarchyNode.h>

class qSlicerSubjectHierarchyFolderPluginPrivate;

class vtkMRMLModelDisplayNode;

// Due to some reason the Python wrapping of this class fails, therefore
// put everything between BTX/ETX to exclude from wrapping.
// TODO investigate why the wrapping fails:
//   https://www.assembla.com/spaces/slicerrt/tickets/210-python-wrapping-error-when-starting-up-slicer-with-slicerrt
//BTX

class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerSubjectHierarchyFolderPlugin : public qSlicerSubjectHierarchyAbstractPlugin
{
public:
  Q_OBJECT
  QVTK_OBJECT

public:
  typedef qSlicerSubjectHierarchyAbstractPlugin Superclass;
  qSlicerSubjectHierarchyFolderPlugin(QObject* parent = NULL);
  virtual ~qSlicerSubjectHierarchyFolderPlugin();

public:
  virtual double canOwnSubjectHierarchyItem(vtkIdType itemID)const;

  Q_INVOKABLE virtual const QString roleForPlugin()const;

  virtual QIcon icon(vtkIdType itemID);

  virtual QIcon visibilityIcon(int visible);

  virtual void editProperties(vtkIdType itemID);

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

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

  virtual QList<QAction*> itemContextMenuActions()const;

  virtual QList<QAction*> sceneContextMenuActions()const;

  virtual void showContextMenuActionsForItem(vtkIdType itemID);

  virtual QList<QAction*> visibilityContextMenuActions()const;

  virtual void showVisibilityContextMenuActionsForItem(vtkIdType itemID);

public:
  virtual double canAddNodeToSubjectHierarchy(
    vtkMRMLNode* node,
    vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID )const;

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

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

  virtual bool reparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID);

public:
  Q_INVOKABLE vtkIdType createFolderUnderItem(vtkIdType parentItemID);

  Q_INVOKABLE vtkMRMLHierarchyNode* hierarchyNodeForItem(vtkIdType itemID);

  Q_INVOKABLE vtkIdType itemForHierarchyNode(vtkMRMLHierarchyNode* hierarchyNode);

  Q_INVOKABLE bool resolveHierarchyForItem(vtkIdType itemID);

  Q_INVOKABLE bool resolveHierarchies();

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

public slots:
  void onDataNodeAssociatedToHierarchyNode(vtkObject* dataNodeObject);

protected slots:
  void createFolderUnderScene();

  void createFolderUnderCurrentNode();

  void onHierarchyNodeChildNodeAdded(vtkObject* parentNodeObject, vtkObject* childNodeObject);

  void onApplyColorToBranchToggled(bool);

protected:
  vtkMRMLModelDisplayNode* modelDisplayNodeForItem(vtkIdType itemID)const;

  void callModifiedOnModelNodesInCurrentBranch();

protected:
  QScopedPointer<qSlicerSubjectHierarchyFolderPluginPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerSubjectHierarchyFolderPlugin);
  Q_DISABLE_COPY(qSlicerSubjectHierarchyFolderPlugin);
};

//ETX

#endif