qMRMLSliceWidget.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 __qMRMLSliceWidget_h
#define __qMRMLSliceWidget_h

// CTK includes
#include <ctkPimpl.h>
#include <vtkVersion.h>

// qMRMLWidget includes
#include "qMRMLWidget.h"

#include "qMRMLWidgetsExport.h"

class qMRMLSliceView;
class qMRMLSliceWidgetPrivate;
class qMRMLSliceControllerWidget;
class vtkCollection;
class vtkMRMLScene;
class vtkMRMLNode;
class vtkMRMLSliceLogic;
class vtkMRMLSliceNode;
class vtkMRMLSliceCompositeNode;

class vtkAlgorithmOutput;
class vtkImageData;
class vtkInteractorObserver;
class vtkCornerAnnotation;
class vtkCollection;

class QMRML_WIDGETS_EXPORT qMRMLSliceWidget : public qMRMLWidget
{
  Q_OBJECT
  Q_PROPERTY(QString sliceOrientation READ sliceOrientation WRITE setSliceOrientation)
  Q_PROPERTY(QString sliceViewName READ sliceViewName WRITE setSliceViewName)
  Q_PROPERTY(QString sliceViewLabel READ sliceViewLabel WRITE setSliceViewLabel)
  Q_PROPERTY(QColor sliceViewColor READ sliceViewColor WRITE setSliceViewColor)

public:
  typedef qMRMLWidget Superclass;

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

  Q_INVOKABLE qMRMLSliceControllerWidget* sliceController()const;

  Q_INVOKABLE vtkMRMLSliceNode* mrmlSliceNode()const;

  Q_INVOKABLE vtkMRMLSliceLogic* sliceLogic()const;

  Q_INVOKABLE QString sliceOrientation()const;

  Q_INVOKABLE vtkAlgorithmOutput* imageDataConnection()const;

  Q_INVOKABLE vtkMRMLSliceCompositeNode* mrmlSliceCompositeNode()const;

  QString sliceViewName()const;

  void setSliceViewName(const QString& newSliceViewName);

  QString sliceViewLabel()const;

  void setSliceViewLabel(const QString& newSliceViewLabel);

  QColor sliceViewColor()const;

  void setSliceViewColor(const QColor& newSliceViewColor);

  Q_INVOKABLE vtkInteractorObserver* interactorStyle()const;

  Q_INVOKABLE vtkCornerAnnotation* overlayCornerAnnotation()const;

  Q_INVOKABLE void setSliceLogics(vtkCollection* logics);

  Q_INVOKABLE qMRMLSliceView* sliceView()const;

public slots:
  void setMRMLScene(vtkMRMLScene * newScene) override;

  void setMRMLSliceNode(vtkMRMLSliceNode* newSliceNode);

  void setImageDataConnection(vtkAlgorithmOutput* newImageDataConnection);

  void setSliceOrientation(const QString& orientation);

  void fitSliceToBackground();

signals:
  void nodeAboutToBeEdited(vtkMRMLNode* node);

protected:
  void showEvent(QShowEvent *) override;

  QScopedPointer<qMRMLSliceWidgetPrivate> d_ptr;

  qMRMLSliceWidget(qMRMLSliceWidgetPrivate* obj, QWidget* parent);

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

#endif