qMRMLSceneModel.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  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 Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

==============================================================================*/

#ifndef __qMRMLSceneModel_h
#define __qMRMLSceneModel_h

// Qt includes
#include <QStandardItemModel>

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

// qMRML includes
#include "qMRMLWidgetsExport.h"

class vtkMRMLNode;
class vtkMRMLScene;

class qMRMLSceneModelPrivate;

class QMRML_WIDGETS_EXPORT qMRMLSceneModel : public QStandardItemModel
{
  Q_OBJECT
  QVTK_OBJECT

  Q_ENUMS(NodeTypes)

  
  Q_PROPERTY (NodeTypes listenNodeModifiedEvent READ listenNodeModifiedEvent WRITE setListenNodeModifiedEvent)

  
  Q_PROPERTY (bool lazyUpdate READ lazyUpdate WRITE setLazyUpdate)

  
  Q_PROPERTY (int nameColumn READ nameColumn WRITE setNameColumn)
  Q_PROPERTY (int idColumn READ idColumn WRITE setIDColumn)
  Q_PROPERTY (int checkableColumn READ checkableColumn WRITE setCheckableColumn)
  Q_PROPERTY (int visibilityColumn READ visibilityColumn WRITE setVisibilityColumn)
  Q_PROPERTY (int toolTipNameColumn READ toolTipNameColumn WRITE setToolTipNameColumn)
  Q_PROPERTY( int extraItemColumn READ extraItemColumn WRITE setExtraItemColumn)
public:
  typedef QStandardItemModel Superclass;
  qMRMLSceneModel(QObject *parent=nullptr);
  ~qMRMLSceneModel() override;

  enum NodeTypes
    {
    NoNodes = 0,
    AllNodes,
    OnlyVisibleNodes
    };
  enum ItemDataRole
    {
    UIDRole = Qt::UserRole + 1,
    PointerRole,
    ExtraItemsRole,
    VisibilityRole,
    LastRole
    };

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

  QStandardItem* mrmlSceneItem()const;

  QModelIndex mrmlSceneIndex()const;

  inline vtkMRMLNode* mrmlNodeFromIndex(const QModelIndex &nodeIndex)const;
  vtkMRMLNode* mrmlNodeFromItem(QStandardItem* nodeItem)const;
  QModelIndex indexFromNode(vtkMRMLNode* node, int column = 0)const;
  // Utility function
  QStandardItem* itemFromNode(vtkMRMLNode* node, int column = 0)const;
  // Return all the QModelIndexes (all the columns) for a given node
  QModelIndexList indexes(vtkMRMLNode* node)const;

  void setListenNodeModifiedEvent(NodeTypes nodesToListen);
  NodeTypes listenNodeModifiedEvent()const;

  bool lazyUpdate()const;
  void setLazyUpdate(bool lazy);

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

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

  int checkableColumn()const;
  void setCheckableColumn(int column);

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

  int toolTipNameColumn()const;
  void setToolTipNameColumn(int column);

  int extraItemColumn()const;
  void setExtraItemColumn(int column);

  void setPreItems(const QStringList& extraItems, QStandardItem* parent);
  QStringList preItems(QStandardItem* parent)const;

  void setPostItems(const QStringList& extraItems, QStandardItem* parent);
  QStringList postItems(QStandardItem* parent)const;

  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;

  virtual vtkMRMLNode* parentNode(vtkMRMLNode* node)const;
  virtual int          nodeIndex(vtkMRMLNode* node)const;
  virtual bool         canBeAChild(vtkMRMLNode* node)const;
  virtual bool         canBeAParent(vtkMRMLNode* node)const;
  virtual bool         reparent(vtkMRMLNode* node, vtkMRMLNode* newParent);
  bool isParentNode(vtkMRMLNode* child, vtkMRMLNode* parent)const;
  bool isAffiliatedNode(vtkMRMLNode* nodeA, vtkMRMLNode* nodeB)const;

  virtual void observeNode(vtkMRMLNode* node);

protected slots:

  virtual void onMRMLSceneNodeAboutToBeAdded(vtkMRMLScene* scene, vtkMRMLNode* node);
  virtual void onMRMLSceneNodeAboutToBeRemoved(vtkMRMLScene* scene, vtkMRMLNode* node);
  virtual void onMRMLSceneNodeAdded(vtkMRMLScene* scene, vtkMRMLNode* node);
  virtual void onMRMLSceneNodeRemoved(vtkMRMLScene* scene, vtkMRMLNode* node);

  virtual void onMRMLSceneAboutToBeImported(vtkMRMLScene* scene);
  virtual void onMRMLSceneImported(vtkMRMLScene* scene);
  virtual void onMRMLSceneAboutToBeClosed(vtkMRMLScene* scene);
  virtual void onMRMLSceneClosed(vtkMRMLScene* scene);
  virtual void onMRMLSceneStartBatchProcess(vtkMRMLScene* scene);
  virtual void onMRMLSceneEndBatchProcess(vtkMRMLScene* scene);

  void onMRMLSceneDeleted(vtkMRMLScene* scene);

  void onMRMLNodeModified(vtkObject* node);
  void onMRMLNodeIDChanged(vtkObject* node, void* callData);
  virtual void onItemChanged(QStandardItem * item);
  virtual void delayedItemChanged();

  void updateColumnCount();

signals:
  void aboutToReparentByDragAndDrop(vtkMRMLNode* node, vtkMRMLNode* newParent);

  void reparentedByDragAndDrop(vtkMRMLNode* node, vtkMRMLNode* newParent);

  void sceneAboutToBeUpdated();

  void sceneUpdated();

protected:
  qMRMLSceneModel(qMRMLSceneModelPrivate* pimpl, QObject *parent=nullptr);

  virtual void updateScene();
  virtual void populateScene();
  virtual QStandardItem* insertNode(vtkMRMLNode* node);
  virtual QStandardItem* insertNode(vtkMRMLNode* node, QStandardItem* parent, int row = -1);

  virtual bool isANode(const QStandardItem* item)const;
  virtual QFlags<Qt::ItemFlag> nodeFlags(vtkMRMLNode* node, int column)const;

  void updateNodeItems();

  virtual void updateItemFromNode(QStandardItem* item, vtkMRMLNode* node, int column);

  virtual void updateItemDataFromNode(QStandardItem* item, vtkMRMLNode* node, int column);
  virtual void updateNodeFromItem(vtkMRMLNode* node, QStandardItem* item);
  virtual void updateNodeFromItemData(vtkMRMLNode* node, QStandardItem* item);

  void updateNodeItems(vtkMRMLNode* node, const QString& uid);

  static void onMRMLSceneEvent(vtkObject* vtk_obj, unsigned long event,
                               void* client_data, void* call_data);

  virtual int maxColumnId()const;
protected:
  QScopedPointer<qMRMLSceneModelPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qMRMLSceneModel);
  Q_DISABLE_COPY(qMRMLSceneModel);
};
Q_DECLARE_METATYPE(qMRMLSceneModel::NodeTypes)

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

// -----------------------------------------------------------------------------
vtkMRMLNode* qMRMLSceneModel::mrmlNodeFromIndex(const QModelIndex &nodeIndex)const
{
  return this->mrmlNodeFromItem(this->itemFromIndex(nodeIndex));
}

#endif