You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
153 lines
4.4 KiB
C++
153 lines
4.4 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkParametricSuperEllipsoid.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 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"
|
|
|
|
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;
|
|
};
|
|
|
|
#endif
|