qMRMLThreeDView.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 __qMRMLThreeDView_h
#define __qMRMLThreeDView_h
 
// CTK includes
#include <ctkPimpl.h>
#include <ctkVTKRenderView.h>
 
#include "qMRMLWidgetsExport.h"
 
class QDropEvent;
class qMRMLThreeDViewPrivate;
class vtkMRMLAbstractDisplayableManager;
class vtkMRMLDisplayableManagerGroup;
class vtkMRMLCameraNode;
class vtkMRMLScene;
class vtkMRMLThreeDViewInteractorStyle;
class vtkMRMLViewNode;
class vtkCollection;
class vtkSSAOPass;

class QMRML_WIDGETS_EXPORT qMRMLThreeDView : public ctkVTKRenderView
{
  Q_OBJECT
  Q_PROPERTY(bool shadowsVisibility READ shadowsVisibility WRITE setShadowsVisibility)
  Q_PROPERTY(double ambientShadowsSizeScale READ ambientShadowsSizeScale WRITE setAmbientShadowsSizeScale)
  Q_PROPERTY(double ambientShadowsVolumeOpacityThreshold READ ambientShadowsVolumeOpacityThreshold WRITE setAmbientShadowsVolumeOpacityThreshold)
  Q_PROPERTY(double ambientShadowsIntensityScale READ ambientShadowsIntensityScale WRITE setAmbientShadowsIntensityScale)
  Q_PROPERTY(double ambientShadowsIntensityShift READ ambientShadowsIntensityShift WRITE setAmbientShadowsIntensityShift)
 
public:
  typedef ctkVTKRenderView Superclass;

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

  void setInteractor(vtkRenderWindowInteractor* interactor) override;

  Q_INVOKABLE vtkMRMLThreeDViewInteractorStyle* interactorObserver() const;

  void addDisplayableManager(const QString& displayableManager);
  Q_INVOKABLE void getDisplayableManagers(vtkCollection* displayableManagers);

  Q_INVOKABLE vtkMRMLAbstractDisplayableManager* displayableManagerByClassName(const char* className);

  Q_INVOKABLE vtkMRMLViewNode* mrmlViewNode() const;

  Q_INVOKABLE void rotateToViewAxis(unsigned int axisId);
  Q_INVOKABLE void rotateToViewAxis(const std::string& axisLabel);
  Q_INVOKABLE void resetCamera(bool resetRotation = true, bool resetTranslation = true, bool resetDistance = true);

  Q_INVOKABLE vtkMRMLCameraNode* cameraNode();

  Q_INVOKABLE void setViewCursor(const QCursor&);

  Q_INVOKABLE void unsetViewCursor();

  Q_INVOKABLE void setDefaultViewCursor(const QCursor& cursor);
 
  void dragEnterEvent(QDragEnterEvent* event) override;
  void dropEvent(QDropEvent* event) override;
 
  bool shadowsVisibility() const;
  double ambientShadowsSizeScale() const;
  double ambientShadowsVolumeOpacityThreshold() const;
  double ambientShadowsIntensityScale() const;
  double ambientShadowsIntensityShift() const;

  Q_INVOKABLE vtkSSAOPass* ssaoPass() const;
 
public slots:

  void setMRMLScene(vtkMRMLScene* newScene);

  void setMRMLViewNode(vtkMRMLViewNode* newViewNode);

  void lookFromViewAxis(const ctkAxesWidget::Axis& axis)
  {
    qWarning("This function is deprecated. Use lookFromAxis(const ctkAxesWidget::Axis& axis) instead.");
    this->lookFromAxis(axis);
  };

  virtual void resetFocalPoint();
 
  void setShadowsVisibility(bool);
  void setAmbientShadowsSizeScale(double);
  void setAmbientShadowsVolumeOpacityThreshold(double);
  void setAmbientShadowsIntensityScale(double);
  void setAmbientShadowsIntensityShift(double);
 
protected:
  friend class qMRMLLayoutThreeDViewFactory;
  vtkMRMLDisplayableManagerGroup* displayableManagerGroup() const;
 
private:
  Q_DECLARE_PRIVATE(qMRMLThreeDView);
  Q_DISABLE_COPY(qMRMLThreeDView);
};
 
#endif