ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkParametricSuperEllipsoid Class Reference

vtkParametricSuperEllipsoid - Generate a superellipsoid. More...

Inheritance diagram for Kitware.VTK.vtkParametricSuperEllipsoid:
[legend]
Collaboration diagram for Kitware.VTK.vtkParametricSuperEllipsoid:
[legend]

List of all members.

Public Member Functions

 vtkParametricSuperEllipsoid (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkParametricSuperEllipsoid ()
 Construct a superellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case.
override void Evaluate (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 A superellipsoid.
override double EvaluateScalar (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
override int GetDimension ()
 Description Return the parametric dimension of the class.
virtual double GetN1 ()
 Set/Get the "squareness" parameter in the z axis. Default = 1.
virtual double GetN2 ()
 Set/Get the "squareness" parameter in the x-y plane. Default = 1.
virtual double GetXRadius ()
 Set/Get the scaling factor for the x-axis. Default = 1.
virtual double GetYRadius ()
 Set/Get the scaling factor for the y-axis. Default = 1.
virtual double GetZRadius ()
 Set/Get the scaling factor for the z-axis. Default = 1.
override int IsA (string type)
 Undocumented Block.
new vtkParametricSuperEllipsoid NewInstance ()
 Undocumented Block.
virtual void SetN1 (double _arg)
 Set/Get the "squareness" parameter in the z axis. Default = 1.
virtual void SetN2 (double _arg)
 Set/Get the "squareness" parameter in the x-y plane. Default = 1.
virtual void SetXRadius (double _arg)
 Set/Get the scaling factor for the x-axis. Default = 1.
virtual void SetYRadius (double _arg)
 Set/Get the scaling factor for the y-axis. Default = 1.
virtual void SetZRadius (double _arg)
 Set/Get the scaling factor for the z-axis. Default = 1.

Static Public Member Functions

static new
vtkParametricSuperEllipsoid 
New ()
 Construct a superellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkParametricSuperEllipsoid 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkParametricSuperEllipsoid"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "27vtkParametricSuperEllipsoid"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkParametricSuperEllipsoid_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricSuperEllipsoid_Evaluate_01 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal double vtkParametricSuperEllipsoid_EvaluateScalar_02 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal int vtkParametricSuperEllipsoid_GetDimension_03 (HandleRef pThis)
static internal double vtkParametricSuperEllipsoid_GetN1_04 (HandleRef pThis)
static internal double vtkParametricSuperEllipsoid_GetN2_05 (HandleRef pThis)
static internal double vtkParametricSuperEllipsoid_GetXRadius_06 (HandleRef pThis)
static internal double vtkParametricSuperEllipsoid_GetYRadius_07 (HandleRef pThis)
static internal double vtkParametricSuperEllipsoid_GetZRadius_08 (HandleRef pThis)
static internal int vtkParametricSuperEllipsoid_IsA_09 (HandleRef pThis, string type)
static internal int vtkParametricSuperEllipsoid_IsTypeOf_10 (string type)
static internal IntPtr vtkParametricSuperEllipsoid_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkParametricSuperEllipsoid_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricSuperEllipsoid_SetN1_14 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperEllipsoid_SetN2_15 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperEllipsoid_SetXRadius_16 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperEllipsoid_SetYRadius_17 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperEllipsoid_SetZRadius_18 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkParametricSuperEllipsoid ()
 Automatically generated type registration mechanics.

Detailed Description

vtkParametricSuperEllipsoid - Generate a superellipsoid.

Description 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/documents.php in the "VTK Technical Documents" section in the VTk.org web pages.

Also see: http://astronomy.swin.edu.au/~pbourke/surfaces/

Caveats Care needs to be taken specifying the bounds correctly. You may need to carefully adjust MinimumU, MinimumV, MaximumU, MaximumV.

Thanks Andrew Maclean a.maclean@cas.edu.au for creating and contributing the class.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Construct a superellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case.


Member Function Documentation

override void Kitware.VTK.vtkParametricSuperEllipsoid.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkParametricFunction.

override void Kitware.VTK.vtkParametricSuperEllipsoid.Evaluate ( IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [virtual]

A superellipsoid.

This function performs the mapping $f(u,v) \rightarrow (x,y,x)$, returning it as Pt. It also returns the partial derivatives Du and Dv. $Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv)$ . Then the normal is $N = Du X Dv$ .

Reimplemented from Kitware.VTK.vtkParametricFunction.

override double Kitware.VTK.vtkParametricSuperEllipsoid.EvaluateScalar ( IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [virtual]

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.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Description Return the parametric dimension of the class.

Reimplemented from Kitware.VTK.vtkParametricFunction.

virtual double Kitware.VTK.vtkParametricSuperEllipsoid.GetN1 ( ) [virtual]

Set/Get the "squareness" parameter in the z axis. Default = 1.

virtual double Kitware.VTK.vtkParametricSuperEllipsoid.GetN2 ( ) [virtual]

Set/Get the "squareness" parameter in the x-y plane. Default = 1.

Set/Get the scaling factor for the x-axis. Default = 1.

Set/Get the scaling factor for the y-axis. Default = 1.

Set/Get the scaling factor for the z-axis. Default = 1.

override int Kitware.VTK.vtkParametricSuperEllipsoid.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

static new int Kitware.VTK.vtkParametricSuperEllipsoid.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Construct a superellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkParametricSuperEllipsoid.SetN1 ( double  _arg) [virtual]

Set/Get the "squareness" parameter in the z axis. Default = 1.

virtual void Kitware.VTK.vtkParametricSuperEllipsoid.SetN2 ( double  _arg) [virtual]

Set/Get the "squareness" parameter in the x-y plane. Default = 1.

virtual void Kitware.VTK.vtkParametricSuperEllipsoid.SetXRadius ( double  _arg) [virtual]

Set/Get the scaling factor for the x-axis. Default = 1.

virtual void Kitware.VTK.vtkParametricSuperEllipsoid.SetYRadius ( double  _arg) [virtual]

Set/Get the scaling factor for the y-axis. Default = 1.

virtual void Kitware.VTK.vtkParametricSuperEllipsoid.SetZRadius ( double  _arg) [virtual]

Set/Get the scaling factor for the z-axis. Default = 1.

static internal void Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_Evaluate_01 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal double Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_EvaluateScalar_02 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal double Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_GetN1_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_GetN2_05 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_GetXRadius_06 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_GetYRadius_07 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_GetZRadius_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_SetN1_14 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_SetN2_15 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_SetXRadius_16 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_SetYRadius_17 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperEllipsoid.vtkParametricSuperEllipsoid_SetZRadius_18 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkParametricSuperEllipsoid.MRClassNameKey = "27vtkParametricSuperEllipsoid" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.

new const string Kitware.VTK.vtkParametricSuperEllipsoid.MRFullTypeName = "Kitware.VTK.vtkParametricSuperEllipsoid"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.


The documentation for this class was generated from the following file: