vtkSplineFilter.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 vtkSplineFilter_h
#define vtkSplineFilter_h
 
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
 
#define VTK_SUBDIVIDE_SPECIFIED 0
#define VTK_SUBDIVIDE_LENGTH 1
 
#define VTK_TCOORDS_OFF 0
#define VTK_TCOORDS_FROM_NORMALIZED_LENGTH 1
#define VTK_TCOORDS_FROM_LENGTH 2
#define VTK_TCOORDS_FROM_SCALARS 3
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCellArray;
class vtkCellData;
class vtkFloatArray;
class vtkPointData;
class vtkPoints;
class vtkSpline;
 
class VTKFILTERSGENERAL_EXPORT vtkSplineFilter : public vtkPolyDataAlgorithm
{
public:
  vtkTypeMacro(vtkSplineFilter, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkSplineFilter* New();


  vtkSetClampMacro(MaximumNumberOfSubdivisions, int, 1, VTK_INT_MAX);
  vtkGetMacro(MaximumNumberOfSubdivisions, int);


  vtkSetClampMacro(Subdivide, int, VTK_SUBDIVIDE_SPECIFIED, VTK_SUBDIVIDE_LENGTH);
  vtkGetMacro(Subdivide, int);
  void SetSubdivideToSpecified() { this->SetSubdivide(VTK_SUBDIVIDE_SPECIFIED); }
  void SetSubdivideToLength() { this->SetSubdivide(VTK_SUBDIVIDE_LENGTH); }
  const char* GetSubdivideAsString();


  vtkSetClampMacro(NumberOfSubdivisions, int, 1, VTK_INT_MAX);
  vtkGetMacro(NumberOfSubdivisions, int);


  vtkSetClampMacro(Length, double, 0.0000001, VTK_DOUBLE_MAX);
  vtkGetMacro(Length, double);


  virtual void SetSpline(vtkSpline*);
  vtkGetObjectMacro(Spline, vtkSpline);


  vtkSetClampMacro(GenerateTCoords, int, VTK_TCOORDS_OFF, VTK_TCOORDS_FROM_SCALARS);
  vtkGetMacro(GenerateTCoords, int);
  void SetGenerateTCoordsToOff() { this->SetGenerateTCoords(VTK_TCOORDS_OFF); }
  void SetGenerateTCoordsToNormalizedLength()
  {
    this->SetGenerateTCoords(VTK_TCOORDS_FROM_NORMALIZED_LENGTH);
  }
  void SetGenerateTCoordsToUseLength() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_LENGTH); }
  void SetGenerateTCoordsToUseScalars() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_SCALARS); }
  const char* GetGenerateTCoordsAsString();


  vtkSetClampMacro(TextureLength, double, 0.000001, VTK_INT_MAX);
  vtkGetMacro(TextureLength, double);


  vtkSetMacro(OutputPointsPrecision, int);
  vtkGetMacro(OutputPointsPrecision, int);
 
protected:
  vtkSplineFilter();
  ~vtkSplineFilter() override;
 
  // Usual data generation method
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  int MaximumNumberOfSubdivisions;
  int Subdivide;
  int NumberOfSubdivisions;
  double Length;
  vtkSpline* Spline;
  vtkSpline* XSpline;
  vtkSpline* YSpline;
  vtkSpline* ZSpline;
  int GenerateTCoords;
  double TextureLength; // this length is mapped to [0,1) texture space
  int OutputPointsPrecision;
 
  // helper methods
  int GeneratePoints(vtkIdType offset, vtkIdType npts, const vtkIdType* pts, vtkPoints* inPts,
    vtkPoints* newPts, vtkPointData* pd, vtkPointData* outPD, int genTCoords,
    vtkFloatArray* newTCoords);
 
  void GenerateLine(vtkIdType offset, vtkIdType numGenPts, vtkIdType inCellId, vtkCellData* cd,
    vtkCellData* outCD, vtkCellArray* newLines);
 
  // helper members
  vtkFloatArray* TCoordMap;
 
private:
  vtkSplineFilter(const vtkSplineFilter&) = delete;
  void operator=(const vtkSplineFilter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif