qMRMLSegmentsTableView.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 __qMRMLSegmentsTableView_h
#define __qMRMLSegmentsTableView_h

// Segmentations includes
#include "qSlicerSegmentationsModuleWidgetsExport.h"

// MRMLWidgets includes
#include "qMRMLWidget.h"

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

class qMRMLSegmentsModel;
class qMRMLSegmentsTableViewPrivate;
class qMRMLSortFilterSegmentsProxyModel;
class QContextMenuEvent;
class QItemSelection;
class QStandardItem;
class QStringList;
class QTableWidgetItem;
class QTableView;
class vtkMRMLNode;
class vtkSegment;

class Q_SLICER_MODULE_SEGMENTATIONS_WIDGETS_EXPORT qMRMLSegmentsTableView : public qMRMLWidget
{
  Q_OBJECT
  QVTK_OBJECT

public:
  Q_PROPERTY(int selectionMode READ selectionMode WRITE setSelectionMode)
  Q_PROPERTY(bool headerVisible READ headerVisible WRITE setHeaderVisible)
  Q_PROPERTY(bool visibilityColumnVisible READ visibilityColumnVisible WRITE setVisibilityColumnVisible)
  Q_PROPERTY(bool colorColumnVisible READ colorColumnVisible WRITE setColorColumnVisible)
  Q_PROPERTY(bool opacityColumnVisible READ opacityColumnVisible WRITE setOpacityColumnVisible)
  Q_PROPERTY(bool statusColumnVisible READ statusColumnVisible WRITE setStatusColumnVisible)
  Q_PROPERTY(bool layerColumnVisible READ layerColumnVisible WRITE setLayerColumnVisible)
  Q_PROPERTY(bool readOnly READ readOnly WRITE setReadOnly)
  Q_PROPERTY(bool filterBarVisible READ filterBarVisible WRITE setFilterBarVisible)
  Q_PROPERTY(QString textFilter READ textFilter WRITE setTextFilter)
  Q_PROPERTY(bool jumpToSelectedSegmentEnabled READ jumpToSelectedSegmentEnabled WRITE setJumpToSelectedSegmentEnabled)

  typedef qMRMLWidget Superclass;
  explicit qMRMLSegmentsTableView(QWidget* parent = nullptr);
  ~qMRMLSegmentsTableView() override;

  Q_INVOKABLE vtkMRMLNode* segmentationNode();

  Q_INVOKABLE QTableView* tableWidget();

  int segmentCount() const;

  Q_INVOKABLE QStringList selectedSegmentIDs();
  Q_INVOKABLE void setSelectedSegmentIDs(QStringList segmentIDs);
  Q_INVOKABLE void clearSelection();

  Q_INVOKABLE static QString terminologyTooltipForSegment(vtkSegment* segment);

  int selectionMode();
  bool headerVisible();
  bool visibilityColumnVisible();
  bool colorColumnVisible();
  bool opacityColumnVisible();
  bool statusColumnVisible();
  bool layerColumnVisible();
  bool readOnly();
  bool filterBarVisible();

  Q_INVOKABLE void setHideSegments(const QStringList& segmentIDs);
  Q_INVOKABLE QStringList hideSegments()const;

  Q_INVOKABLE QStringList displayedSegmentIDs()const;

  Q_INVOKABLE qMRMLSortFilterSegmentsProxyModel* sortFilterProxyModel()const;
  Q_INVOKABLE qMRMLSegmentsModel* model()const;

  QString textFilter();
  // If the specified status should be shown in the table
  Q_INVOKABLE bool statusShown(int status);

  int rowForSegmentID(QString segmentID);
  QString segmentIDForRow(int row);

public slots:
  void setSegmentationNode(vtkMRMLNode* node);
  void setMRMLScene(vtkMRMLScene* newScene) override;

  void setSelectionMode(int mode);

  void setHeaderVisible(bool visible);
  void setVisibilityColumnVisible(bool visible);
  void setColorColumnVisible(bool visible);
  void setOpacityColumnVisible(bool visible);
  void setStatusColumnVisible(bool visible);
  void setLayerColumnVisible(bool visible);
  void setReadOnly(bool aReadOnly);
  void setFilterBarVisible(bool visible);

  void showOnlySelectedSegments();

  void jumpSlices();

  void setJumpToSelectedSegmentEnabled(bool enable);

  void setSelectedSegmentsStatus(int status=-1);

  void clearSelectedSegments();

  void moveSelectedSegmentsUp();
  void moveSelectedSegmentsDown();

  void setTextFilter(QString textFilter);
  void setStatusShown(int status, bool shown);

  bool jumpToSelectedSegmentEnabled()const;

signals:
  void selectionChanged(const QItemSelection &selected, const QItemSelection &deselected);

  void segmentAboutToBeModified(const QString &segmentID);

protected slots:
  void onSegmentSelectionChanged(const QItemSelection &selected, const QItemSelection &deselected);

  void onVisibility3DActionToggled(bool visible);
  void onVisibility2DFillActionToggled(bool visible);
  void onVisibility2DOutlineActionToggled(bool visible);

  void onSegmentsFilterModified();
  void onShowStatusButtonClicked();

  void onSegmentsTableClicked(const QModelIndex& modelIndex);

  void endProcessing();

  void onSegmentAddedOrRemoved();

  void updateWidgetFromMRML();

  void updateMRMLFromFilterParameters();

  void modelAboutToBeReset();
  void modelReset();

protected:
  void setSegmentVisibility(QObject* senderObject, int visible, int visible3D, int visible2DFill, int visible2DOutline);
  void setSegmentVisibility(QString segmentId, int visible, int visible3D, int visible2DFill, int visible2DOutline);

  bool eventFilter(QObject* target, QEvent* event) override;

  void contextMenuEvent(QContextMenuEvent* event) override;

protected:
  QScopedPointer<qMRMLSegmentsTableViewPrivate> d_ptr;

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

#endif