VTK  9.1.0
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 =========================================================================*/
37 #ifndef vtkSplineFilter_h
38 #define vtkSplineFilter_h
39 
40 #include "vtkFiltersGeneralModule.h" // For export macro
41 #include "vtkPolyDataAlgorithm.h"
42 
43 #define VTK_SUBDIVIDE_SPECIFIED 0
44 #define VTK_SUBDIVIDE_LENGTH 1
45 
46 #define VTK_TCOORDS_OFF 0
47 #define VTK_TCOORDS_FROM_NORMALIZED_LENGTH 1
48 #define VTK_TCOORDS_FROM_LENGTH 2
49 #define VTK_TCOORDS_FROM_SCALARS 3
50 
51 class vtkCellArray;
52 class vtkCellData;
53 class vtkFloatArray;
54 class vtkPointData;
55 class vtkPoints;
56 class vtkSpline;
57 
58 class VTKFILTERSGENERAL_EXPORT vtkSplineFilter : public vtkPolyDataAlgorithm
59 {
60 public:
62  void PrintSelf(ostream& os, vtkIndent indent) override;
63 
68  static vtkSplineFilter* New();
69 
71 
75  vtkSetClampMacro(MaximumNumberOfSubdivisions, int, 1, VTK_INT_MAX);
76  vtkGetMacro(MaximumNumberOfSubdivisions, int);
78 
80 
83  vtkSetClampMacro(Subdivide, int, VTK_SUBDIVIDE_SPECIFIED, VTK_SUBDIVIDE_LENGTH);
84  vtkGetMacro(Subdivide, int);
85  void SetSubdivideToSpecified() { this->SetSubdivide(VTK_SUBDIVIDE_SPECIFIED); }
86  void SetSubdivideToLength() { this->SetSubdivide(VTK_SUBDIVIDE_LENGTH); }
87  const char* GetSubdivideAsString();
89 
91 
96  vtkSetClampMacro(NumberOfSubdivisions, int, 1, VTK_INT_MAX);
97  vtkGetMacro(NumberOfSubdivisions, int);
99 
101 
106  vtkSetClampMacro(Length, double, 0.0000001, VTK_DOUBLE_MAX);
107  vtkGetMacro(Length, double);
109 
111 
114  virtual void SetSpline(vtkSpline*);
115  vtkGetObjectMacro(Spline, vtkSpline);
117 
119 
126  vtkSetClampMacro(GenerateTCoords, int, VTK_TCOORDS_OFF, VTK_TCOORDS_FROM_SCALARS);
127  vtkGetMacro(GenerateTCoords, int);
128  void SetGenerateTCoordsToOff() { this->SetGenerateTCoords(VTK_TCOORDS_OFF); }
130  {
131  this->SetGenerateTCoords(VTK_TCOORDS_FROM_NORMALIZED_LENGTH);
132  }
133  void SetGenerateTCoordsToUseLength() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_LENGTH); }
134  void SetGenerateTCoordsToUseScalars() { this->SetGenerateTCoords(VTK_TCOORDS_FROM_SCALARS); }
137 
139 
145  vtkSetClampMacro(TextureLength, double, 0.000001, VTK_INT_MAX);
146  vtkGetMacro(TextureLength, double);
148 
149 protected:
151  ~vtkSplineFilter() override;
152 
153  // Usual data generation method
155 
159  double Length;
165  double TextureLength; // this length is mapped to [0,1) texture space
166 
167  // helper methods
169  vtkPoints* newPts, vtkPointData* pd, vtkPointData* outPD, int genTCoords,
170  vtkFloatArray* newTCoords);
171 
172  void GenerateLine(vtkIdType offset, vtkIdType numGenPts, vtkIdType inCellId, vtkCellData* cd,
173  vtkCellData* outCD, vtkCellArray* newLines);
174 
175  // helper members
177 
178 private:
179  vtkSplineFilter(const vtkSplineFilter&) = delete;
180  void operator=(const vtkSplineFilter&) = delete;
181 };
182 
183 #endif
object to represent cell connectivity
Definition: vtkCellArray.h:181
represent and manipulate cell attribute data
Definition: vtkCellData.h:33
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:36
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate point attribute data
Definition: vtkPointData.h:33
represent and manipulate 3D points
Definition: vtkPoints.h:34
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:63
@ 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