VTK
vtkParametricSuperToroid.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkParametricSuperToroid.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 =========================================================================*/
44 #ifndef vtkParametricSuperToroid_h
45 #define vtkParametricSuperToroid_h
46 
47 #include "vtkCommonComputationalGeometryModule.h" // For export macro
48 #include "vtkParametricFunction.h"
49 
50 class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT vtkParametricSuperToroid : public vtkParametricFunction
51 {
52 public:
54  void PrintSelf(ostream& os, vtkIndent indent) override;
55 
68  static vtkParametricSuperToroid* New();
69 
73  int GetDimension() override { return 2; }
74 
76 
80  vtkSetMacro(RingRadius, double);
81  vtkGetMacro(RingRadius, double);
83 
85 
89  vtkSetMacro(CrossSectionRadius, double);
90  vtkGetMacro(CrossSectionRadius, double);
92 
94 
97  vtkSetMacro(XRadius, double);
98  vtkGetMacro(XRadius, double);
100 
102 
105  vtkSetMacro(YRadius, double);
106  vtkGetMacro(YRadius, double);
108 
110 
113  vtkSetMacro(ZRadius, double);
114  vtkGetMacro(ZRadius, double);
116 
118 
121  vtkSetMacro(N1, double);
122  vtkGetMacro(N1, double);
124 
126 
129  vtkSetMacro(N2, double);
130  vtkGetMacro(N2, double);
132 
141  void Evaluate(double uvw[3], double Pt[3], double Duvw[9]) override;
142 
156  double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) override;
157 
158 protected:
160  ~vtkParametricSuperToroid() override;
161 
162  // Variables
163  double RingRadius;
165  double XRadius;
166  double YRadius;
167  double ZRadius;
168  double N1;
169  double N2;
170 
171 private:
173  void operator=(const vtkParametricSuperToroid&) = delete;
174 };
175 
176 #endif
vtkParametricSuperToroid::N2
double N2
Definition: vtkParametricSuperToroid.h:169
vtkParametricFunction::Evaluate
virtual void Evaluate(double uvw[3], double Pt[3], double Duvw[9])=0
Performs the mapping $f(uvw)->(Pt,Duvw)$f.
vtkParametricFunction::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkParametricSuperToroid::ZRadius
double ZRadius
Definition: vtkParametricSuperToroid.h:167
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkParametricFunction
abstract interface for parametric functions
Definition: vtkParametricFunction.h:62
vtkParametricSuperToroid::GetDimension
int GetDimension() override
Return the parametric dimension of the class.
Definition: vtkParametricSuperToroid.h:73
vtkParametricSuperToroid
Generate a supertoroid.
Definition: vtkParametricSuperToroid.h:50
vtkParametricSuperToroid::YRadius
double YRadius
Definition: vtkParametricSuperToroid.h:166
vtkParametricSuperToroid::RingRadius
double RingRadius
Definition: vtkParametricSuperToroid.h:163
vtkParametricSuperToroid::XRadius
double XRadius
Definition: vtkParametricSuperToroid.h:165
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkParametricFunction.h
vtkParametricFunction::EvaluateScalar
virtual double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9])=0
Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
vtkParametricSuperToroid::N1
double N1
Definition: vtkParametricSuperToroid.h:168
vtkParametricSuperToroid::CrossSectionRadius
double CrossSectionRadius
Definition: vtkParametricSuperToroid.h:164