Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkParametricRandomHills Class Reference

#include <vtkParametricRandomHills.h>

Inheritance diagram for vtkParametricRandomHills:

Inheritance graph
[legend]
Collaboration diagram for vtkParametricRandomHills:

Collaboration graph
[legend]
List of all members.

Detailed Description

Generate a surface covered with randomly placed hills.

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.
Tests:
vtkParametricRandomHills (Tests)

Definition at line 40 of file vtkParametricRandomHills.h.
virtual void SetNumberOfHills (int)
virtual int GetNumberOfHills ()
static vtkParametricRandomHills * New ()

Public Types

typedef vtkParametricFunction Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int GetDimension ()
void GenerateTheHills (void)
virtual void Evaluate (double uvw[3], double Pt[3], double Duvw[9])
virtual double EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
virtual void SetHillXVariance (double)
virtual double GetHillXVariance ()
virtual void SetHillYVariance (double)
virtual double GetHillYVariance ()
virtual void SetHillAmplitude (double)
virtual double GetHillAmplitude ()
virtual void SetRandomSeed (int)
virtual int GetRandomSeed ()
virtual void SetAllowRandomGeneration (int)
virtual int GetAllowRandomGeneration ()
virtual void AllowRandomGenerationOn ()
virtual void AllowRandomGenerationOff ()
virtual void SetXVarianceScaleFactor (double)
virtual double GetXVarianceScaleFactor ()
virtual void SetYVarianceScaleFactor (double)
virtual double GetYVarianceScaleFactor ()
virtual void SetAmplitudeScaleFactor (double)
virtual double GetAmplitudeScaleFactor ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkParametricRandomHills * SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkParametricRandomHills ()
 ~vtkParametricRandomHills ()

Protected Attributes

int NumberOfHills
double HillXVariance
double HillYVariance
double HillAmplitude
int RandomSeed
double XVarianceScaleFactor
double YVarianceScaleFactor
double AmplitudeScaleFactor
int AllowRandomGeneration

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricRandomHills::Superclass
 

Reimplemented from vtkParametricFunction.

Definition at line 44 of file vtkParametricRandomHills.h.

Constructor & Destructor Documentation

vtkParametricRandomHills::vtkParametricRandomHills (   )  [protected]
 

vtkParametricRandomHills::~vtkParametricRandomHills (   )  [protected]
 

Member Function Documentation

virtual const char* vtkParametricRandomHills::GetClassName (   )  [virtual]
 

Reimplemented from vtkParametricFunction.

static int vtkParametricRandomHills::IsTypeOf (  const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkParametricFunction.

virtual int vtkParametricRandomHills::IsA (  const char *  type  )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkParametricFunction.

static vtkParametricRandomHills* vtkParametricRandomHills::SafeDownCast (  vtkObject *  o  )  [static]
 

Reimplemented from vtkParametricFunction.

void vtkParametricRandomHills::PrintSelf (  ostream &  os,
vtkIndent  indent
)  [virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkParametricFunction.

virtual int vtkParametricRandomHills::GetDimension (   )  [inline, virtual]
 

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 48 of file vtkParametricRandomHills.h.

static vtkParametricRandomHills* vtkParametricRandomHills::New (   )  [static]
 

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

virtual void vtkParametricRandomHills::SetNumberOfHills (  int   )  [virtual]
 

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

virtual int vtkParametricRandomHills::GetNumberOfHills (   )  [virtual]
 

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

virtual void vtkParametricRandomHills::SetHillXVariance (  double   )  [virtual]
 

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

virtual double vtkParametricRandomHills::GetHillXVariance (   )  [virtual]
 

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

virtual void vtkParametricRandomHills::SetHillYVariance (  double   )  [virtual]
 

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

virtual double vtkParametricRandomHills::GetHillYVariance (   )  [virtual]
 

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

virtual void vtkParametricRandomHills::SetHillAmplitude (  double   )  [virtual]
 

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

virtual double vtkParametricRandomHills::GetHillAmplitude (   )  [virtual]
 

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

virtual void vtkParametricRandomHills::SetRandomSeed (  int   )  [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 int vtkParametricRandomHills::GetRandomSeed (   )  [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 vtkParametricRandomHills::SetAllowRandomGeneration (  int   )  [virtual]
 

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 int vtkParametricRandomHills::GetAllowRandomGeneration (   )  [virtual]
 

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 vtkParametricRandomHills::AllowRandomGenerationOn (   )  [virtual]
 

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 vtkParametricRandomHills::AllowRandomGenerationOff (   )  [virtual]
 

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 vtkParametricRandomHills::SetXVarianceScaleFactor (  double   )  [virtual]
 

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

virtual double vtkParametricRandomHills::GetXVarianceScaleFactor (   )  [virtual]
 

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

virtual void vtkParametricRandomHills::SetYVarianceScaleFactor (  double   )  [virtual]
 

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

virtual double vtkParametricRandomHills::GetYVarianceScaleFactor (   )  [virtual]
 

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

virtual void vtkParametricRandomHills::SetAmplitudeScaleFactor (  double   )  [virtual]
 

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

virtual double vtkParametricRandomHills::GetAmplitudeScaleFactor (   )  [virtual]
 

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

void vtkParametricRandomHills::GenerateTheHills (  void   ) 
 

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.

virtual void vtkParametricRandomHills::Evaluate (  double  uvw[3],
double  Pt[3],
double  Duvw[9]
)  [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$ .

Implements vtkParametricFunction.

virtual double vtkParametricRandomHills::EvaluateScalar (  double  uvw[3],
double  Pt[3],
double  Duvw[9]
)  [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.

Implements vtkParametricFunction.

Member Data Documentation

int vtkParametricRandomHills::NumberOfHills [protected]
 

Definition at line 154 of file vtkParametricRandomHills.h.

double vtkParametricRandomHills::HillXVariance [protected]
 

Definition at line 155 of file vtkParametricRandomHills.h.

double vtkParametricRandomHills::HillYVariance [protected]
 

Definition at line 156 of file vtkParametricRandomHills.h.

double vtkParametricRandomHills::HillAmplitude [protected]
 

Definition at line 157 of file vtkParametricRandomHills.h.

int vtkParametricRandomHills::RandomSeed [protected]
 

Definition at line 158 of file vtkParametricRandomHills.h.

double vtkParametricRandomHills::XVarianceScaleFactor [protected]
 

Definition at line 159 of file vtkParametricRandomHills.h.

double vtkParametricRandomHills::YVarianceScaleFactor [protected]
 

Definition at line 160 of file vtkParametricRandomHills.h.

double vtkParametricRandomHills::AmplitudeScaleFactor [protected]
 

Definition at line 161 of file vtkParametricRandomHills.h.

int vtkParametricRandomHills::AllowRandomGeneration [protected]
 

Definition at line 162 of file vtkParametricRandomHills.h.

The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:05:56 2008 for VTK by  doxygen 1.4.3-20050530