VTK  9.2.5
vtkParametricSpline.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkParametricSpline.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=========================================================================*/
41#ifndef vtkParametricSpline_h
42#define vtkParametricSpline_h
43
44class vtkSpline;
45class vtkPoints;
46
47#include "vtkCommonComputationalGeometryModule.h" // For export macro
49
50class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT vtkParametricSpline : public vtkParametricFunction
51{
52public:
54 void PrintSelf(ostream& os, vtkIndent indent) override;
55
63
67 int GetDimension() override { return 1; }
68
73 void Evaluate(double u[3], double Pt[3], double Du[9]) override;
74
79 double EvaluateScalar(double u[3], double Pt[3], double Du[9]) override;
80
82
90 vtkGetObjectMacro(XSpline, vtkSpline);
91 vtkGetObjectMacro(YSpline, vtkSpline);
92 vtkGetObjectMacro(ZSpline, vtkSpline);
94
96
103 vtkGetObjectMacro(Points, vtkPoints);
105
107
112 void SetPoint(vtkIdType index, double x, double y, double z);
114
116
121 vtkSetMacro(Closed, vtkTypeBool);
122 vtkGetMacro(Closed, vtkTypeBool);
123 vtkBooleanMacro(Closed, vtkTypeBool);
125
127
131 vtkSetMacro(ParameterizeByLength, vtkTypeBool);
132 vtkGetMacro(ParameterizeByLength, vtkTypeBool);
133 vtkBooleanMacro(ParameterizeByLength, vtkTypeBool);
135
137
153 vtkSetClampMacro(LeftConstraint, int, 0, 3);
154 vtkGetMacro(LeftConstraint, int);
155 vtkSetClampMacro(RightConstraint, int, 0, 3);
156 vtkGetMacro(RightConstraint, int);
158
160
164 vtkSetMacro(LeftValue, double);
165 vtkGetMacro(LeftValue, double);
166 vtkSetMacro(RightValue, double);
167 vtkGetMacro(RightValue, double);
169
170protected:
173
174 // Points definition
176
177 // The interpolating splines for each of the x-y-z coordinates
181
182 // Supplemental variables
186 double LeftValue;
189
190 // Initializing the spline
193
194 // Internal variable for managing parametric coordinates
195 double Length;
197
198private:
200 void operator=(const vtkParametricSpline&) = delete;
201};
202
203#endif
a simple class to control print indentation
Definition: vtkIndent.h:40
abstract interface for parametric functions
parametric function for 1D interpolating splines
vtkTypeBool ParameterizeByLength
~vtkParametricSpline() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetNumberOfPoints(vtkIdType numPts)
Another API to set the points.
void SetPoint(vtkIdType index, double x, double y, double z)
Another API to set the points.
double EvaluateScalar(double u[3], double Pt[3], double Du[9]) override
Evaluate a scalar value at parametric coordinate u[0] and Pt[3].
void SetXSpline(vtkSpline *)
By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-...
int GetDimension() override
Return the parametric dimension of the class.
void Evaluate(double u[3], double Pt[3], double Du[9]) override
Evaluate the spline at parametric coordinate u[0] returning the point coordinate Pt[3].
void SetPoints(vtkPoints *)
Specify the list of points defining the spline.
void SetYSpline(vtkSpline *)
By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-...
static vtkParametricSpline * New()
Construct the spline with the following parameters: MinimumU = 0, MaximumU = 1, JoinU = 0 (unless the...
void SetZSpline(vtkSpline *)
By default, this class is constructed with three instances of vtkCardinalSpline (for each of the x-y-...
represent and manipulate 3D points
Definition: vtkPoints.h:40
spline abstract class for interpolating splines
Definition: vtkSpline.h:63
int vtkTypeBool
Definition: vtkABI.h:69
int vtkIdType
Definition: vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287