qMRMLSegmentsModel.h

Go to the documentation of this file.

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

  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 Kyle Sunderland, PerkLab, Queen's University
  and was supported through CANARIE's Research Software Program, and Cancer
  Care Ontario.

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

#ifndef __qMRMLSegmentsModel_h
#define __qMRMLSegmentsModel_h

// Qt includes
#include <QStandardItemModel>

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

// Segments includes
#include "qSlicerSegmentationsModuleWidgetsExport.h"

class qMRMLSegmentsModelPrivate;
class vtkMRMLSegmentationNode;
class vtkMRMLNode;
class vtkMRMLScene;
class vtkSegment;

class Q_SLICER_MODULE_SEGMENTATIONS_WIDGETS_EXPORT qMRMLSegmentsModel : 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 opacityColumn READ opacityColumn WRITE setOpacityColumn)
  Q_PROPERTY(int statusColumn READ statusColumn WRITE setStatusColumn)
  Q_PROPERTY(int layerColumn READ layerColumn WRITE setLayerColumn)

public:

  enum SegmentTableItemDataRole
  {
    SegmentIDRole = Qt::UserRole + 1,
    IndexRole,
    VisibilityRole,
    StatusRole,
  };

  typedef QStandardItemModel Superclass;
  qMRMLSegmentsModel(QObject *parent=nullptr);
  ~qMRMLSegmentsModel() override;

  int nameColumn()const;
  void setNameColumn(int column);
  int visibilityColumn()const;
  void setVisibilityColumn(int column);
  int colorColumn()const;
  void setColorColumn(int column);
  int opacityColumn()const;
  void setOpacityColumn(int column);
  int statusColumn()const;
  void setStatusColumn(int column);
  int layerColumn()const;
  void setLayerColumn(int layer);

  QString segmentIDFromIndex(const QModelIndex &index)const;
  // Returns the segment ID for the given item
  QString segmentIDFromItem(QStandardItem* item)const;
  // Returns the index for the given segment ID
  QModelIndex indexFromSegmentID(QString segmentID, int column=0)const;
  // Returns the item for the given segment ID
  QStandardItem* itemFromSegmentID(QString segmentID, int column=0)const;

  QModelIndexList indexes(QString segmentID)const;

  vtkMRMLSegmentationNode* segmentationNode()const;
  virtual void setSegmentationNode(vtkMRMLSegmentationNode* segmentation);

  Q_INVOKABLE static QString terminologyTooltipForSegment(vtkSegment* segment);

signals:
  void segmentAboutToBeModified(const QString& segmentID);

  void requestSelectItems(QList<vtkIdType> itemIDs);

protected slots:
  virtual void onItemChanged(QStandardItem* item);

  void updateColumnCount();

protected:
  qMRMLSegmentsModel(qMRMLSegmentsModelPrivate* pimpl, QObject *parent=nullptr);

  virtual void rebuildFromSegments();
  virtual void updateFromSegments();

  virtual Qt::ItemFlags segmentFlags(QString segmentID, int column)const;

  virtual void updateItemFromSegment(QStandardItem* item, QString segmentID, int column );
  virtual void updateItemDataFromSegment(QStandardItem* item, QString segmentID, int column );
  virtual void updateSegmentFromItem(QString segmentID, QStandardItem* item );
  virtual void updateSegmentFromItemData(QString segmentID, QStandardItem* item );
  void updateItemsFromColumnIndex(int column);
  void updateItemsFromSegmentID(QString segmentID);

  void reorderItems();

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

  virtual int maxColumnId()const;

  virtual void onSegmentAdded(QString segmentID);
  virtual void onSegmentRemoved(QString segmentID);
  virtual void onSegmentModified(QString segmentID);
  virtual void onSegmentOrderModified();
  virtual void onDisplayNodeModified();

protected:
  QScopedPointer<qMRMLSegmentsModelPrivate> d_ptr;

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

#endif