VTK  9.2.5
vtkSplineFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSplineFilter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
79 #ifndef vtkSplineFilter_h
80 #define vtkSplineFilter_h
81 
82 #include "vtkFiltersGeneralModule.h" // For export macro
83 #include "vtkPolyDataAlgorithm.h"
84 
85 #define VTK_SUBDIVIDE_SPECIFIED 0
86 #define VTK_SUBDIVIDE_LENGTH 1
87 
88 #define VTK_TCOORDS_OFF 0
89 #define VTK_TCOORDS_FROM_NORMALIZED_LENGTH 1
90 #define VTK_TCOORDS_FROM_LENGTH 2
91 #define VTK_TCOORDS_FROM_SCALARS 3
92 
93 class vtkCellArray;
94 class vtkCellData;
95 class vtkFloatArray;
96 class vtkPointData;
97 class vtkPoints;
98 class vtkSpline;
99 
100 class VTKFILTERSGENERAL_EXPORT vtkSplineFilter : public vtkPolyDataAlgorithm
101 {
102 public:
104  void PrintSelf(ostream& os, vtkIndent indent) override;
105 
110  static vtkSplineFilter* New();
111 
113 
117  vtkSetClampMacro(MaximumNumberOfSubdivisions, int, 1, VTK_INT_MAX);
118  vtkGetMacro(MaximumNumberOfSubdivisions, int);
120 
122 
125  vtkSetClampMacro(Subdivide, int, VTK_SUBDIVIDE_SPECIFIED, VTK_SUBDIVIDE_LENGTH);
126  vtkGetMacro(Subdivide, int);
127  void SetSubdivideToSpecified() { this->SetSubdivide(VTK_SUBDIVIDE_SPECIFIED); }
128  void SetSubdivideToLength() { this->SetSubdivide(VTK_SUBDIVIDE_LENGTH); }
129  const char* GetSubdivideAsString();
131 
133 
138  vtkSetClampMacro(NumberOfSubdivisions, int, 1, VTK_INT_MAX);
139  vtkGetMacro(NumberOfSubdivisions, int);
141 
143 
148  vtkSetClampMacro(Length, double, 0.0000001, VTK_DOUBLE_MAX);
149  vtkGetMacro(Length, double);
151 
153 
156  virtual void SetSpline(vtkSpline*);
157  vtkGetObjectMacro(Spline, vtkSpline);
159 
161 
168  vtkSetClampMacro(GenerateTCoords, int, VTK_TCOORDS_OFF, VTK_TCOORDS_FROM_SCALARS);
169  vtkGetMacro(GenerateTCoords, int);
170  void SetGenerateTCoordsToOff() { this->SetGenerateTCoords(VTK_TCOORDS_OFF); }
172  {
173  this->SetGenerateTCoords(VTK_TCOORDS_FROM_NORMALIZED_LENGTH);
174  }
175  void SetGenerateTCoordsToUseLength() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_LENGTH); }
176  void SetGenerateTCoordsToUseScalars() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_SCALARS); }
179 
181 
187  vtkSetClampMacro(TextureLength, double, 0.000001, VTK_INT_MAX);
188  vtkGetMacro(TextureLength, double);
190 
191 protected:
193  ~vtkSplineFilter() override;
194 
195  // Usual data generation method
197 
201  double Length;
207  double TextureLength; // this length is mapped to [0,1) texture space
208 
209  // helper methods
211  vtkPoints* newPts, vtkPointData* pd, vtkPointData* outPD, int genTCoords,
212  vtkFloatArray* newTCoords);
213 
214  void GenerateLine(vtkIdType offset, vtkIdType numGenPts, vtkIdType inCellId, vtkCellData* cd,
215  vtkCellData* outCD, vtkCellArray* newLines);
216 
217  // helper members
219 
220 private:
221  vtkSplineFilter(const vtkSplineFilter&) = delete;
222  void operator=(const vtkSplineFilter&) = delete;
223 };
224 
225 #endif
object to represent cell connectivity
Definition: vtkCellArray.h:296
represent and manipulate cell attribute data
Definition: vtkCellData.h:151
dynamic, self-adjusting array of float
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate point attribute data
Definition: vtkPointData.h:151
represent and manipulate 3D points
Definition: vtkPoints.h:149
Superclass for algorithms that produce only polydata as output.
generate uniformly subdivided polylines from a set of input polyline using a vtkSpline
void SetGenerateTCoordsToNormalizedLength()
Control whether and how texture coordinates are produced.
void SetGenerateTCoordsToOff()
Control whether and how texture coordinates are produced.
void SetGenerateTCoordsToUseScalars()
Control whether and how texture coordinates are produced.
vtkSpline * XSpline
const char * GetSubdivideAsString()
Specify how the number of subdivisions is determined.
vtkSpline * ZSpline
vtkSpline * Spline
void SetSubdivideToLength()
Specify how the number of subdivisions is determined.
~vtkSplineFilter() override
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)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSpline * YSpline
virtual void SetSpline(vtkSpline *)
Specify an instance of vtkSpline to use to perform the interpolation.
vtkFloatArray * TCoordMap
void SetSubdivideToSpecified()
Specify how the number of subdivisions is determined.
void SetGenerateTCoordsToUseLength()
Control whether and how texture coordinates are produced.
static vtkSplineFilter * New()
Construct the class with no limit on the number of subdivisions and using an instance of vtkCardinalS...
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
const char * GetGenerateTCoordsAsString()
Control whether and how texture coordinates are produced.
spline abstract class for interpolating splines
Definition: vtkSpline.h:82
@ offset
Definition: vtkX3D.h:444
#define VTK_TCOORDS_FROM_SCALARS
#define VTK_TCOORDS_FROM_LENGTH
#define VTK_SUBDIVIDE_LENGTH
#define VTK_TCOORDS_FROM_NORMALIZED_LENGTH
#define VTK_TCOORDS_OFF
#define VTK_SUBDIVIDE_SPECIFIED
int vtkIdType
Definition: vtkType.h:332
#define VTK_DOUBLE_MAX
Definition: vtkType.h:165
#define VTK_INT_MAX
Definition: vtkType.h:155