CTK/Libs/Visualization/VTK/Widgets/ctkVTKRenderView.h

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

  Library:   CTK

  Copyright (c) Kitware Inc.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.commontk.org/LICENSE

  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 __ctkVTKRenderView_h
#define __ctkVTKRenderView_h

// Qt includes
#include <QWidget>

// CTK includes
#include <ctkPimpl.h>

#include "ctkVisualizationVTKWidgetsExport.h"

class ctkVTKRenderViewPrivate;
class vtkInteractorObserver;
class vtkRenderWindowInteractor;
class vtkRenderWindow;
class vtkRenderer;
class vtkCamera; 

class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKRenderView : public QWidget
{
  Q_OBJECT
  Q_PROPERTY(QString cornerAnnotationText READ cornerAnnotationText WRITE setCornerAnnotationText)
  Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor)
  Q_PROPERTY(bool renderEnabled READ renderEnabled WRITE setRenderEnabled)
  Q_PROPERTY(bool orientationWidgetVisible READ orientationWidgetVisible
             WRITE setOrientationWidgetVisible)
  Q_PROPERTY(double zoomFactor READ zoomFactor WRITE setZoomFactor)
  Q_PROPERTY(int pitchRollYawIncrement READ pitchRollYawIncrement WRITE setPitchRollYawIncrement)
  Q_ENUMS(RotateDirection)
  Q_PROPERTY(RotateDirection pitchDirection READ pitchDirection WRITE setPitchDirection)
  Q_PROPERTY(RotateDirection rollDirection READ rollDirection WRITE setRollDirection)
  Q_PROPERTY(RotateDirection yawDirection READ yawDirection WRITE setYawDirection)
  Q_PROPERTY(RotateDirection spinDirection READ spinDirection WRITE setSpinDirection)
  Q_PROPERTY(bool spinEnabled READ spinEnabled WRITE setSpinEnabled)
  Q_PROPERTY(int spinIncrement READ spinIncrement WRITE setSpinIncrement)
  Q_PROPERTY(int animationIntervalMs READ animationIntervalMs WRITE setAnimationIntervalMs)
  Q_PROPERTY(bool rockEnabled READ rockEnabled WRITE setRockEnabled)
  Q_PROPERTY(int rockLength READ rockLength WRITE setRockLength)

public:

  enum RotateDirection { PitchUp, PitchDown, RollLeft, RollRight, YawLeft, YawRight };

  typedef QWidget Superclass;
  explicit ctkVTKRenderView(QWidget* parent = 0);
  virtual ~ctkVTKRenderView();

public slots:

  /// If a render has already been scheduled, this called is a no-op
  void scheduleRender();

  /// Force a render even if a render is already ocurring
  void forceRender();

  /// Set background color
  void setBackgroundColor(const QColor& newBackgroundColor);

  /// Enable/Disable rendering
  void setRenderEnabled(bool value);

  /// Set corner annotation \a text
  void setCornerAnnotationText(const QString& text);

  /// Show/Hide Orientation widget
  void setOrientationWidgetVisible(bool visible);

  /// Set absolute amount degrees the view should be either pitched, rolled or yawed with.
  /// \sa pitch setPitchDirection roll setRollDirection yaw setYawDirection
  /// \note The default is 5 degrees
  void setPitchRollYawIncrement(int newPitchRollYawIncrement);

  /// Pitch view of X degrees. X been set using setPitchRollYawIncrement
  /// \sa setPitchRollYawIncrement setPitchDirection
  void pitch();

  /// Rool view of X degrees. X been set using setPitchRollYawIncrement
  /// \sa setPitchRollYawIncrement setRollDirection
  void roll();

  /// Yaw view of X degrees. X been set using setPitchRollYawIncrement
  /// \sa setPitchRollYawIncrement setYawDirection
  void yaw();

  /// Enable or Disbled the animated spin of the view
  void setSpinEnabled(bool enabled);

  /// Set number of degrees in spin increment
  /// \sa setSpinDirection setSpinIntervalMs
  void setSpinIncrement(int newSpinIncrement);

  /// Amount of wait time between spin or rock increments
  /// \sa setSpinIncrement setRockIncrement
  void setAnimationIntervalMs(int ms);

  /// Enable or Disbled the animated rock of the view
  void setRockEnabled(bool enabled);

  /// Set length of the rock animation
  void setRockLength(int newRockLength);

  /// Set increment of animated rock
  void setRockIncrement(int newRockIncrement);

  /// \brief Set zoom factor
  /// zoomFactor is a value between 0.0 and 1.0
  /// \note The default value is 0.05
  void setZoomFactor(double newZoomFactor);

  /// Zoom in using the \a zoomfactor
  /// \sa setZoomFactor
  void zoomIn();

  /// Zoom out using the \a zoomfactor
  /// \sa setZoomFactor
  void zoomOut();

  /// Set the focal point
  void setFocalPoint(int x, int y, int z);

  /// \brief Reset focal point
  /// The visible scene bbox is computed, then the camera is recentered around its centroid.
  void resetFocalPoint();

public:
  /// Get underlying RenderWindow
  vtkRenderWindow* renderWindow()const;
  
  /// Set/Get window interactor
  vtkRenderWindowInteractor* interactor()const;
  void setInteractor(vtkRenderWindowInteractor* newInteractor);

  /// Get current interactor style
  vtkInteractorObserver* interactorStyle();

  /// Get corner annotation \a text
  QString cornerAnnotationText() const;

  /// Get background color
  QColor backgroundColor() const;

  /// Get Orientation widget visibility
  bool orientationWidgetVisible();

  /// Get active camera
  vtkCamera* activeCamera();

  /// Reset camera
  void resetCamera();

  /// Get a reference to the associated vtkRenderer
  vtkRenderer* renderer()const;

  /// Return if rendering is enabled
  bool renderEnabled() const;

  /// Return pitch, roll or yaw increment (in degree)
  int pitchRollYawIncrement()const;

  /// Return if animated spin is enabled
  bool spinEnabled() const;

  /// Return spin increment (in degrees)
  /// \sa setSpinIncrement
  int spinIncrement()const;

  /// Amount of waiting time between spin or rock increment
  /// \sa setAnimationIntervalMs
  int animationIntervalMs()const;

  /// Return if animated rock is enabled
  bool rockEnabled() const;

  /// Return length of the rock animation
  int rockLength() const;

  /// Return increment of animated rock
  int rockIncrement() const;

  RotateDirection pitchDirection()const;
  void setPitchDirection(RotateDirection newPitchDirection);

  RotateDirection rollDirection()const;
  void setRollDirection(RotateDirection newRollDirection);

  RotateDirection yawDirection()const;
  void setYawDirection(RotateDirection newYawDirection);

  RotateDirection spinDirection()const;
  void setSpinDirection(RotateDirection newSpinDirection);

  /// Return zoom factor
  double zoomFactor()const;
  
protected:
  QScopedPointer<ctkVTKRenderViewPrivate> d_ptr;

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

#endif