VTK  9.1.0
vtkCameraInterpolator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCameraInterpolator.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
49 #ifndef vtkCameraInterpolator_h
50 #define vtkCameraInterpolator_h
51 
52 #include "vtkObject.h"
53 #include "vtkRenderingCoreModule.h" // For export macro
54 
55 class vtkCamera;
56 class vtkCameraList;
58 class vtkCameraList;
59 
60 class VTKRENDERINGCORE_EXPORT vtkCameraInterpolator : public vtkObject
61 {
62 public:
64  void PrintSelf(ostream& os, vtkIndent indent) override;
65 
70 
75 
77 
81  double GetMinimumT();
82  double GetMaximumT();
84 
88  void Initialize();
89 
96  void AddCamera(double t, vtkCamera* camera);
97 
102  void RemoveCamera(double t);
103 
109  void InterpolateCamera(double t, vtkCamera* camera);
110 
114  enum
115  {
116  INTERPOLATION_TYPE_LINEAR = 0,
118  INTERPOLATION_TYPE_MANUAL
119  };
120 
122 
132  vtkSetClampMacro(InterpolationType, int, INTERPOLATION_TYPE_LINEAR, INTERPOLATION_TYPE_MANUAL);
133  vtkGetMacro(InterpolationType, int);
134  void SetInterpolationTypeToLinear() { this->SetInterpolationType(INTERPOLATION_TYPE_LINEAR); }
135  void SetInterpolationTypeToSpline() { this->SetInterpolationType(INTERPOLATION_TYPE_SPLINE); }
136  void SetInterpolationTypeToManual() { this->SetInterpolationType(INTERPOLATION_TYPE_MANUAL); }
138 
140 
149 
151 
158  vtkGetObjectMacro(FocalPointInterpolator, vtkTupleInterpolator);
160 
162 
169  vtkGetObjectMacro(ViewUpInterpolator, vtkTupleInterpolator);
171 
173 
180  vtkGetObjectMacro(ViewAngleInterpolator, vtkTupleInterpolator);
182 
184 
191  vtkGetObjectMacro(ParallelScaleInterpolator, vtkTupleInterpolator);
193 
195 
202  vtkGetObjectMacro(ClippingRangeInterpolator, vtkTupleInterpolator);
204 
209  vtkMTimeType GetMTime() override;
210 
211 protected:
214 
215  // Control the interpolation type
217 
218  // These perform the interpolation
225 
226  // Initialize the interpolating splines
230 
231  // Hold the list of cameras. PIMPL'd STL list.
232  vtkCameraList* CameraList;
233 
234 private:
236  void operator=(const vtkCameraInterpolator&) = delete;
237 };
238 
239 #endif
interpolate a series of cameras to update a new camera
virtual void SetParallelScaleInterpolator(vtkTupleInterpolator *)
Set/Get the tuple interpolator used to interpolate the parallel scale portion of the camera.
vtkTupleInterpolator * ClippingRangeInterpolator
vtkTupleInterpolator * ParallelScaleInterpolator
void SetInterpolationTypeToLinear()
These are convenience methods to switch between linear and spline interpolation.
void SetInterpolationTypeToSpline()
These are convenience methods to switch between linear and spline interpolation.
void Initialize()
Clear the list of cameras.
virtual void SetClippingRangeInterpolator(vtkTupleInterpolator *)
Set/Get the tuple interpolator used to interpolate the clipping range portion of the camera.
virtual void SetPositionInterpolator(vtkTupleInterpolator *)
Set/Get the tuple interpolator used to interpolate the position portion of the camera.
virtual void SetFocalPointInterpolator(vtkTupleInterpolator *)
Set/Get the tuple interpolator used to interpolate the focal point portion of the camera.
vtkTupleInterpolator * ViewUpInterpolator
vtkTupleInterpolator * ViewAngleInterpolator
vtkMTimeType GetMTime() override
Override GetMTime() because we depend on the interpolators which may be modified outside of this clas...
int GetNumberOfCameras()
Return the number of cameras in the list of cameras.
vtkTupleInterpolator * FocalPointInterpolator
vtkTupleInterpolator * PositionInterpolator
void RemoveCamera(double t)
Delete the camera at a particular parameter t.
~vtkCameraInterpolator() override
virtual void SetViewUpInterpolator(vtkTupleInterpolator *)
Set/Get the tuple interpolator used to interpolate the view up portion of the camera.
void AddCamera(double t, vtkCamera *camera)
Add another camera to the list of cameras defining the camera function.
virtual void SetViewAngleInterpolator(vtkTupleInterpolator *)
Set/Get the tuple interpolator used to interpolate the view angle portion of the camera.
double GetMinimumT()
Obtain some information about the interpolation range.
static vtkCameraInterpolator * New()
Instantiate the class.
void InterpolateCamera(double t, vtkCamera *camera)
Interpolate the list of cameras and determine a new camera (i.e., fill in the camera provided).
void SetInterpolationTypeToManual()
These are convenience methods to switch between linear and spline interpolation.
double GetMaximumT()
Obtain some information about the interpolation range.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
a virtual camera for 3D rendering
Definition: vtkCamera.h:46
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
record modification and/or execution time
Definition: vtkTimeStamp.h:33
interpolate a tuple of arbitrary size
@ PositionInterpolator
Definition: vtkX3D.h:151
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287