vtkQuaternionInterpolator.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 vtkQuaternionInterpolator_h
#define vtkQuaternionInterpolator_h
 
#include "vtkCommonMathModule.h" // For export macro
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
#include <vector> // for arg, return
 
VTK_ABI_NAMESPACE_BEGIN
class vtkQuaterniond;
class vtkQuaternionList;
 
class VTKCOMMONMATH_EXPORT VTK_MARSHALAUTO vtkQuaternionInterpolator : public vtkObject
{
public:
  vtkTypeMacro(vtkQuaternionInterpolator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkQuaternionInterpolator* New();
 
  enum vtkQuaternionInterpolationSearchMethod
  {
    BinarySearch = 0,
    LinearSearch = 1,
    MaxEnum = 3
  };

  int GetNumberOfQuaternions();


  double GetMinimumT();
  double GetMaximumT();

  void Initialize();


  void AddQuaternion(double t, const vtkQuaterniond& q);
  void AddQuaternion(double t, double q[4]);

  void RemoveQuaternion(double t);


  void InterpolateQuaternion(double t, vtkQuaterniond& q);
  void InterpolateQuaternion(double t, double q[4]);


  int GetSearchMethod();
  void SetSearchMethod(int type);

  enum
  {
    INTERPOLATION_TYPE_LINEAR = 0,
    INTERPOLATION_TYPE_SPLINE
  };


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


  void SetTimedQuaternions(const std::vector<double>& values);
  std::vector<double> GetTimedQuaternions() const;
 
protected:
  vtkQuaternionInterpolator();
  ~vtkQuaternionInterpolator() override;
 
  // Specify the type of interpolation to use
  int InterpolationType;
  int SearchMethod;
 
  // Internal variables for interpolation functions
  vtkQuaternionList* QuaternionList; // used for linear quaternion interpolation
 
private:
  vtkQuaternionInterpolator(const vtkQuaternionInterpolator&) = delete;
  void operator=(const vtkQuaternionInterpolator&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif