qMRMLUnitWidget.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  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 Johan Andruejol, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qMRMLUnitWidget_h
#define __qMRMLUnitWidget_h

// CTK includes
#include <ctkVTKObject.h>

// MRML includes
class vtkMRMLNode;

// qMRML includes
#include <qMRMLWidget.h>
class qMRMLNodeComboBox;

// Qt includes
class QWidget;

// Unit includes
#include "qSlicerUnitsModuleWidgetsExport.h"
class qMRMLUnitWidgetPrivate;
class vtkSlicerUnitsLogic;

class Q_SLICER_MODULE_UNITS_WIDGETS_EXPORT qMRMLUnitWidget : public qMRMLWidget
{
  Q_OBJECT
  QVTK_OBJECT
  Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
  Q_PROPERTY(QString quantity READ quantity WRITE setQuantity NOTIFY quantityChanged)
  Q_PROPERTY(QString prefix READ prefix WRITE setPrefix NOTIFY prefixChanged)
  Q_PROPERTY(QString suffix READ suffix WRITE setSuffix NOTIFY suffixChanged)
  Q_PROPERTY(int precision READ precision WRITE setPrecision NOTIFY precisionChanged)
  Q_PROPERTY(double minimum READ minimum WRITE setMinimum NOTIFY minimumChanged)
  Q_PROPERTY(double maximum READ maximum WRITE setMaximum NOTIFY maximumChanged)
  Q_PROPERTY(double coefficient READ coefficient WRITE setCoefficient NOTIFY coefficientChanged)
  Q_PROPERTY(double offset READ offset WRITE setOffset NOTIFY offsetChanged)

  Q_PROPERTY(UnitProperties displayedProperties READ displayedProperties WRITE setDisplayedProperties)
  Q_PROPERTY(UnitProperties editableProperties READ editableProperties WRITE setEditableProperties)

  Q_FLAGS(UnitProperty UnitProperties)

public:
  typedef qMRMLWidget Superclass;
  qMRMLUnitWidget(QWidget *parent=nullptr);
  ~qMRMLUnitWidget() override;

  QString name() const;
  QString quantity() const;
  QString prefix() const;
  QString suffix() const;
  int precision() const;
  double minimum() const;
  double maximum() const;
  double coefficient() const;
  double offset() const;

  enum UnitProperty
    {
    None = 0x000,
    Preset = 0x001,
    Name = 0x002,
    Quantity = 0x004,
    Precision = 0x008,
    Prefix = 0x010,
    Suffix = 0x020,
    Minimum = 0x040,
    Maximum = 0x080,
    Coefficient = 0x100,
    Offset = 0x200,
    All = 0xfff,
    };
  Q_DECLARE_FLAGS(UnitProperties, UnitProperty)

  
  UnitProperties displayedProperties() const;
  UnitProperties editableProperties() const;

  void setMRMLScene(vtkMRMLScene* unitsLogicScene) override;

  Q_INVOKABLE vtkMRMLNode* currentNode() const;

public slots:
  void setCurrentNode(vtkMRMLNode* unitNode);

  void setName(const QString &);
  void setQuantity(const QString &);
  void setPrefix(const QString &);
  void setSuffix(const QString &);
  void setPrecision(int);
  void setMinimum(double);
  void setMaximum(double);
  void setCoefficient(double);
  void setOffset(double);

  void setUnitFromPreset(vtkMRMLNode* presetNode);

  void setDisplayedProperties(UnitProperties properties);
  void setEditableProperties(UnitProperties properties);

protected slots:
  void updateWidgetFromNode();

signals:
  void nameChanged(QString);
  void quantityChanged(QString);
  void prefixChanged(QString);
  void suffixChanged(QString);
  void precisionChanged(int);
  void minimumChanged(double);
  void maximumChanged(double);
  void coefficientChanged(double);
  void offsetChanged(double);

protected:
  QScopedPointer<qMRMLUnitWidgetPrivate> d_ptr;

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

Q_DECLARE_OPERATORS_FOR_FLAGS(qMRMLUnitWidget::UnitProperties)

#endif