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

vtkParametricConicSpiral - Generate conic spiral surfaces that resemble sea-shells. More...

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

List of all members.

Public Member Functions

 vtkParametricConicSpiral (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkParametricConicSpiral ()
 Construct a conic spiral surface with the following parameters: MinimumU = 0, MaximumU = 2Pi, MinimumV = 0, MaximumV = 2Pi, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, A = 0.2, B = 1.0, C = 0.1, N = 2.
override void Evaluate (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 A conic spiral surface.
override double EvaluateScalar (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
virtual double GetA ()
 Set/Get the scale factor. Default = 0.2.
virtual double GetB ()
 Set/Get the A function coefficient (see equation below). Default = 1.
virtual double GetC ()
 Set/Get the B function coefficient (see equation below). Default = 0.1.
override int GetDimension ()
 Description Return the parametric dimension of the class.
virtual double GetN ()
 Set/Get the C function coefficient (see equation below). Default = 2.
override int IsA (string type)
 Undocumented Block.
new vtkParametricConicSpiral NewInstance ()
 Undocumented Block.
virtual void SetA (double _arg)
 Set/Get the scale factor. Default = 0.2.
virtual void SetB (double _arg)
 Set/Get the A function coefficient (see equation below). Default = 1.
virtual void SetC (double _arg)
 Set/Get the B function coefficient (see equation below). Default = 0.1.
virtual void SetN (double _arg)
 Set/Get the C function coefficient (see equation below). Default = 2.

Static Public Member Functions

static new vtkParametricConicSpiral New ()
 Construct a conic spiral surface with the following parameters: MinimumU = 0, MaximumU = 2Pi, MinimumV = 0, MaximumV = 2Pi, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, A = 0.2, B = 1.0, C = 0.1, N = 2.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkParametricConicSpiral SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkParametricConicSpiral"
 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 vtkParametricConicSpiral_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricConicSpiral_Evaluate_01 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal double vtkParametricConicSpiral_EvaluateScalar_02 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal double vtkParametricConicSpiral_GetA_03 (HandleRef pThis)
static internal double vtkParametricConicSpiral_GetB_04 (HandleRef pThis)
static internal double vtkParametricConicSpiral_GetC_05 (HandleRef pThis)
static internal int vtkParametricConicSpiral_GetDimension_06 (HandleRef pThis)
static internal double vtkParametricConicSpiral_GetN_07 (HandleRef pThis)
static internal int vtkParametricConicSpiral_IsA_08 (HandleRef pThis, string type)
static internal int vtkParametricConicSpiral_IsTypeOf_09 (string type)
static internal IntPtr vtkParametricConicSpiral_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkParametricConicSpiral_SafeDownCast_12 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricConicSpiral_SetA_13 (HandleRef pThis, double _arg)
static internal void vtkParametricConicSpiral_SetB_14 (HandleRef pThis, double _arg)
static internal void vtkParametricConicSpiral_SetC_15 (HandleRef pThis, double _arg)
static internal void vtkParametricConicSpiral_SetN_16 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkParametricConicSpiral ()
 Automatically generated type registration mechanics.

Detailed Description

vtkParametricConicSpiral - Generate conic spiral surfaces that resemble sea-shells.

Description vtkParametricConicSpiral generates conic spiral surfaces. These can resemble sea shells, or may look like a torus "eating" its own tail.

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.

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


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Construct a conic spiral surface with the following parameters: MinimumU = 0, MaximumU = 2Pi, MinimumV = 0, MaximumV = 2Pi, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, A = 0.2, B = 1.0, C = 0.1, N = 2.


Member Function Documentation

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

A conic spiral surface.

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

virtual double Kitware.VTK.vtkParametricConicSpiral.GetA ( ) [virtual]

Set/Get the scale factor. Default = 0.2.

virtual double Kitware.VTK.vtkParametricConicSpiral.GetB ( ) [virtual]

Set/Get the A function coefficient (see equation below). Default = 1.

virtual double Kitware.VTK.vtkParametricConicSpiral.GetC ( ) [virtual]

Set/Get the B function coefficient (see equation below). Default = 0.1.

Description Return the parametric dimension of the class.

Reimplemented from Kitware.VTK.vtkParametricFunction.

virtual double Kitware.VTK.vtkParametricConicSpiral.GetN ( ) [virtual]

Set/Get the C function coefficient (see equation below). Default = 2.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Construct a conic spiral surface with the following parameters: MinimumU = 0, MaximumU = 2Pi, MinimumV = 0, MaximumV = 2Pi, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, A = 0.2, B = 1.0, C = 0.1, N = 2.

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.vtkParametricConicSpiral.SetA ( double  _arg) [virtual]

Set/Get the scale factor. Default = 0.2.

virtual void Kitware.VTK.vtkParametricConicSpiral.SetB ( double  _arg) [virtual]

Set/Get the A function coefficient (see equation below). Default = 1.

virtual void Kitware.VTK.vtkParametricConicSpiral.SetC ( double  _arg) [virtual]

Set/Get the B function coefficient (see equation below). Default = 0.1.

virtual void Kitware.VTK.vtkParametricConicSpiral.SetN ( double  _arg) [virtual]

Set/Get the C function coefficient (see equation below). Default = 2.

static internal void Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_Evaluate_01 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal double Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_EvaluateScalar_02 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal double Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_GetA_03 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_GetB_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_GetC_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_GetDimension_06 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_GetN_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_IsA_08 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_IsTypeOf_09 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_NewInstance_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_SafeDownCast_12 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_SetA_13 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_SetB_14 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_SetC_15 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricConicSpiral.vtkParametricConicSpiral_SetN_16 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.


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