vtkCameraInterpolator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkCameraInterpolator_h
#define vtkCameraInterpolator_h
 
#include "vtkObject.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO
 
#include <vector> // for arg, return
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCamera;
class vtkCameraList;
class vtkTupleInterpolator;
class vtkCameraList;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkCameraInterpolator : public vtkObject
{
public:
  vtkTypeMacro(vtkCameraInterpolator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkCameraInterpolator* New();

  int GetNumberOfCameras();


  double GetMinimumT();
  double GetMaximumT();

  void Initialize();

  void AddCamera(double t, vtkCamera* camera);

  void RemoveCamera(double t);

  void InterpolateCamera(double t, vtkCamera* camera);

  enum
  {
    INTERPOLATION_TYPE_LINEAR = 0,
    INTERPOLATION_TYPE_SPLINE,
    INTERPOLATION_TYPE_MANUAL
  };


  vtkSetClampMacro(InterpolationType, int, INTERPOLATION_TYPE_LINEAR, INTERPOLATION_TYPE_MANUAL);
  vtkGetMacro(InterpolationType, int);
  void SetInterpolationTypeToLinear() { this->SetInterpolationType(INTERPOLATION_TYPE_LINEAR); }
  void SetInterpolationTypeToSpline() { this->SetInterpolationType(INTERPOLATION_TYPE_SPLINE); }
  void SetInterpolationTypeToManual() { this->SetInterpolationType(INTERPOLATION_TYPE_MANUAL); }


  virtual void SetPositionInterpolator(vtkTupleInterpolator*);
  vtkGetObjectMacro(PositionInterpolator, vtkTupleInterpolator);


  virtual void SetFocalPointInterpolator(vtkTupleInterpolator*);
  vtkGetObjectMacro(FocalPointInterpolator, vtkTupleInterpolator);


  virtual void SetViewUpInterpolator(vtkTupleInterpolator*);
  vtkGetObjectMacro(ViewUpInterpolator, vtkTupleInterpolator);


  virtual void SetViewAngleInterpolator(vtkTupleInterpolator*);
  vtkGetObjectMacro(ViewAngleInterpolator, vtkTupleInterpolator);


  virtual void SetParallelScaleInterpolator(vtkTupleInterpolator*);
  vtkGetObjectMacro(ParallelScaleInterpolator, vtkTupleInterpolator);


  virtual void SetClippingRangeInterpolator(vtkTupleInterpolator*);
  vtkGetObjectMacro(ClippingRangeInterpolator, vtkTupleInterpolator);


  void SetTimedCameras(const std::vector<double>& values);
  std::vector<double> GetTimedCameras() const;

  vtkMTimeType GetMTime() override;
 
protected:
  vtkCameraInterpolator();
  ~vtkCameraInterpolator() override;
 
  // Control the interpolation type
  int InterpolationType;
 
  // These perform the interpolation
  vtkTupleInterpolator* PositionInterpolator;
  vtkTupleInterpolator* FocalPointInterpolator;
  vtkTupleInterpolator* ViewUpInterpolator;
  vtkTupleInterpolator* ViewAngleInterpolator;
  vtkTupleInterpolator* ParallelScaleInterpolator;
  vtkTupleInterpolator* ClippingRangeInterpolator;
 
  // Initialize the interpolating splines
  int Initialized;
  vtkTimeStamp InitializeTime;
  void InitializeInterpolation();
 
  // Hold the list of cameras. PIMPL'd STL list.
  vtkCameraList* CameraList;
 
private:
  vtkCameraInterpolator(const vtkCameraInterpolator&) = delete;
  void operator=(const vtkCameraInterpolator&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif