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
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkParametricSuperEllipsoid
* @brief Generate a superellipsoid.
*
* vtkParametricSuperEllipsoid generates a superellipsoid. A superellipsoid
* is a versatile primitive that is controlled by two parameters n1 and
* n2. As special cases it can represent a sphere, square box, and closed
* cylindrical can.
*
* 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.
*
* Also see: http://paulbourke.net/geometry/superellipse/
*
* @warning
* Care needs to be taken specifying the bounds correctly. You may need to
* carefully adjust MinimumU, MinimumV, MaximumU, MaximumV.
*
* @par Thanks:
* Andrew Maclean andrew.amaclean@gmail.com for creating and contributing the
* class.
*
*/
#ifndef vtkParametricSuperEllipsoid_h
#define vtkParametricSuperEllipsoid_h
#include "vtkCommonComputationalGeometryModule.h" // For export macro
#include "vtkParametricFunction.h"
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT vtkParametricSuperEllipsoid
: public vtkParametricFunction
{
public:
vtkTypeMacro(vtkParametricSuperEllipsoid, vtkParametricFunction);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Construct a superellipsoid with the following parameters:
* MinimumU = -Pi, MaximumU = Pi,
* MinimumV = -Pi/2, MaximumV = Pi/2,
* JoinU = 0, JoinV = 0,
* TwistU = 0, TwistV = 0,
* ClockwiseOrdering = 0,
* DerivativesAvailable = 0,
* N1 = 1, N2 = 1, XRadius = 1, YRadius = 1,
* ZRadius = 1, a sphere in this case.
*/
static vtkParametricSuperEllipsoid* New();
/**
* Return the parametric dimension of the class.
*/
int GetDimension() override { return 2; }
///@{
/**
* Set/Get the scaling factor for the x-axis. Default is 1.
*/
vtkSetMacro(XRadius, double);
vtkGetMacro(XRadius, double);
///@}
///@{
/**
* Set/Get the scaling factor for the y-axis. Default is 1.
*/
vtkSetMacro(YRadius, double);
vtkGetMacro(YRadius, double);
///@}
///@{
/**
* Set/Get the scaling factor for the z-axis. Default is 1.
*/
vtkSetMacro(ZRadius, double);
vtkGetMacro(ZRadius, double);
///@}
///@{
/**
* Set/Get the "squareness" parameter in the z axis. Default is 1.
*/
vtkSetMacro(N1, double);
vtkGetMacro(N1, double);
///@}
///@{
/**
* Set/Get the "squareness" parameter in the x-y plane. Default is 1.
*/
vtkSetMacro(N2, double);
vtkGetMacro(N2, double);
///@}
/**
* A superellipsoid.
* 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 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:
vtkParametricSuperEllipsoid();
~vtkParametricSuperEllipsoid() override;
// Variables
double XRadius;
double YRadius;
double ZRadius;
double N1;
double N2;
private:
vtkParametricSuperEllipsoid(const vtkParametricSuperEllipsoid&) = delete;
void operator=(const vtkParametricSuperEllipsoid&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
