qMRMLSubjectHierarchyModel.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 __qMRMLSubjectHierarchyModel_h
#define __qMRMLSubjectHierarchyModel_h

// Qt includes
#include <QStandardItemModel>

// CTK includes
#include <ctkPimpl.h>
#include <ctkVTKObject.h>

// SubjectHierarchy includes
#include "qSlicerSubjectHierarchyModuleWidgetsExport.h"

class qMRMLSubjectHierarchyModelPrivate;
class vtkMRMLSubjectHierarchyNode;
class vtkMRMLNode;
class vtkMRMLScene;

class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qMRMLSubjectHierarchyModel : public QStandardItemModel
{
  Q_OBJECT
  QVTK_OBJECT

  Q_PROPERTY (int nameColumn READ nameColumn WRITE setNameColumn)
  Q_PROPERTY (int visibilityColumn READ visibilityColumn WRITE setVisibilityColumn)
  Q_PROPERTY(int colorColumn READ colorColumn WRITE setColorColumn)
  Q_PROPERTY (int transformColumn READ transformColumn WRITE setTransformColumn)
  Q_PROPERTY (int descriptionColumn READ descriptionColumn WRITE setDescriptionColumn)
  Q_PROPERTY (int idColumn READ idColumn WRITE setIDColumn)

  Q_PROPERTY(bool noneEnabled READ noneEnabled WRITE setNoneEnabled)
  Q_PROPERTY(QString noneDisplay READ noneDisplay WRITE setNoneDisplay)

public:
  typedef QStandardItemModel Superclass;
  qMRMLSubjectHierarchyModel(QObject *parent=nullptr);
  ~qMRMLSubjectHierarchyModel() override;

  enum ItemDataRole
    {
    SubjectHierarchyItemIDRole = Qt::UserRole + 1,
    VisibilityRole,
    TransformIDRole,
    LastRole
    };

  int nameColumn()const;
  void setNameColumn(int column);

  int visibilityColumn()const;
  void setVisibilityColumn(int column);

  int colorColumn()const;
  void setColorColumn(int column);

  int transformColumn()const;
  void setTransformColumn(int column);

  int descriptionColumn()const;
  void setDescriptionColumn(int column);

  int idColumn()const;
  void setIDColumn(int column);

  bool noneEnabled()const;
  void setNoneEnabled(bool enable);

  QString noneDisplay()const;
  void setNoneDisplay(const QString& displayName);

  Qt::DropActions supportedDropActions()const override;
  QMimeData* mimeData(const QModelIndexList& indexes)const override;
  bool dropMimeData(const QMimeData *data, Qt::DropAction action,
                            int row, int column, const QModelIndex &parent) override;

  Q_INVOKABLE virtual void setMRMLScene(vtkMRMLScene* scene);
  Q_INVOKABLE vtkMRMLScene* mrmlScene()const;

  vtkMRMLSubjectHierarchyNode* subjectHierarchyNode()const;

  QStandardItem* subjectHierarchySceneItem()const;
  QModelIndex subjectHierarchySceneIndex()const;
  virtual bool canBeAChild(vtkIdType itemID)const;
  virtual bool canBeAParent(vtkIdType itemID)const;

  vtkIdType subjectHierarchyItemFromIndex(const QModelIndex &index)const;
  vtkIdType subjectHierarchyItemFromItem(QStandardItem* item)const;
  QModelIndex indexFromSubjectHierarchyItem(vtkIdType itemID, int column=0)const;
  QStandardItem* itemFromSubjectHierarchyItem(vtkIdType itemID, int column=0)const;

  QModelIndexList indexes(vtkIdType itemID)const;

  Q_INVOKABLE virtual vtkIdType parentSubjectHierarchyItem(vtkIdType itemID)const;
  Q_INVOKABLE virtual int subjectHierarchyItemIndex(vtkIdType itemID)const;
  Q_INVOKABLE virtual bool reparent(vtkIdType itemID, vtkIdType newParentID);
  Q_INVOKABLE virtual bool moveToRow(vtkIdType itemID, int newRow);
  Q_INVOKABLE bool isAncestorItem(vtkIdType child, vtkIdType ancestor)const;
  Q_INVOKABLE bool isAffiliatedItem(vtkIdType itemA, vtkIdType itemB)const;

signals:
  void aboutToReparentByDragAndDrop(vtkIdType itemID, vtkIdType newParentID);
  void reparentedByDragAndDrop(vtkIdType itemID, vtkIdType newParentID);
  void subjectHierarchyAboutToBeUpdated();
  void subjectHierarchyUpdated();
  void requestExpandItem(vtkIdType itemID);
  void requestCollapseItem(vtkIdType itemID);
  void requestSelectItems(QList<vtkIdType> itemIDs);
  void invalidateFilter();

public slots:
  void onRemoveTransformsFromBranchOfCurrentItem();

  void onHardenTransformOnBranchOfCurrentItem();

protected slots:
  virtual void onSubjectHierarchyItemAdded(vtkIdType itemID);
  virtual void onSubjectHierarchyItemAboutToBeRemoved(vtkIdType itemID);
  virtual void onSubjectHierarchyItemRemoved(vtkIdType itemID);
  virtual void onSubjectHierarchyItemModified(vtkIdType itemID);

  virtual void onMRMLSceneImported(vtkMRMLScene* scene);
  virtual void onMRMLSceneClosed(vtkMRMLScene* scene);
  virtual void onMRMLSceneStartBatchProcess(vtkMRMLScene* scene);
  virtual void onMRMLSceneEndBatchProcess(vtkMRMLScene* scene);
  virtual void onMRMLNodeRemoved(vtkMRMLNode* node);

  virtual void onItemChanged(QStandardItem* item);
  virtual void delayedItemChanged();

  void updateColumnCount();

protected:
  qMRMLSubjectHierarchyModel(qMRMLSubjectHierarchyModelPrivate* pimpl, QObject *parent=nullptr);

  virtual void setSubjectHierarchyNode(vtkMRMLSubjectHierarchyNode* shNode);

  virtual void rebuildFromSubjectHierarchy();
  virtual void updateFromSubjectHierarchy();

  virtual QStandardItem* insertSubjectHierarchyItem(vtkIdType itemID);
  virtual QStandardItem* insertSubjectHierarchyItem(vtkIdType itemID, QStandardItem* parent, int row=-1);

  virtual QFlags<Qt::ItemFlag> subjectHierarchyItemFlags(vtkIdType itemID, int column)const;

  virtual void updateItemFromSubjectHierarchyItem(
    QStandardItem* item, vtkIdType shItemID, int column );
  virtual void updateItemDataFromSubjectHierarchyItem(
    QStandardItem* item, vtkIdType shItemID, int column );
  virtual void updateSubjectHierarchyItemFromItem(
    vtkIdType shItemID, QStandardItem* item );
  virtual void updateSubjectHierarchyItemFromItemData(
    vtkIdType shItemID, QStandardItem* item );

  void updateModelItems(vtkIdType itemID);

  static void onEvent(vtkObject* caller, unsigned long event, void* clientData, void* callData);

  virtual int maxColumnId()const;

protected:
  QScopedPointer<qMRMLSubjectHierarchyModelPrivate> d_ptr;

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

void printStandardItem(QStandardItem* item, const QString& offset);

#endif