qSlicerMarkupsModuleWidget.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Portions (c) Copyright Brigham and Women's Hospital (BWH) 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.

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

#ifndef __qSlicerMarkupsModuleWidget_h
#define __qSlicerMarkupsModuleWidget_h

// Slicer includes
#include "qSlicerAbstractModuleWidget.h"

// Markups widgets include
#include "qSlicerMarkupsModuleExport.h"

class QItemSelection;
class QMenu;
class QModelIndex;
class QStringList;
class QTableWidgetItem;
class QShortcut;
class qMRMLMarkupsOptionsWidget;
class qSlicerMarkupsModuleWidgetPrivate;
class vtkMRMLMarkupsNode;
class vtkMRMLNode;
class vtkSlicerMarkupsLogic;

class Q_SLICER_QTMODULES_MARKUPS_EXPORT qSlicerMarkupsModuleWidget :
  public qSlicerAbstractModuleWidget
{
  Q_OBJECT

public:

  typedef qSlicerAbstractModuleWidget Superclass;
  qSlicerMarkupsModuleWidget(QWidget *parent=nullptr);
  ~qSlicerMarkupsModuleWidget() override;

  void enter() override;
  void exit() override;

  vtkSlicerMarkupsLogic *markupsLogic();

  void updateWidgetFromMRML();
  void updateWidgetFromDisplayNode();
  void updateMaximumScaleFromVolumes();
  void updateRow(int m);
  void updateRows();

  void setMRMLMarkupsNode(vtkMRMLMarkupsNode* markupsNode);

  vtkMRMLMarkupsNode* mrmlMarkupsNode();

  void updateLogicFromSettings();

  bool sliceIntersectionsVisible();

  // Set number of columns for organization of create markups buttons
  void setCreateMarkupsButtonsColumns(unsigned int columns);

  bool setEditedNode(vtkMRMLNode* node, QString role = QString(), QString context = QString()) override;
  double nodeEditable(vtkMRMLNode* node) override;

  // Returns the list of associated markups
  QStringList& associatedMarkups();

  // Add additional widget
  QList<qMRMLMarkupsOptionsWidget*>& additionalWidgets();

  Q_INVOKABLE void updateToolBar(vtkMRMLMarkupsNode* node);

public slots:

  void onNodeAddedEvent(vtkObject* scene, vtkObject* node);
  void onNodeRemovedEvent(vtkObject* scene, vtkObject* node);
  void onMRMLSceneEndImportEvent();
  void onMRMLSceneEndRestoreEvent();
  void onMRMLSceneEndBatchProcessEvent();
  void onMRMLSceneEndCloseEvent();
  void onPKeyActivated();

  void checkForAnnotationFiducialConversion();
  void convertAnnotationFiducialsToMarkups();

  void onResetToDefaultDisplayPropertiesPushButtonClicked();
  void onSaveToDefaultDisplayPropertiesPushButtonClicked();

  void onVisibilityOnAllControlPointsInListPushButtonClicked();
  void onVisibilityOffAllControlPointsInListPushButtonClicked();
  void onVisibilityAllControlPointsInListToggled();
  void onLockAllControlPointsInListPushButtonClicked();
  void onUnlockAllControlPointsInListPushButtonClicked();
  void onLockAllControlPointsInListToggled();
  void onSelectAllControlPointsInListPushButtonClicked();
  void onDeselectAllControlPointsInListPushButtonClicked();
  void onSelectedAllControlPointsInListToggled();
  void onAddControlPointPushButtonClicked();
  void onMoveControlPointUpPushButtonClicked();
  void onMoveControlPointDownPushButtonClicked();
  void onRestoreControlPointPushButtonClicked();
  void onResetControlPointPushButtonClicked();
  void onUnsetControlPointPushButtonClicked();
  void onMissingControlPointPushButtonClicked();
  void onDeleteControlPointPushButtonClicked(bool confirm=true);
  void onDeleteAllControlPointsInListPushButtonClicked();

  void onActiveMarkupItemChanged(vtkIdType);
  void onActiveMarkupMRMLNodeChanged(vtkMRMLNode *markupsNode);
  void onSelectionNodeActivePlaceNodeIDChanged();

  void onActiveMarkupMRMLNodeAdded(vtkMRMLNode *markupsNode);

  void onCreateMarkupByClass(const QString& className);

  void onListVisibileInvisiblePushButtonClicked();

  void onListLockedUnlockedPushButtonClicked();

  void onFixedNumberOfControlPointsPushButtonClicked();

  void onNameFormatLineEditTextEdited(const QString text);

  void onResetNameFormatToDefaultPushButtonClicked();

  void onRenameAllWithCurrentNameFormatPushButtonClicked();

  void onActiveMarkupTableCellChanged(int row, int column);
  void onActiveMarkupTableCellClicked(QTableWidgetItem* item);
  void onActiveMarkupTableCurrentCellChanged(int currentRow, int currentColumn,
                                             int previousRow, int previousColumn);
  void onRightClickActiveMarkupTableWidget(QPoint pos);
  void addSelectedCoordinatesToMenu(QMenu *menu);
  void onJumpSlicesActionTriggered();
  void onRefocusCamerasActionTriggered();

  QStringList getOtherMarkupNames(vtkMRMLNode *thisMarkup);

  void cutSelectedToClipboard();
  void copySelectedToClipboard();
  void pasteSelectedFromClipboard();

  void onActiveMarkupsNodeModifiedEvent();
  void onActiveMarkupsNodePointModifiedEvent(vtkObject *caller, void *callData);
  void onActiveMarkupsNodePointAddedEvent();
  void onActiveMarkupsNodePointRemovedEvent(vtkObject *caller, void *callData);
  void onActiveMarkupsNodeDisplayModifiedEvent();
  void onActiveMarkupsNodeTransformModifiedEvent();

  void onNewMarkupWithCurrentDisplayPropertiesTriggered();

  void onSliceIntersectionsVisibilityToggled(bool checked);

  void onHideCoordinateColumnsToggled(int index);

  void onTransformedCoordinatesToggled(bool checked);

  void observeMeasurementsInCurrentMarkupsNode();
  void updateMeasurementsDescriptionLabel();
  void populateMeasurementSettingsTable();
  void onMeasurementsCollectionModified();
  void onMeasurementModified(vtkObject* caller);
  void onMeasurementEnabledCheckboxToggled(bool on);

  void onCreateMarkupsPushButtons();

  void onUpdateMarkupsOptionsWidgets();

  // Enable or disable markup table buttons
  void enableMarkupTableButtons(bool enable);

  void updateImportExportWidgets();
  void onImportExportApply();

  void onColorLegendCollapsibleGroupBoxToggled(bool);

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

  void onVisibilityOnAllMarkupsInListPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onVisibilityOnAllMarkupsInListPushButtonClicked method is deprecated, please use onVisibilityOnAllControlPointsInListPushButtonClicked instead");
    this->onVisibilityOnAllControlPointsInListPushButtonClicked();
    };
  void onVisibilityOffAllMarkupsInListPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onVisibilityOffAllMarkupsInListPushButtonClicked method is deprecated, please use onVisibilityOffAllControlPointsInListPushButtonClicked instead");
    this->onVisibilityOffAllControlPointsInListPushButtonClicked();
    };
  void onVisibilityAllMarkupsInListToggled()
    {
    qWarning("qSlicerMarkupsModuleWidget::onVisibilityAllMarkupsInListToggled method is deprecated, please use onVisibilityAllControlPointsInListToggled instead");
    this->onVisibilityAllControlPointsInListToggled();
    };
  void onLockAllMarkupsInListPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onLockAllMarkupsInListPushButtonClicked method is deprecated, please use onLockAllControlPointsInListPushButtonClicked instead");
    this->onLockAllControlPointsInListPushButtonClicked();
    };
  void onUnlockAllMarkupsInListPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onUnlockAllMarkupsInListPushButtonClicked method is deprecated, please use onUnlockAllControlPointsInListPushButtonClicked instead");
    this->onUnlockAllControlPointsInListPushButtonClicked();
    };
  void onLockAllMarkupsInListToggled()
    {
    qWarning("qSlicerMarkupsModuleWidget::onLockAllMarkupsInListToggled method is deprecated, please use onLockAllControlPointsInListToggled instead");
    this->onLockAllControlPointsInListToggled();
    };
  void onSelectAllMarkupsInListPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onSelectAllMarkupsInListPushButtonClicked method is deprecated, please use onSelectAllControlPointsInListPushButtonClicked instead");
    this->onSelectAllControlPointsInListPushButtonClicked();
    };
  void onDeselectAllMarkupsInListPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onDeselectAllMarkupsInListPushButtonClicked method is deprecated, please use onDeselectAllControlPointsInListPushButtonClicked instead");
    this->onDeselectAllControlPointsInListPushButtonClicked();
    };
  void onSelectedAllMarkupsInListToggled()
    {
    qWarning("qSlicerMarkupsModuleWidget::onSelectedAllMarkupsInListToggled method is deprecated, please use onSelectedAllControlPointsInListToggled instead");
    this->onSelectedAllControlPointsInListToggled();
    };
  void onAddMarkupPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onAddMarkupPushButtonClicked method is deprecated, please use onAddControlPointPushButtonClicked instead");
    this->onAddControlPointPushButtonClicked();
    };
  void onMoveMarkupUpPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onMoveMarkupUpPushButtonClicked method is deprecated, please use onMoveControlPointUpPushButtonClicked instead");
    this->onMoveControlPointUpPushButtonClicked();
    };
  void onMoveMarkupDownPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onMoveMarkupDownPushButtonClicked method is deprecated, please use onMoveControlPointDownPushButtonClicked instead");
    this->onMoveControlPointDownPushButtonClicked();
    };
  void onRestoreMarkupPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onRestoreMarkupPushButtonClicked method is deprecated, please use onRestoreControlPointPushButtonClicked instead");
    this->onRestoreControlPointPushButtonClicked();
    };
  void onResetMarkupPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onResetMarkupPushButtonClicked method is deprecated, please use onResetControlPointPushButtonClicked instead");
    this->onResetControlPointPushButtonClicked();
    };
  void onUnsetMarkupPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onUnsetMarkupPushButtonClicked method is deprecated, please use onUnsetControlPointPushButtonClicked instead");
    this->onUnsetControlPointPushButtonClicked();
    };
  void onMissingMarkupPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onMissingMarkupPushButtonClicked method is deprecated, please use onMissingControlPointPushButtonClicked instead");
    this->onMissingControlPointPushButtonClicked();
    };
  void onDeleteMarkupPushButtonClicked(bool confirm=true)
    {
    qWarning("qSlicerMarkupsModuleWidget::onDeleteMarkupPushButtonClicked method is deprecated, please use onDeleteControlPointPushButtonClicked instead");
    this->onDeleteControlPointPushButtonClicked(confirm);
    };
  void onDeleteAllMarkupsInListPushButtonClicked()
    {
    qWarning("qSlicerMarkupsModuleWidget::onDeleteAllMarkupsInListPushButtonClicked method is deprecated, please use onDeleteAllControlPointsInListPushButtonClicked instead");
    this->onDeleteAllControlPointsInListPushButtonClicked();
    };

protected:
  QScopedPointer<qSlicerMarkupsModuleWidgetPrivate> d_ptr;

  void setup() override;

  double volumeSpacingScaleFactor;

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

#endif