vtkSpline.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 vtkSpline_h
#define vtkSpline_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkPiecewiseFunction;
 
class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkSpline : public vtkObject
{
public:
  vtkTypeMacro(vtkSpline, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetParametricRange(double tMin, double tMax);
  void SetParametricRange(double tRange[2]) { this->SetParametricRange(tRange[0], tRange[1]); }
  void GetParametricRange(double tRange[2]) const;
  vtkGetVector2Macro(ParametricRange, double);


  vtkSetMacro(ClampValue, vtkTypeBool);
  vtkGetMacro(ClampValue, vtkTypeBool);
  vtkBooleanMacro(ClampValue, vtkTypeBool);


  void SetPiecewiseFunction(vtkPiecewiseFunction* pwf);
  vtkGetObjectMacro(PiecewiseFunction, vtkPiecewiseFunction);

  virtual void Compute() = 0;

  virtual double Evaluate(double t) = 0;

  int GetNumberOfPoints();

  void AddPoint(double t, double x);

  void FillFromDataPointer(int nb, double* data);

  void RemovePoint(double t);

  void RemoveAllPoints();


  vtkSetMacro(Closed, vtkTypeBool);
  vtkGetMacro(Closed, vtkTypeBool);
  vtkBooleanMacro(Closed, vtkTypeBool);


  vtkSetClampMacro(LeftConstraint, int, 0, 3);
  vtkGetMacro(LeftConstraint, int);
  vtkSetClampMacro(RightConstraint, int, 0, 3);
  vtkGetMacro(RightConstraint, int);


  vtkSetMacro(LeftValue, double);
  vtkGetMacro(LeftValue, double);
  vtkSetMacro(RightValue, double);
  vtkGetMacro(RightValue, double);

  vtkMTimeType GetMTime() override;

  virtual void DeepCopy(vtkSpline* s);
 
protected:
  vtkSpline();
  ~vtkSpline() override;
 
  vtkMTimeType ComputeTime;
  vtkTypeBool ClampValue;
  double* Intervals;
  double* Coefficients;
  int LeftConstraint;
  double LeftValue;
  int RightConstraint;
  double RightValue;
  vtkPiecewiseFunction* PiecewiseFunction;
  vtkTypeBool Closed;
 
  // Explicitly specify the parametric range.
  double ParametricRange[2];
 
  // Helper methods
  double ComputeLeftDerivative();
  double ComputeRightDerivative();
  int FindIndex(int size, double t);
 
private:
  vtkSpline(const vtkSpline&) = delete;
  void operator=(const vtkSpline&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif