qSlicerMarkupsPlaceWidget.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 Matthew Holden, 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 __qSlicerMarkupsPlaceWidget_h
#define __qSlicerMarkupsPlaceWidget_h

// Qt includes
#include "qSlicerWidget.h"

#include "qMRMLUtils.h"

// Markups Widgets includes
#include "qSlicerMarkupsModuleWidgetsExport.h"
#include "ui_qSlicerMarkupsPlaceWidget.h"


class qSlicerMarkupsPlaceWidgetPrivate;
class vtkMRMLInteractionNode;
class vtkMRMLSelectionNode;
class vtkMRMLMarkupsFiducialNode;
class vtkMRMLMarkupsNode;

class Q_SLICER_MODULE_MARKUPS_WIDGETS_EXPORT
qSlicerMarkupsPlaceWidget : public qSlicerWidget
{
  Q_OBJECT
  Q_ENUMS(PlaceMultipleMarkupsType)
  Q_PROPERTY(bool buttonsVisible READ buttonsVisible WRITE setButtonsVisible)
  Q_PROPERTY(bool deleteAllControlPointsOptionVisible READ deleteAllControlPointsOptionVisible WRITE setDeleteAllControlPointsOptionVisible)
  Q_PROPERTY(bool unsetLastControlPointOptionVisible READ unsetLastControlPointOptionVisible WRITE setUnsetLastControlPointOptionVisible)
  Q_PROPERTY(bool unsetAllControlPointsOptionVisible READ unsetAllControlPointsOptionVisible WRITE setUnsetAllControlPointsOptionVisible)
  Q_PROPERTY(PlaceMultipleMarkupsType placeMultipleMarkups READ placeMultipleMarkups WRITE setPlaceMultipleMarkups)
  Q_PROPERTY(QColor nodeColor READ nodeColor WRITE setNodeColor)
  Q_PROPERTY(QColor defaultNodeColor READ defaultNodeColor WRITE setDefaultNodeColor)
  Q_PROPERTY(bool currentNodeActive READ currentNodeActive WRITE setCurrentNodeActive)
  Q_PROPERTY(bool placeModeEnabled READ placeModeEnabled WRITE setPlaceModeEnabled)
  Q_PROPERTY(bool placeModePersistency READ placeModePersistency WRITE setPlaceModePersistency)

  Q_PROPERTY(bool deleteAllMarkupsOptionVisible READ deleteAllMarkupsOptionVisible WRITE setDeleteAllMarkupsOptionVisible)

public:
  typedef qSlicerWidget Superclass;
  qSlicerMarkupsPlaceWidget(QWidget *parent=nullptr);
  ~qSlicerMarkupsPlaceWidget() override;

  enum PlaceMultipleMarkupsType
  {
    ShowPlaceMultipleMarkupsOption, // show a menu on the place button to place multiple markup points
    HidePlaceMultipleMarkupsOption, // don't allow to change persistency of place mode, just use current
    ForcePlaceSingleMarkup, // always disable persistency when enabling place mode
    ForcePlaceMultipleMarkups // always enable persistency when enabling place mode
  };

  Q_INVOKABLE vtkMRMLNode* currentNode() const;
  Q_INVOKABLE vtkMRMLMarkupsFiducialNode* currentMarkupsFiducialNode() const;
  Q_INVOKABLE vtkMRMLMarkupsNode* currentMarkupsNode() const;

  Q_INVOKABLE vtkMRMLInteractionNode* interactionNode()const;
  Q_INVOKABLE vtkMRMLSelectionNode* selectionNode()const;

  bool currentNodeActive() const;

  bool placeModeEnabled() const;

  bool placeModePersistency() const;

  PlaceMultipleMarkupsType placeMultipleMarkups() const;

  bool buttonsVisible() const;

  bool deleteAllControlPointsOptionVisible() const;

  bool unsetLastControlPointOptionVisible() const;

  bool unsetAllControlPointsOptionVisible() const;

  QColor nodeColor() const;

  QColor defaultNodeColor() const;

  // Returns true if additional points are allowed in the current markup node, false when point number is fixed
  bool currentMarkupPointPlacementValid();

  Q_INVOKABLE QToolButton* placeButton() const;

  // Button to delete control point(s) or unset their position
  Q_INVOKABLE QToolButton* deleteButton() const;

  //-----------------------------------------------------------
  // All public methods below are deprecated
  //
  // These methods are deprecated because they use old terms (markup instead of control point),

  bool deleteAllMarkupsOptionVisible() const
  {
    qWarning("qSlicerMarkupsPlaceWidget::deleteAllMarkupsOptionVisible method is deprecated, please use deleteAllControlPointsOptionVisible instead");
    return this->deleteAllControlPointsOptionVisible();
  };


public slots:

  void setMRMLScene(vtkMRMLScene* scene) override;

  void setCurrentNode(vtkMRMLNode* currentNode);

  void setCurrentNodeActive(bool active);

  void setInteractionNode(vtkMRMLInteractionNode* interactionNode);
  void setSelectionNode(vtkMRMLSelectionNode* selectionNode);

  void setDefaultNodeColor(QColor color);

  void setNodeColor(QColor color);

  void setPlaceModeEnabled(bool enable);

  void setPlaceMultipleMarkups(PlaceMultipleMarkupsType option);

  void setButtonsVisible(bool visible);

  void setDeleteAllControlPointsOptionVisible(bool visible);

  void setUnsetLastControlPointOptionVisible(bool visible);

  void setUnsetAllControlPointsOptionVisible(bool visible);

  void setPlaceModePersistency(bool);

  void modifyLastPoint();

  void deleteLastPoint();

  void deleteAllPoints();

  void unsetLastDefinedPoint();

  void unsetAllPoints();

  //-----------------------------------------------------------
  // All public methods below are deprecated
  //
  // These methods are deprecated because they use old terms (markup instead of control point),

  void deleteLastMarkup()
  {
  qWarning("qSlicerMarkupsPlaceWidget::deleteLastMarkup method is deprecated, please use deleteLastPoint instead");
  this->deleteLastPoint();
  };
  void deleteAllMarkups()
  {
  qWarning("qSlicerMarkupsPlaceWidget::deleteAllMarkups method is deprecated, please use deleteAllPoints instead");
  this->deleteAllPoints();
  };
  void setDeleteAllMarkupsOptionVisible(bool visible)
  {
  qWarning("qSlicerMarkupsPlaceWidget::setDeleteAllMarkupsOptionVisible method is deprecated, please use setDeleteAllControlPointsOptionVisible instead");
  this->setDeleteAllControlPointsOptionVisible(visible);
  };

protected slots:

  void updateWidget();

  void updateDeleteButton();

  void onColorButtonChanged(QColor);
  void onVisibilityButtonClicked();
  void onLockedButtonClicked();
  void onFixedNumberOfControlPointsButtonClicked();

  void onPlacePersistentPoint(bool enable);

signals:

  void activeMarkupsPlaceModeChanged(bool enabled);

  void activeMarkupsFiducialPlaceModeChanged(bool enabled);

protected:
  QScopedPointer<qSlicerMarkupsPlaceWidgetPrivate> d_ptr;

  virtual void setup();

private:
  Q_DECLARE_PRIVATE(qSlicerMarkupsPlaceWidget);
  Q_DISABLE_COPY(qSlicerMarkupsPlaceWidget);

};

#endif