VTK
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 =========================================================================*/
40 #ifndef vtkSplineFilter_h
41 #define vtkSplineFilter_h
42 
43 #include "vtkFiltersGeneralModule.h" // For export macro
44 #include "vtkPolyDataAlgorithm.h"
45 
46 #define VTK_SUBDIVIDE_SPECIFIED 0
47 #define VTK_SUBDIVIDE_LENGTH 1
48 
49 #define VTK_TCOORDS_OFF 0
50 #define VTK_TCOORDS_FROM_NORMALIZED_LENGTH 1
51 #define VTK_TCOORDS_FROM_LENGTH 2
52 #define VTK_TCOORDS_FROM_SCALARS 3
53 
54 class vtkCellArray;
55 class vtkCellData;
56 class vtkFloatArray;
57 class vtkPointData;
58 class vtkPoints;
59 class vtkSpline;
60 
61 class VTKFILTERSGENERAL_EXPORT vtkSplineFilter : public vtkPolyDataAlgorithm
62 {
63 public:
65  void PrintSelf(ostream& os, vtkIndent indent) override;
66 
71  static vtkSplineFilter *New();
72 
74 
78  vtkSetClampMacro(MaximumNumberOfSubdivisions,int,1,VTK_INT_MAX);
79  vtkGetMacro(MaximumNumberOfSubdivisions,int);
81 
83 
86  vtkSetClampMacro(Subdivide,int,VTK_SUBDIVIDE_SPECIFIED,VTK_SUBDIVIDE_LENGTH);
87  vtkGetMacro(Subdivide,int);
89  {this->SetSubdivide(VTK_SUBDIVIDE_SPECIFIED);}
91  {this->SetSubdivide(VTK_SUBDIVIDE_LENGTH);}
92  const char *GetSubdivideAsString();
94 
96 
101  vtkSetClampMacro(NumberOfSubdivisions,int,1,VTK_INT_MAX);
102  vtkGetMacro(NumberOfSubdivisions,int);
104 
106 
111  vtkSetClampMacro(Length,double,0.0000001,VTK_DOUBLE_MAX);
112  vtkGetMacro(Length,double);
114 
116 
119  virtual void SetSpline(vtkSpline*);
120  vtkGetObjectMacro(Spline,vtkSpline);
122 
124 
131  vtkSetClampMacro(GenerateTCoords,int,VTK_TCOORDS_OFF,
133  vtkGetMacro(GenerateTCoords,int);
135  {this->SetGenerateTCoords(VTK_TCOORDS_OFF);}
137  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_NORMALIZED_LENGTH);}
139  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_LENGTH);}
141  {this->SetGenerateTCoords(VTK_TCOORDS_FROM_SCALARS);}
142  const char *GetGenerateTCoordsAsString();
144 
146 
152  vtkSetClampMacro(TextureLength,double,0.000001,VTK_INT_MAX);
153  vtkGetMacro(TextureLength,double);
155 
156 protected:
157  vtkSplineFilter();
158  ~vtkSplineFilter() override;
159 
160  // Usual data generation method
162 
166  double Length;
172  double TextureLength; //this length is mapped to [0,1) texture space
173 
174  //helper methods
175  int GeneratePoints(vtkIdType offset, vtkIdType npts, vtkIdType *pts,
176  vtkPoints *inPts, vtkPoints *newPts, vtkPointData *pd,
177  vtkPointData *outPD, int genTCoords,
178  vtkFloatArray *newTCoords);
179 
180  void GenerateLine(vtkIdType offset, vtkIdType numGenPts, vtkIdType inCellId,
181  vtkCellData *cd, vtkCellData *outCD, vtkCellArray *newLines);
182 
183  //helper members
185 
186 private:
187  vtkSplineFilter(const vtkSplineFilter&) = delete;
188  void operator=(const vtkSplineFilter&) = delete;
189 };
190 
191 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:39
VTK_SUBDIVIDE_SPECIFIED
#define VTK_SUBDIVIDE_SPECIFIED
Definition: vtkSplineFilter.h:46
VTK_INT_MAX
#define VTK_INT_MAX
Definition: vtkType.h:159
vtkSplineFilter::SetSubdivideToLength
void SetSubdivideToLength()
Definition: vtkSplineFilter.h:90
VTK_TCOORDS_FROM_NORMALIZED_LENGTH
#define VTK_TCOORDS_FROM_NORMALIZED_LENGTH
Definition: vtkSplineFilter.h:50
vtkSplineFilter::Subdivide
int Subdivide
Definition: vtkSplineFilter.h:164
VTK_TCOORDS_FROM_LENGTH
#define VTK_TCOORDS_FROM_LENGTH
Definition: vtkSplineFilter.h:51
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:37
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkFloatArray
dynamic, self-adjusting array of float
Definition: vtkFloatArray.h:41
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkSplineFilter::GenerateTCoords
int GenerateTCoords
Definition: vtkSplineFilter.h:171
vtkSplineFilter::SetGenerateTCoordsToUseLength
void SetGenerateTCoordsToUseLength()
Definition: vtkSplineFilter.h:138
vtkSplineFilter
generate uniformly subdivided polylines from a set of input polyline using a vtkSpline
Definition: vtkSplineFilter.h:61
vtkSplineFilter::NumberOfSubdivisions
int NumberOfSubdivisions
Definition: vtkSplineFilter.h:165
vtkSplineFilter::Spline
vtkSpline * Spline
Definition: vtkSplineFilter.h:167
vtkPolyDataAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSplineFilter::TCoordMap
vtkFloatArray * TCoordMap
Definition: vtkSplineFilter.h:184
VTK_TCOORDS_FROM_SCALARS
#define VTK_TCOORDS_FROM_SCALARS
Definition: vtkSplineFilter.h:52
vtkSplineFilter::MaximumNumberOfSubdivisions
int MaximumNumberOfSubdivisions
Definition: vtkSplineFilter.h:163
vtkPolyDataAlgorithm.h
vtkX3D::offset
Definition: vtkX3D.h:438
vtkPolyDataAlgorithm::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
vtkSplineFilter::SetGenerateTCoordsToUseScalars
void SetGenerateTCoordsToUseScalars()
Definition: vtkSplineFilter.h:140
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:38
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkSplineFilter::ZSpline
vtkSpline * ZSpline
Definition: vtkSplineFilter.h:170
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:50
vtkSpline
spline abstract class for interpolating splines
Definition: vtkSpline.h:62
vtkSplineFilter::TextureLength
double TextureLength
Definition: vtkSplineFilter.h:172
VTK_SUBDIVIDE_LENGTH
#define VTK_SUBDIVIDE_LENGTH
Definition: vtkSplineFilter.h:47
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
VTK_TCOORDS_OFF
#define VTK_TCOORDS_OFF
Definition: vtkSplineFilter.h:49
vtkSplineFilter::Length
double Length
Definition: vtkSplineFilter.h:166
vtkSplineFilter::YSpline
vtkSpline * YSpline
Definition: vtkSplineFilter.h:169
vtkSplineFilter::SetGenerateTCoordsToOff
void SetGenerateTCoordsToOff()
Definition: vtkSplineFilter.h:134
VTK_DOUBLE_MAX
#define VTK_DOUBLE_MAX
Definition: vtkType.h:169
vtkPolyDataAlgorithm::New
static vtkPolyDataAlgorithm * New()
vtkSplineFilter::XSpline
vtkSpline * XSpline
Definition: vtkSplineFilter.h:168
vtkSplineFilter::SetGenerateTCoordsToNormalizedLength
void SetGenerateTCoordsToNormalizedLength()
Definition: vtkSplineFilter.h:136
vtkPolyDataAlgorithm
Superclass for algorithms that produce only polydata as output.
Definition: vtkPolyDataAlgorithm.h:44
vtkSplineFilter::SetSubdivideToSpecified
void SetSubdivideToSpecified()
Definition: vtkSplineFilter.h:88