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

vtkParametricRandomHills - Generate a surface covered with randomly placed hills. More...

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

List of all members.

Public Member Functions

 vtkParametricRandomHills (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkParametricRandomHills ()
 Construct a surface of random hills with the following parameters: MinimumU = -10, MaximumU = 10, MinimumV = -10, MaximumV = 10, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0; ClockwiseOrdering = 1, DerivativesAvailable = 0, Number of hills = 30, Variance of the hills 2.5 in both x- and y- directions, Scaling factor for the variances 1/3 in both x- and y- directions, Amplitude of each hill = 1, Scaling factor for the amplitude = 1/3, RandomSeed = 1, AllowRandomGeneration = 1.
virtual void AllowRandomGenerationOff ()
 Set/Get the random generation flag. A value of 0 will disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other value means that the generation of the hills will be done randomly. Default is 1.
virtual void AllowRandomGenerationOn ()
 Set/Get the random generation flag. A value of 0 will disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other value means that the generation of the hills will be done randomly. Default is 1.
override void Evaluate (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 Construct a terrain consisting of randomly placed hills on a surface.
override double EvaluateScalar (IntPtr uvw, IntPtr Pt, IntPtr Duvw)
 Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
void GenerateTheHills ()
 Generate the centers of the hills, their standard deviations and their amplitudes. This function creates a series of vectors representing the u, v coordinates of each hill, its variance in the u, v directions and the amplitude.
virtual int GetAllowRandomGeneration ()
 Set/Get the random generation flag. A value of 0 will disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other value means that the generation of the hills will be done randomly. Default is 1.
virtual double GetAmplitudeScaleFactor ()
 Set/Get the scaling factor for the amplitude. Default is 1/3.
override int GetDimension ()
 Description Return the parametric dimension of the class.
virtual double GetHillAmplitude ()
 Set/Get the hill amplitude (height). Default is 2.
virtual double GetHillXVariance ()
 Set/Get the hill variance in the x-direction. Default is 2.5.
virtual double GetHillYVariance ()
 Set/Get the hill variance in the y-direction. Default is 2.5.
virtual int GetNumberOfHills ()
 Set/Get the number of hills. Default is 30.
virtual int GetRandomSeed ()
 Set/Get the Seed for the random number generator, a value of 1 will initialize the random number generator, a negative value will initialize it with the system time. Default is 1.
virtual double GetXVarianceScaleFactor ()
 Set/Get the scaling factor for the variance in the x-direction. Default is 1/3.
virtual double GetYVarianceScaleFactor ()
 Set/Get the scaling factor for the variance in the y-direction. Default is 1/3.
override int IsA (string type)
 Undocumented Block.
new vtkParametricRandomHills NewInstance ()
 Undocumented Block.
virtual void SetAllowRandomGeneration (int _arg)
 Set/Get the random generation flag. A value of 0 will disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other value means that the generation of the hills will be done randomly. Default is 1.
virtual void SetAmplitudeScaleFactor (double _arg)
 Set/Get the scaling factor for the amplitude. Default is 1/3.
virtual void SetHillAmplitude (double _arg)
 Set/Get the hill amplitude (height). Default is 2.
virtual void SetHillXVariance (double _arg)
 Set/Get the hill variance in the x-direction. Default is 2.5.
virtual void SetHillYVariance (double _arg)
 Set/Get the hill variance in the y-direction. Default is 2.5.
virtual void SetNumberOfHills (int _arg)
 Set/Get the number of hills. Default is 30.
virtual void SetRandomSeed (int _arg)
 Set/Get the Seed for the random number generator, a value of 1 will initialize the random number generator, a negative value will initialize it with the system time. Default is 1.
virtual void SetXVarianceScaleFactor (double _arg)
 Set/Get the scaling factor for the variance in the x-direction. Default is 1/3.
virtual void SetYVarianceScaleFactor (double _arg)
 Set/Get the scaling factor for the variance in the y-direction. Default is 1/3.

Static Public Member Functions

static new vtkParametricRandomHills New ()
 Construct a surface of random hills with the following parameters: MinimumU = -10, MaximumU = 10, MinimumV = -10, MaximumV = 10, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0; ClockwiseOrdering = 1, DerivativesAvailable = 0, Number of hills = 30, Variance of the hills 2.5 in both x- and y- directions, Scaling factor for the variances 1/3 in both x- and y- directions, Amplitude of each hill = 1, Scaling factor for the amplitude = 1/3, RandomSeed = 1, AllowRandomGeneration = 1.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkParametricRandomHills SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "24vtkParametricRandomHills"
 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 vtkParametricRandomHills_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricRandomHills_AllowRandomGenerationOff_01 (HandleRef pThis)
static internal void vtkParametricRandomHills_AllowRandomGenerationOn_02 (HandleRef pThis)
static internal void vtkParametricRandomHills_Evaluate_03 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal double vtkParametricRandomHills_EvaluateScalar_04 (HandleRef pThis, IntPtr uvw, IntPtr Pt, IntPtr Duvw)
static internal void vtkParametricRandomHills_GenerateTheHills_05 (HandleRef pThis)
static internal int vtkParametricRandomHills_GetAllowRandomGeneration_06 (HandleRef pThis)
static internal double vtkParametricRandomHills_GetAmplitudeScaleFactor_07 (HandleRef pThis)
static internal int vtkParametricRandomHills_GetDimension_08 (HandleRef pThis)
static internal double vtkParametricRandomHills_GetHillAmplitude_09 (HandleRef pThis)
static internal double vtkParametricRandomHills_GetHillXVariance_10 (HandleRef pThis)
static internal double vtkParametricRandomHills_GetHillYVariance_11 (HandleRef pThis)
static internal int vtkParametricRandomHills_GetNumberOfHills_12 (HandleRef pThis)
static internal int vtkParametricRandomHills_GetRandomSeed_13 (HandleRef pThis)
static internal double vtkParametricRandomHills_GetXVarianceScaleFactor_14 (HandleRef pThis)
static internal double vtkParametricRandomHills_GetYVarianceScaleFactor_15 (HandleRef pThis)
static internal int vtkParametricRandomHills_IsA_16 (HandleRef pThis, string type)
static internal int vtkParametricRandomHills_IsTypeOf_17 (string type)
static internal IntPtr vtkParametricRandomHills_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkParametricRandomHills_SafeDownCast_20 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParametricRandomHills_SetAllowRandomGeneration_21 (HandleRef pThis, int _arg)
static internal void vtkParametricRandomHills_SetAmplitudeScaleFactor_22 (HandleRef pThis, double _arg)
static internal void vtkParametricRandomHills_SetHillAmplitude_23 (HandleRef pThis, double _arg)
static internal void vtkParametricRandomHills_SetHillXVariance_24 (HandleRef pThis, double _arg)
static internal void vtkParametricRandomHills_SetHillYVariance_25 (HandleRef pThis, double _arg)
static internal void vtkParametricRandomHills_SetNumberOfHills_26 (HandleRef pThis, int _arg)
static internal void vtkParametricRandomHills_SetRandomSeed_27 (HandleRef pThis, int _arg)
static internal void vtkParametricRandomHills_SetXVarianceScaleFactor_28 (HandleRef pThis, double _arg)
static internal void vtkParametricRandomHills_SetYVarianceScaleFactor_29 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkParametricRandomHills ()
 Automatically generated type registration mechanics.

Detailed Description

vtkParametricRandomHills - Generate a surface covered with randomly placed hills.

Description vtkParametricRandomHills generates a surface covered with randomly placed hills.

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

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

Construct a surface of random hills with the following parameters: MinimumU = -10, MaximumU = 10, MinimumV = -10, MaximumV = 10, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0; ClockwiseOrdering = 1, DerivativesAvailable = 0, Number of hills = 30, Variance of the hills 2.5 in both x- and y- directions, Scaling factor for the variances 1/3 in both x- and y- directions, Amplitude of each hill = 1, Scaling factor for the amplitude = 1/3, RandomSeed = 1, AllowRandomGeneration = 1.


Member Function Documentation

Set/Get the random generation flag. A value of 0 will disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other value means that the generation of the hills will be done randomly. Default is 1.

Set/Get the random generation flag. A value of 0 will disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other value means that the generation of the hills will be done randomly. Default is 1.

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

Construct a terrain consisting of randomly placed hills on a surface.

It is assumed that the function GenerateTheHills() has been executed to build the vectors of coordinates required to generate the point Pt. Pt represents the sum of all the amplitudes over the space.

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

Generate the centers of the hills, their standard deviations and their amplitudes. This function creates a series of vectors representing the u, v coordinates of each hill, its variance in the u, v directions and the amplitude.

NOTE: This function must be called whenever any of the parameters are changed.

Set/Get the random generation flag. A value of 0 will disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other value means that the generation of the hills will be done randomly. Default is 1.

Set/Get the scaling factor for the amplitude. Default is 1/3.

Description Return the parametric dimension of the class.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Set/Get the hill amplitude (height). Default is 2.

Set/Get the hill variance in the x-direction. Default is 2.5.

Set/Get the hill variance in the y-direction. Default is 2.5.

Set/Get the number of hills. Default is 30.

Set/Get the Seed for the random number generator, a value of 1 will initialize the random number generator, a negative value will initialize it with the system time. Default is 1.

Set/Get the scaling factor for the variance in the x-direction. Default is 1/3.

Set/Get the scaling factor for the variance in the y-direction. Default is 1/3.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkParametricFunction.

Construct a surface of random hills with the following parameters: MinimumU = -10, MaximumU = 10, MinimumV = -10, MaximumV = 10, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0; ClockwiseOrdering = 1, DerivativesAvailable = 0, Number of hills = 30, Variance of the hills 2.5 in both x- and y- directions, Scaling factor for the variances 1/3 in both x- and y- directions, Amplitude of each hill = 1, Scaling factor for the amplitude = 1/3, RandomSeed = 1, AllowRandomGeneration = 1.

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:

Set/Get the random generation flag. A value of 0 will disable the generation of random hills on the surface. This allows a reproducible shape to be generated. Any other value means that the generation of the hills will be done randomly. Default is 1.

virtual void Kitware.VTK.vtkParametricRandomHills.SetAmplitudeScaleFactor ( double  _arg) [virtual]

Set/Get the scaling factor for the amplitude. Default is 1/3.

virtual void Kitware.VTK.vtkParametricRandomHills.SetHillAmplitude ( double  _arg) [virtual]

Set/Get the hill amplitude (height). Default is 2.

virtual void Kitware.VTK.vtkParametricRandomHills.SetHillXVariance ( double  _arg) [virtual]

Set/Get the hill variance in the x-direction. Default is 2.5.

virtual void Kitware.VTK.vtkParametricRandomHills.SetHillYVariance ( double  _arg) [virtual]

Set/Get the hill variance in the y-direction. Default is 2.5.

virtual void Kitware.VTK.vtkParametricRandomHills.SetNumberOfHills ( int  _arg) [virtual]

Set/Get the number of hills. Default is 30.

virtual void Kitware.VTK.vtkParametricRandomHills.SetRandomSeed ( int  _arg) [virtual]

Set/Get the Seed for the random number generator, a value of 1 will initialize the random number generator, a negative value will initialize it with the system time. Default is 1.

virtual void Kitware.VTK.vtkParametricRandomHills.SetXVarianceScaleFactor ( double  _arg) [virtual]

Set/Get the scaling factor for the variance in the x-direction. Default is 1/3.

virtual void Kitware.VTK.vtkParametricRandomHills.SetYVarianceScaleFactor ( double  _arg) [virtual]

Set/Get the scaling factor for the variance in the y-direction. Default is 1/3.

static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_Evaluate_03 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal double Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_EvaluateScalar_04 ( HandleRef  pThis,
IntPtr  uvw,
IntPtr  Pt,
IntPtr  Duvw 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_GenerateTheHills_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_GetDimension_08 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_GetHillAmplitude_09 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_GetHillXVariance_10 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_GetHillYVariance_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_GetRandomSeed_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_IsA_16 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_IsTypeOf_17 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SafeDownCast_20 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetAllowRandomGeneration_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetAmplitudeScaleFactor_22 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetHillAmplitude_23 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetHillXVariance_24 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetHillYVariance_25 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetNumberOfHills_26 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetRandomSeed_27 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetXVarianceScaleFactor_28 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkParametricRandomHills.vtkParametricRandomHills_SetYVarianceScaleFactor_29 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkParametricFunction.


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