qMRMLSliceControllerWidget.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 Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qMRMLSliceControllerWidget_h
#define __qMRMLSliceControllerWidget_h

// qMRMLWidget includes
#include "qMRMLViewControllerBar.h"
#include <vtkVersion.h>

class QButtonGroup;
class QToolButton;
class qMRMLSliceControllerWidgetPrivate;
class qMRMLSliderWidget;
class vtkAlgorithmOutput;
class vtkCollection;
class vtkImageData;
class vtkMRMLNode;
class vtkMRMLScene;
class vtkMRMLSliceCompositeNode;
class vtkMRMLSliceLogic;
class vtkMRMLSliceNode;

class QMRML_WIDGETS_EXPORT qMRMLSliceControllerWidget
  : public qMRMLViewControllerBar
{
  Q_OBJECT
  Q_PROPERTY(QString sliceViewName READ sliceViewName WRITE setSliceViewName)
  Q_PROPERTY(QString sliceViewLabel READ sliceViewLabel WRITE setSliceViewLabel)
  Q_PROPERTY(QColor sliceViewColor READ sliceViewColor WRITE setSliceViewColor)
  Q_PROPERTY(double sliceOffsetResolution READ sliceOffsetResolution WRITE setSliceOffsetResolution)
  Q_PROPERTY(bool moreButtonVisibility READ isMoreButtonVisible WRITE setMoreButtonVisible)
  Q_PROPERTY(QString sliceOrientation READ sliceOrientation WRITE setSliceOrientation)
public:
  typedef qMRMLViewControllerBar Superclass;

  explicit qMRMLSliceControllerWidget(QWidget* parent = nullptr);
  ~qMRMLSliceControllerWidget() override;

  bool isLinked()const;

  bool isCompareView()const;

  QString sliceOrientation()const;

  Q_INVOKABLE vtkAlgorithmOutput* imageDataConnection()const;

  Q_INVOKABLE vtkMRMLSliceNode* mrmlSliceNode()const;

  Q_INVOKABLE vtkMRMLSliceCompositeNode* mrmlSliceCompositeNode()const;

  void setSliceViewName(const QString& newSliceViewName);

  QString sliceViewName()const;

  void setSliceViewLabel(const QString& newSliceViewLabel);

  QString sliceViewLabel()const;

  void setSliceViewColor(const QColor& newSliceViewColor);

  QColor sliceViewColor()const;

  Q_INVOKABLE void setSliceOffsetRange(double min, double max);

  void setSliceOffsetResolution(double resolution);

  double sliceOffsetResolution();

  Q_INVOKABLE vtkMRMLSliceLogic* sliceLogic()const;

  Q_INVOKABLE void setSliceLogic(vtkMRMLSliceLogic * newSliceLogic);

  Q_INVOKABLE void setControllerButtonGroup(QButtonGroup* group);

  Q_INVOKABLE void setSliceLogics(vtkCollection* logics);

  Q_INVOKABLE qMRMLSliderWidget* sliceOffsetSlider();

  Q_INVOKABLE QToolButton* fitToWindowToolButton();

public slots:

  void setMRMLScene(vtkMRMLScene* newScene) override;

  void setMRMLSliceNode(vtkMRMLSliceNode* newSliceNode);

  void setImageDataConnection(vtkAlgorithmOutput* newImageDataConnection);

  void setSliceViewSize(const QSize& newSize);

  void fitSliceToBackground();

  void setSliceOrientation(const QString& orientation);

  void setSliceOffsetValue(double offset);

  void trackSliceOffsetValue(double offset);

  void setSliceVisible(bool visible);

  void setSliceLink(bool linked);

  void setHotLinked(bool hot);

  // Advanced options
  void setMoreButtonVisible(bool visible);
  bool isMoreButtonVisible() const;

  void moveBackgroundComboBox(bool move);
  void updateSegmentationControlsVisibility();

  void rotateSliceToLowestVolumeAxes();

  void setSegmentationHidden(bool hide);
  void setLabelMapHidden(bool hide);
  void setForegroundHidden(bool hide);
  void setBackgroundHidden(bool hide);

  void setSegmentationOpacity(double opacity);
  void setLabelMapOpacity(double opacity);
  void setForegroundOpacity(double opacity);
  void setBackgroundOpacity(double opacity);

  void toggleSegmentationOutlineFill();
  void showLabelOutline(bool show);
  void showReformatWidget(bool show);
  void lockReformatWidgetToCamera(bool lock);
  void setCompositing(int mode);
  void setCompositingToAlphaBlend();
  void setCompositingToReverseAlphaBlend();
  void setCompositingToAdd();
  void setCompositingToSubtract();
  void setSliceSpacingMode(bool automatic);
  void setSliceSpacing(double spacing);
  void setSliceFOV(double fov);

  void setSliceModelMode(int mode);
  void setSliceModelModeVolumes();
  void setSliceModelMode2D();
  void setSliceModelMode2D_Volumes();
  void setSliceModelModeVolumes_2D();
  void setSliceModelModeCustom();

  void setSliceModelFOV(int index, double fov);
  void setSliceModelFOVX(double fov);
  void setSliceModelFOVY(double fov);

  void setSliceModelOrigin(int index, double fov);
  void setSliceModelOriginX(double fov);
  void setSliceModelOriginY(double fov);

  void setSliceModelDimension(int index, int dim);
  void setSliceModelDimensionX(int dim);
  void setSliceModelDimensionY(int dim);

  // Orientation marker
  void setOrientationMarkerType(int type);
  void setOrientationMarkerSize(int size);

  // Ruler
  void setRulerType(int type);
  void setRulerColor(int color);

  // Lightbox
  void setLightbox(int rows, int columns);
  void setLightboxTo1x1();
  void setLightboxTo1x2();
  void setLightboxTo1x3();
  void setLightboxTo1x4();
  void setLightboxTo1x6();
  void setLightboxTo1x8();
  void setLightboxTo2x2();
  void setLightboxTo3x3();
  void setLightboxTo6x6();
  // interpolation
  void setForegroundInterpolation(bool nearestNeighbor);
  void setBackgroundInterpolation(bool nearestNeighbor);

  void updateWidgetFromMRMLView() override;

signals:
  void imageDataConnectionChanged(vtkAlgorithmOutput * imageDataConnection);

  void renderRequested();

  void nodeAboutToBeEdited(vtkMRMLNode* node);

protected:
  qMRMLSliceControllerWidget(qMRMLSliceControllerWidgetPrivate* obj,
                             QWidget* parent);

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

#endif