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.vtkParametricSuperToroid Class Reference

vtkParametricSuperToroid - Generate a supertoroid. More...

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

List of all members.

Public Member Functions

 vtkParametricSuperToroid (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkParametricSuperToroid ()
 Construct a supertoroid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = 2*Pi, JoinU = 1, JoinV = 1, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, RingRadius = 1, CrossSectionRadius = 0.5, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a torus in this case.
override void Evaluate (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 A supertoroid.
override double EvaluateScalar (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
virtual double GetCrossSectionRadius ()
 Set/Get the radius of the cross section of ring of the supertoroid. Default = 0.5.
override int GetDimension ()
 Description Return the parametric dimension of the class.
virtual double GetN1 ()
 Set/Get the shape of the torus ring. Default = 1.
virtual double GetN2 ()
 Set/Get the shape of the cross section of the ring. Default = 1.
virtual double GetRingRadius ()
 Set/Get the radius from the center to the middle of the ring of the supertoroid. 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 vtkParametricSuperToroid NewInstance ()
 Undocumented Block.
virtual void SetCrossSectionRadius (double _arg)
 Set/Get the radius of the cross section of ring of the supertoroid. Default = 0.5.
virtual void SetN1 (double _arg)
 Set/Get the shape of the torus ring. Default = 1.
virtual void SetN2 (double _arg)
 Set/Get the shape of the cross section of the ring. Default = 1.
virtual void SetRingRadius (double _arg)
 Set/Get the radius from the center to the middle of the ring of the supertoroid. 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 vtkParametricSuperToroid New ()
 Construct a supertoroid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = 2*Pi, JoinU = 1, JoinV = 1, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, RingRadius = 1, CrossSectionRadius = 0.5, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a torus in this case.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkParametricSuperToroid SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkParametricSuperToroid"
 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 vtkParametricSuperToroid_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricSuperToroid_Evaluate_01 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal double vtkParametricSuperToroid_EvaluateScalar_02 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal double vtkParametricSuperToroid_GetCrossSectionRadius_03 (HandleRef pThis)
static internal int vtkParametricSuperToroid_GetDimension_04 (HandleRef pThis)
static internal double vtkParametricSuperToroid_GetN1_05 (HandleRef pThis)
static internal double vtkParametricSuperToroid_GetN2_06 (HandleRef pThis)
static internal double vtkParametricSuperToroid_GetRingRadius_07 (HandleRef pThis)
static internal double vtkParametricSuperToroid_GetXRadius_08 (HandleRef pThis)
static internal double vtkParametricSuperToroid_GetYRadius_09 (HandleRef pThis)
static internal double vtkParametricSuperToroid_GetZRadius_10 (HandleRef pThis)
static internal int vtkParametricSuperToroid_IsA_11 (HandleRef pThis, string type)
static internal int vtkParametricSuperToroid_IsTypeOf_12 (string type)
static internal IntPtr vtkParametricSuperToroid_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkParametricSuperToroid_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricSuperToroid_SetCrossSectionRadius_16 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperToroid_SetN1_17 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperToroid_SetN2_18 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperToroid_SetRingRadius_19 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperToroid_SetXRadius_20 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperToroid_SetYRadius_21 (HandleRef pThis, double _arg)
static internal void vtkParametricSuperToroid_SetZRadius_22 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkParametricSuperToroid ()
 Automatically generated type registration mechanics.

Detailed Description

vtkParametricSuperToroid - Generate a supertoroid.

Description vtkParametricSuperToroid generates a supertoroid. Essentially a supertoroid is a torus with the sine and cosine terms raised to a power. A supertoroid is a versatile primitive that is controlled by four parameters r0, r1, n1 and n2. r0, r1 determine the type of torus whilst the value of n1 determines the shape of the torus ring and n2 determines the shape of the cross section of the ring. It is the different values of these powers which give rise to a family of 3D shapes that are all basically toroidal in shape.

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.vtkParametricSuperToroid.vtkParametricSuperToroid ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

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

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


Member Function Documentation

override void Kitware.VTK.vtkParametricSuperToroid.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.vtkParametricSuperToroid.Evaluate ( IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [virtual]

A supertoroid.

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.vtkParametricSuperToroid.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.

Set/Get the radius of the cross section of ring of the supertoroid. Default = 0.5.

Description Return the parametric dimension of the class.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Set/Get the shape of the torus ring. Default = 1.

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

Set/Get the shape of the cross section of the ring. Default = 1.

Set/Get the radius from the center to the middle of the ring of the supertoroid. 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.vtkParametricSuperToroid.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Construct a supertoroid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = 2*Pi, JoinU = 1, JoinV = 1, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, RingRadius = 1, CrossSectionRadius = 0.5, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a torus 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.vtkParametricSuperToroid.SetCrossSectionRadius ( double  _arg) [virtual]

Set/Get the radius of the cross section of ring of the supertoroid. Default = 0.5.

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

Set/Get the shape of the torus ring. Default = 1.

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

Set/Get the shape of the cross section of the ring. Default = 1.

virtual void Kitware.VTK.vtkParametricSuperToroid.SetRingRadius ( double  _arg) [virtual]

Set/Get the radius from the center to the middle of the ring of the supertoroid. Default = 1.

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

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

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

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

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

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

static internal void Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_Evaluate_01 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal double Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_EvaluateScalar_02 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal int Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_GetDimension_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_GetN1_05 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_GetN2_06 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_GetRingRadius_07 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_GetXRadius_08 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_GetYRadius_09 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_GetZRadius_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_IsA_11 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_IsTypeOf_12 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_NewInstance_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_SafeDownCast_15 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_SetCrossSectionRadius_16 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_SetN1_17 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_SetN2_18 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_SetRingRadius_19 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_SetXRadius_20 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_SetYRadius_21 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricSuperToroid.vtkParametricSuperToroid_SetZRadius_22 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkParametricSuperToroid.MRClassNameKey = "24vtkParametricSuperToroid" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.


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