ENH: Allow automatic view rotation by less than 1 degree

Also improved documentation of a few members of the class.

Libs/Visualization/VTK/Widgets/ctkVTKRenderView.cpp

@@ -97,7 +97,7 @@ void ctkVTKRenderViewPrivate::zoom(double zoomFactor)
 }
 
 //---------------------------------------------------------------------------
-void ctkVTKRenderViewPrivate::pitch(int rotateDegrees,
+void ctkVTKRenderViewPrivate::pitch(double rotateDegrees,
                                     ctkVTKRenderView::RotateDirection pitchDirection)
 {
   Q_ASSERT(this->Renderer->IsActiveCameraCreated());
@@ -109,7 +109,7 @@ void ctkVTKRenderViewPrivate::pitch(int rotateDegrees,
 }
 
 //---------------------------------------------------------------------------
-void ctkVTKRenderViewPrivate::roll(int rotateDegrees,
+void ctkVTKRenderViewPrivate::roll(double rotateDegrees,
                                     ctkVTKRenderView::RotateDirection rollDirection)
 {
   Q_ASSERT(this->Renderer->IsActiveCameraCreated());
@@ -122,7 +122,7 @@ void ctkVTKRenderViewPrivate::roll(int rotateDegrees,
 }
 
 //---------------------------------------------------------------------------
-void ctkVTKRenderViewPrivate::yaw(int rotateDegrees,
+void ctkVTKRenderViewPrivate::yaw(double rotateDegrees,
                                     ctkVTKRenderView::RotateDirection yawDirection)
 {
   Q_ASSERT(this->Renderer->IsActiveCameraCreated());
@@ -177,7 +177,7 @@ void ctkVTKRenderViewPrivate::doRock()
 
   double frac = static_cast<double>(this->RockIncrement) / static_cast<double>(this->RockLength);
   double az = 1.5 * cos (2.0 * 3.1415926 * (frac - floor(frac)));
-  this->RockIncrement = 1 + this->RockIncrement;
+  this->RockIncrement++;
   this->RockIncrement = this->RockIncrement % this->RockLength;
 
   // Move the camera
@@ -259,10 +259,10 @@ void ctkVTKRenderView::resetCamera()
 CTK_GET_CPP(ctkVTKRenderView, vtkRenderer*, renderer, Renderer);
 
 //----------------------------------------------------------------------------
-CTK_GET_CPP(ctkVTKRenderView, int, pitchRollYawIncrement, PitchRollYawIncrement);
+CTK_GET_CPP(ctkVTKRenderView, double, pitchRollYawIncrement, PitchRollYawIncrement);
 
 //----------------------------------------------------------------------------
-void ctkVTKRenderView::setPitchRollYawIncrement(int newPitchRollYawIncrement)
+void ctkVTKRenderView::setPitchRollYawIncrement(double newPitchRollYawIncrement)
 {
   Q_D(ctkVTKRenderView);
   d->PitchRollYawIncrement = qAbs(newPitchRollYawIncrement);
@@ -368,14 +368,14 @@ void ctkVTKRenderView::setSpinEnabled(bool enabled)
 CTK_GET_CPP(ctkVTKRenderView, bool, spinEnabled, SpinEnabled);
 
 //----------------------------------------------------------------------------
-void ctkVTKRenderView::setSpinIncrement(int newSpinIncrement)
+void ctkVTKRenderView::setSpinIncrement(double newSpinIncrement)
 {
   Q_D(ctkVTKRenderView);
   d->SpinIncrement = qAbs(newSpinIncrement);
 }
 
 //----------------------------------------------------------------------------
-CTK_GET_CPP(ctkVTKRenderView, int, spinIncrement, SpinIncrement);
+CTK_GET_CPP(ctkVTKRenderView, double, spinIncrement, SpinIncrement);
 
 //----------------------------------------------------------------------------
 void ctkVTKRenderView::setAnimationIntervalMs(int newAnimationIntervalMs)
@@ -457,7 +457,7 @@ void ctkVTKRenderView::zoomOut()
 }
 
 //----------------------------------------------------------------------------
-void ctkVTKRenderView::setFocalPoint(int x, int y, int z)
+void ctkVTKRenderView::setFocalPoint(double x, double y, double z)
 {
   Q_D(ctkVTKRenderView);
   if (!d->Renderer->IsActiveCameraCreated())

Libs/Visualization/VTK/Widgets/ctkVTKRenderView.h

@@ -36,14 +36,14 @@ class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKRenderView : public ctkVTKAbstr
   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_PROPERTY(double 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(double 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)
@@ -63,7 +63,7 @@ public Q_SLOTS:
   /// 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);
+  void setPitchRollYawIncrement(double newPitchRollYawIncrement);
 
   /// Pitch view of X degrees. X been set using setPitchRollYawIncrement
   /// \sa setPitchRollYawIncrement setPitchDirection
@@ -82,7 +82,7 @@ public Q_SLOTS:
 
   /// Set number of degrees in spin increment
   /// \sa setSpinDirection setSpinIntervalMs
-  void setSpinIncrement(int newSpinIncrement);
+  void setSpinIncrement(double newSpinIncrement);
 
   /// Amount of wait time between spin or rock increments
   /// \sa setSpinIncrement setRockIncrement
@@ -91,10 +91,11 @@ public Q_SLOTS:
   /// Enable or Disbled the animated rock of the view
   void setRockEnabled(bool enabled);
 
-  /// Set length of the rock animation
+  /// Set length of a complete rock period (in number of animation steps)
   void setRockLength(int newRockLength);
 
-  /// Set increment of animated rock
+  /// Set current rocking position
+  /// Rocking will be centered around the position where increment is set to 0.
   void setRockIncrement(int newRockIncrement);
 
   /// \brief Set zoom factor
@@ -111,7 +112,7 @@ public Q_SLOTS:
   void zoomOut();
 
   /// Set the focal point
-  void setFocalPoint(int x, int y, int z);
+  void setFocalPoint(double x, double y, double z);
 
   /// \brief Reset focal point
   /// The visible scene bbox is computed, then the camera is recentered around its centroid.
@@ -142,14 +143,14 @@ public:
   virtual void setInteractor(vtkRenderWindowInteractor* interactor);
 
   /// Return pitch, roll or yaw increment (in degree)
-  int pitchRollYawIncrement()const;
+  double pitchRollYawIncrement()const;
 
   /// Return if animated spin is enabled
   bool spinEnabled() const;
 
   /// Return spin increment (in degrees)
   /// \sa setSpinIncrement
-  int spinIncrement()const;
+  double spinIncrement()const;
 
   /// Amount of waiting time between spin or rock increment
   /// \sa setAnimationIntervalMs
@@ -161,7 +162,8 @@ public:
   /// Return length of the rock animation
   int rockLength() const;
 
-  /// Return increment of animated rock
+  /// Return current increment value of animated rock.
+  /// Rocking will be centered around the position where increment is set to 0.
   int rockIncrement() const;
 
   RotateDirection pitchDirection()const;

Libs/Visualization/VTK/Widgets/ctkVTKRenderView_p.h

@@ -58,9 +58,9 @@ public:
 
   void zoom(double zoomFactor);
 
-  void pitch(int rotateDegrees, ctkVTKRenderView::RotateDirection pitchDirection);
-  void roll(int rotateDegrees, ctkVTKRenderView::RotateDirection rollDirection);
-  void yaw(int rotateDegrees, ctkVTKRenderView::RotateDirection yawDirection);
+  void pitch(double rotateDegrees, ctkVTKRenderView::RotateDirection pitchDirection);
+  void roll(double rotateDegrees, ctkVTKRenderView::RotateDirection rollDirection);
+  void yaw(double rotateDegrees, ctkVTKRenderView::RotateDirection yawDirection);
 
 public Q_SLOTS:
   void doSpin();
@@ -74,14 +74,14 @@ public:
   vtkSmartPointer<vtkOrientationMarkerWidget>   Orientation;
 
   double                                        ZoomFactor;
-  int                                           PitchRollYawIncrement;
+  double                                        PitchRollYawIncrement;
   ctkVTKRenderView::RotateDirection             PitchDirection;
   ctkVTKRenderView::RotateDirection             RollDirection;
   ctkVTKRenderView::RotateDirection             YawDirection;
   ctkVTKRenderView::RotateDirection             SpinDirection;
   bool                                          SpinEnabled;
   int                                           AnimationIntervalMs;
-  int                                           SpinIncrement;
+  double                                        SpinIncrement;
   bool                                          RockEnabled;
   int                                           RockIncrement;
   int                                           RockLength;