VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkParametricRandomHills Class Reference

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

#include <vtkParametricRandomHills.h>

Inheritance diagram for vtkParametricRandomHills:
[legend]
Collaboration diagram for vtkParametricRandomHills:
[legend]

Public Types

typedef vtkParametricFunction Superclass
 
- Public Types inherited from vtkParametricFunction
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 SetNumberOfHills (int)
 
virtual int GetNumberOfHills ()
 
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 ()
 
- Public Member Functions inherited from vtkParametricFunction
virtual void SetMinimumU (double)
 
virtual double GetMinimumU ()
 
virtual void SetMaximumU (double)
 
virtual double GetMaximumU ()
 
virtual void SetMinimumV (double)
 
virtual double GetMinimumV ()
 
virtual void SetMaximumV (double)
 
virtual double GetMaximumV ()
 
virtual void SetMinimumW (double)
 
virtual double GetMinimumW ()
 
virtual void SetMaximumW (double)
 
virtual double GetMaximumW ()
 
virtual void SetJoinU (int)
 
virtual int GetJoinU ()
 
virtual void JoinUOn ()
 
virtual void JoinUOff ()
 
virtual void SetJoinV (int)
 
virtual int GetJoinV ()
 
virtual void JoinVOn ()
 
virtual void JoinVOff ()
 
virtual void SetTwistU (int)
 
virtual int GetTwistU ()
 
virtual void TwistUOn ()
 
virtual void TwistUOff ()
 
virtual void SetTwistV (int)
 
virtual int GetTwistV ()
 
virtual void TwistVOn ()
 
virtual void TwistVOff ()
 
virtual void SetClockwiseOrdering (int)
 
virtual int GetClockwiseOrdering ()
 
virtual void ClockwiseOrderingOn ()
 
virtual void ClockwiseOrderingOff ()
 
virtual void SetDerivativesAvailable (int)
 
virtual int GetDerivativesAvailable ()
 
virtual void DerivativesAvailableOn ()
 
virtual void DerivativesAvailableOff ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkParametricRandomHillsSafeDownCast (vtkObject *o)
 
static vtkParametricRandomHillsNew ()
 
- Static Public Member Functions inherited from vtkParametricFunction
static int IsTypeOf (const char *type)
 
static vtkParametricFunctionSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkParametricRandomHills ()
 
 ~vtkParametricRandomHills ()
 
- Protected Member Functions inherited from vtkParametricFunction
 vtkParametricFunction ()
 
virtual ~vtkParametricFunction ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfHills
 
double HillXVariance
 
double HillYVariance
 
double HillAmplitude
 
int RandomSeed
 
double XVarianceScaleFactor
 
double YVarianceScaleFactor
 
double AmplitudeScaleFactor
 
int AllowRandomGeneration
 
- Protected Attributes inherited from vtkParametricFunction
double MinimumU
 
double MaximumU
 
double MinimumV
 
double MaximumV
 
double MinimumW
 
double MaximumW
 
int JoinU
 
int JoinV
 
int JoinW
 
int TwistU
 
int TwistV
 
int TwistW
 
int ClockwiseOrdering
 
int DerivativesAvailable
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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.mac.nosp@m.lean.nosp@m.@cas..nosp@m.edu..nosp@m.au for creating and contributing the class.
Tests:
vtkParametricRandomHills (Tests)

Definition at line 40 of file vtkParametricRandomHills.h.

Member Typedef Documentation

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
virtual int vtkParametricRandomHills::IsA ( const char *  name)
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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkParametricFunction.

static vtkParametricRandomHills* vtkParametricRandomHills::SafeDownCast ( vtkObject o)
static
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 ( )
inlinevirtual

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.

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: