vtkTupleInterpolator.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 vtkTupleInterpolator_h
#define vtkTupleInterpolator_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 vtkSpline;
class vtkPiecewiseFunction;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkTupleInterpolator : public vtkObject
{
public:
  vtkTypeMacro(vtkTupleInterpolator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkTupleInterpolator* New();


  void SetNumberOfComponents(int numComp);
  vtkGetMacro(NumberOfComponents, int);

  int GetNumberOfTuples();


  double GetMinimumT();
  double GetMaximumT();

  void Initialize();

  void FillFromData(int nb, double* t, double** data, bool isSOADataArray = false);

  void AddTuple(double t, double tuple[]) VTK_SIZEHINT(tuple, GetNumberOfComponents());

  void RemoveTuple(double t);

  void InterpolateTuple(double t, double tuple[]);
  std::vector<double> InterpolateTuple(double t);

  enum
  {
    INTERPOLATION_TYPE_LINEAR = 0,
    INTERPOLATION_TYPE_SPLINE
  };


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


  void SetInterpolatingSpline(vtkSpline*);
  vtkGetObjectMacro(InterpolatingSpline, vtkSpline);


  void SetTimedTuples(const std::vector<double>& values);
  std::vector<double> GetTimedTuples() const;
 
protected:
  vtkTupleInterpolator();
  ~vtkTupleInterpolator() override;
 
  // The number of components being interpolated
  int NumberOfComponents;
 
  // Specify the type of interpolation to use
  int InterpolationType;
 
  // This is the default 1D spline to use
  vtkSpline* InterpolatingSpline;
 
  // Internal variables for interpolation functions
  void InitializeInterpolation();
  vtkPiecewiseFunction** Linear;
  vtkSpline** Spline;
 
private:
  vtkTupleInterpolator(const vtkTupleInterpolator&) = delete;
  void operator=(const vtkTupleInterpolator&) = delete;

  vtkPiecewiseFunction* GetComponentFunction(int i) const;

  void RestoreTimedTuples(const std::vector<double>& values, int numComp);

  void ReinitializeInterpolation(int numComp);
};
 
VTK_ABI_NAMESPACE_END
#endif