forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkParametricConicSpiral.h
142 lines (119 loc) · 4.16 KB
/
vtkParametricConicSpiral.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*=========================================================================
Program: Visualization Toolkit
Module: vtkParametricConicSpiral.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkParametricConicSpiral
* @brief Generate conic spiral surfaces that resemble sea-shells.
*
* vtkParametricConicSpiral generates conic spiral surfaces. These can resemble sea shells, or
* may look like a torus "eating" its own tail.
*
* For further information about this surface, please consult the
* technical description "Parametric surfaces" in http://www.vtk.org/publications
* in the "VTK Technical Documents" section in the VTk.org web pages.
*
* @par Thanks:
* Andrew Maclean andrew.amaclean@gmail.com for creating and contributing the
* class.
*
*/
#ifndef vtkParametricConicSpiral_h
#define vtkParametricConicSpiral_h
#include "vtkCommonComputationalGeometryModule.h" // For export macro
#include "vtkParametricFunction.h"
class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT vtkParametricConicSpiral :
public vtkParametricFunction
{
public:
vtkTypeMacro(vtkParametricConicSpiral, vtkParametricFunction);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Construct a conic spiral surface with the following parameters:
* MinimumU = 0, MaximumU = 2Pi,
* MinimumV = 0, MaximumV = 2Pi,
* JoinU = 0, JoinV = 0,
* TwistU = 0, TwistV = 0,
* ClockwiseOrdering = 0,
* DerivativesAvailable = 1,
* A = 0.2, B = 1.0, C = 0.1, N = 2.
*/
static vtkParametricConicSpiral *New();
/**
* Return the parametric dimension of the class.
*/
int GetDimension() override {return 2;}
//@{
/**
* Set/Get the scale factor.
* Default = 0.2
*/
vtkSetMacro(A, double);
vtkGetMacro(A, double);
//@}
//@{
/**
* Set/Get the A function coefficient.
* See the definition in Parametric surfaces referred to above.
* Default is 1.
*/
vtkSetMacro(B, double);
vtkGetMacro(B, double);
//@}
//@{
/**
* Set/Get the B function coefficient.
* See the definition in Parametric surfaces referred to above.
* Default is 0.1.
*/
vtkSetMacro(C, double);
vtkGetMacro(C, double);
//@}
//@{
/**
* Set/Get the C function coefficient.
* See the definition in Parametric surfaces referred to above.
* Default is 2.
*/
vtkSetMacro(N, double);
vtkGetMacro(N, double);
//@}
/**
* A conic spiral surface.
* This function performs the mapping \f$f(u,v) \rightarrow (x,y,x)\f$, returning it
* as Pt. It also returns the partial derivatives Du and Dv.
* \f$Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv)\f$ .
* Then the normal is \f$N = Du X Dv\f$ .
*/
void Evaluate(double uvw[3], double Pt[3], double Duvw[9]) override;
/**
* Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
* uvw are the parameters with Pt being the the cartesian point,
* Duvw are the derivatives of this point with respect to u, v and w.
* Pt, Duvw are obtained from Evaluate().
* This function is only called if the ScalarMode has the value
* vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED
* If the user does not need to calculate a scalar, then the
* instantiated function should return zero.
*/
double EvaluateScalar(double uvw[3], double Pt[3],
double Duvw[9]) override;
protected:
vtkParametricConicSpiral();
~vtkParametricConicSpiral() override;
// Variables
double A;
double B;
double C;
double N;
private:
vtkParametricConicSpiral(const vtkParametricConicSpiral&) = delete;
void operator=(const vtkParametricConicSpiral&) = delete;
};
#endif