vtkTransformInterpolator.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 vtkTransformInterpolator_h
#define vtkTransformInterpolator_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 vtkTransform;
class vtkMatrix4x4;
class vtkProp3D;
class vtkTupleInterpolator;
class vtkQuaternionInterpolator;
class vtkTransformList;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkTransformInterpolator : public vtkObject
{
public:
  vtkTypeMacro(vtkTransformInterpolator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkTransformInterpolator* New();

  int GetNumberOfTransforms();


  double GetMinimumT();
  double GetMaximumT();

  void Initialize();


  void AddTransform(double t, vtkTransform* xform);
  void AddTransform(double t, vtkMatrix4x4* matrix);
  void AddTransform(double t, vtkProp3D* prop3D);

  void RemoveTransform(double t);

  void InterpolateTransform(double t, vtkTransform* xform);

  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 SetScaleInterpolator(vtkTupleInterpolator*);
  vtkGetObjectMacro(ScaleInterpolator, vtkTupleInterpolator);


  virtual void SetRotationInterpolator(vtkQuaternionInterpolator*);
  vtkGetObjectMacro(RotationInterpolator, vtkQuaternionInterpolator);


  void SetTimedTransforms(const std::vector<double>& values);
  std::vector<double> GetTimedTransforms() const;

  vtkMTimeType GetMTime() override;
 
protected:
  vtkTransformInterpolator();
  ~vtkTransformInterpolator() override;
 
  // Control the interpolation type
  int InterpolationType;
 
  // Interpolators
  vtkTupleInterpolator* PositionInterpolator;
  vtkTupleInterpolator* ScaleInterpolator;
  vtkQuaternionInterpolator* RotationInterpolator;
 
  // Initialize the interpolating splines
  int Initialized;
  vtkTimeStamp InitializeTime;
  void InitializeInterpolation();
 
  // Keep track of inserted data
  vtkTransformList* TransformList;
 
private:
  vtkTransformInterpolator(const vtkTransformInterpolator&) = delete;
  void operator=(const vtkTransformInterpolator&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif