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

vtkParametricEllipsoid - Generate an ellipsoid. More...

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

List of all members.

Public Member Functions

 vtkParametricEllipsoid (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkParametricEllipsoid ()
 Construct an ellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case.
override void Evaluate (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 An ellipsoid.
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 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 vtkParametricEllipsoid NewInstance ()
 Undocumented Block.
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 vtkParametricEllipsoid New ()
 Construct an ellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkParametricEllipsoid SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "22vtkParametricEllipsoid"
 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 vtkParametricEllipsoid_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricEllipsoid_Evaluate_01 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal double vtkParametricEllipsoid_EvaluateScalar_02 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal int vtkParametricEllipsoid_GetDimension_03 (HandleRef pThis)
static internal double vtkParametricEllipsoid_GetXRadius_04 (HandleRef pThis)
static internal double vtkParametricEllipsoid_GetYRadius_05 (HandleRef pThis)
static internal double vtkParametricEllipsoid_GetZRadius_06 (HandleRef pThis)
static internal int vtkParametricEllipsoid_IsA_07 (HandleRef pThis, string type)
static internal int vtkParametricEllipsoid_IsTypeOf_08 (string type)
static internal IntPtr vtkParametricEllipsoid_NewInstance_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkParametricEllipsoid_SafeDownCast_11 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricEllipsoid_SetXRadius_12 (HandleRef pThis, double _arg)
static internal void vtkParametricEllipsoid_SetYRadius_13 (HandleRef pThis, double _arg)
static internal void vtkParametricEllipsoid_SetZRadius_14 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkParametricEllipsoid ()
 Automatically generated type registration mechanics.

Detailed Description

vtkParametricEllipsoid - Generate an ellipsoid.

Description vtkParametricEllipsoid generates an ellipsoid. If all the radii are the same, we have a sphere. An oblate spheroid occurs if RadiusX = RadiusY > RadiusZ. Here the Z-axis forms the symmetry axis. To a first approximation, this is the shape of the earth. A prolate spheroid occurs if RadiusX = RadiusY < RadiusZ.

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

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

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


Member Function Documentation

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

An ellipsoid.

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.vtkParametricEllipsoid.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.vtkParametricEllipsoid.GetXRadius ( ) [virtual]

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

virtual double Kitware.VTK.vtkParametricEllipsoid.GetYRadius ( ) [virtual]

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

virtual double Kitware.VTK.vtkParametricEllipsoid.GetZRadius ( ) [virtual]

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

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Construct an ellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 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.vtkParametricEllipsoid.SetXRadius ( double  _arg) [virtual]

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

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

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

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

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

static internal void Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_Evaluate_01 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal double Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_EvaluateScalar_02 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal int Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_GetDimension_03 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_GetXRadius_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_GetYRadius_05 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_GetZRadius_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_IsA_07 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_IsTypeOf_08 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_NewInstance_10 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_SafeDownCast_11 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_SetXRadius_12 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_SetYRadius_13 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricEllipsoid.vtkParametricEllipsoid_SetZRadius_14 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkParametricEllipsoid.MRClassNameKey = "22vtkParametricEllipsoid" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.


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