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 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 deleteAllMarkupsOptionVisible READ deleteAllMarkupsOptionVisible WRITE setDeleteAllMarkupsOptionVisible)
  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)

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;

  bool currentNodeActive() const;

  bool placeModeEnabled() const;

  bool placeModePersistency() const;

  PlaceMultipleMarkupsType placeMultipleMarkups() const;

  bool buttonsVisible() const;

  bool deleteAllMarkupsOptionVisible() const;

  QColor nodeColor() const;

  QColor defaultNodeColor() const;

  Q_INVOKABLE QToolButton* placeButton() const;

  Q_INVOKABLE QToolButton* deleteButton() const;

public slots:

  void setMRMLScene(vtkMRMLScene* scene) override;

  void setCurrentNode(vtkMRMLNode* currentNode);

  void setCurrentNodeActive(bool active);

  void setInteractionNode(vtkMRMLInteractionNode* interactionNode);

  void setDefaultNodeColor(QColor color);

  void setNodeColor(QColor color);

  void setPlaceModeEnabled(bool enable);

  void setPlaceMultipleMarkups(PlaceMultipleMarkupsType option);

  void setButtonsVisible(bool visible);

  void setDeleteAllMarkupsOptionVisible(bool visible);

  void setPlaceModePersistency(bool);

  void deleteLastPoint();

  void deleteAllPoints();

  void deleteLastMarkup();

  void deleteAllMarkups();

protected slots:

  void updateWidget();

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

  void onPlacePersistent(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