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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkParametricRandomHillsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetDimension () override
 Return the parametric dimension of the class. More...
 
virtual void SetNumberOfHills (int)
 Set/Get the number of hills. More...
 
virtual int GetNumberOfHills ()
 
virtual void SetHillXVariance (double)
 Set/Get the hill variance in the x-direction. More...
 
virtual double GetHillXVariance ()
 
virtual void SetHillYVariance (double)
 Set/Get the hill variance in the y-direction. More...
 
virtual double GetHillYVariance ()
 
virtual void SetHillAmplitude (double)
 Set/Get the hill amplitude (height). More...
 
virtual double GetHillAmplitude ()
 
virtual void SetRandomSeed (int)
 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. More...
 
virtual int GetRandomSeed ()
 
virtual void SetAllowRandomGeneration (vtkTypeBool)
 Set/Get the random generation flag. More...
 
virtual vtkTypeBool GetAllowRandomGeneration ()
 
virtual void AllowRandomGenerationOn ()
 
virtual void AllowRandomGenerationOff ()
 
virtual void SetXVarianceScaleFactor (double)
 Set/Get the scaling factor for the variance in the x-direction. More...
 
virtual double GetXVarianceScaleFactor ()
 
virtual void SetYVarianceScaleFactor (double)
 Set/Get the scaling factor for the variance in the y-direction. More...
 
virtual double GetYVarianceScaleFactor ()
 
virtual void SetAmplitudeScaleFactor (double)
 Set/Get the scaling factor for the amplitude. More...
 
virtual double GetAmplitudeScaleFactor ()
 
void Evaluate (double uvw[3], double Pt[3], double Duvw[9]) override
 Construct a terrain consisting of hills on a surface. More...
 
double EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9]) override
 Calculate a user defined scalar using one or all of uvw, Pt, Duvw. More...
 
- Public Member Functions inherited from vtkParametricFunction
vtkParametricFunctionNewInstance () const
 
virtual void SetMinimumU (double)
 Set/Get the minimum u-value. More...
 
virtual double GetMinimumU ()
 
virtual void SetMaximumU (double)
 Set/Get the maximum u-value. More...
 
virtual double GetMaximumU ()
 
virtual void SetMinimumV (double)
 Set/Get the minimum v-value. More...
 
virtual double GetMinimumV ()
 
virtual void SetMaximumV (double)
 Set/Get the maximum v-value. More...
 
virtual double GetMaximumV ()
 
virtual void SetMinimumW (double)
 Set/Get the minimum w-value. More...
 
virtual double GetMinimumW ()
 
virtual void SetMaximumW (double)
 Set/Get the maximum w-value. More...
 
virtual double GetMaximumW ()
 
virtual void SetJoinU (vtkTypeBool)
 Set/Get the flag which joins the first triangle strip to the last one. More...
 
virtual vtkTypeBool GetJoinU ()
 
virtual void JoinUOn ()
 
virtual void JoinUOff ()
 
virtual void SetJoinV (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips. More...
 
virtual vtkTypeBool GetJoinV ()
 
virtual void JoinVOn ()
 
virtual void JoinVOff ()
 
virtual void SetJoinW (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips. More...
 
virtual vtkTypeBool GetJoinW ()
 
virtual void JoinWOn ()
 
virtual void JoinWOff ()
 
virtual void SetTwistU (vtkTypeBool)
 Set/Get the flag which joins the first triangle strip to the last one with a twist. More...
 
virtual vtkTypeBool GetTwistU ()
 
virtual void TwistUOn ()
 
virtual void TwistUOff ()
 
virtual void SetTwistV (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips with a twist. More...
 
virtual vtkTypeBool GetTwistV ()
 
virtual void TwistVOn ()
 
virtual void TwistVOff ()
 
virtual void SetTwistW (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips with a twist. More...
 
virtual vtkTypeBool GetTwistW ()
 
virtual void TwistWOn ()
 
virtual void TwistWOff ()
 
virtual void SetClockwiseOrdering (vtkTypeBool)
 Set/Get the flag which determines the ordering of the vertices forming the triangle strips. More...
 
virtual vtkTypeBool GetClockwiseOrdering ()
 
virtual void ClockwiseOrderingOn ()
 
virtual void ClockwiseOrderingOff ()
 
virtual void SetDerivativesAvailable (vtkTypeBool)
 Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...
 
virtual vtkTypeBool GetDerivativesAvailable ()
 
virtual void DerivativesAvailableOn ()
 
virtual void DerivativesAvailableOff ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParametricRandomHillsSafeDownCast (vtkObjectBase *o)
 
static vtkParametricRandomHillsNew ()
 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 = 0, 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 = 2, Scaling factor for the amplitude = 1/3, RandomSeed = 1, AllowRandomGeneration = 1. More...
 
- Static Public Member Functions inherited from vtkParametricFunction
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParametricFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkParametricRandomHills ()
 
 ~vtkParametricRandomHills () override
 
- Protected Member Functions inherited from vtkParametricFunction
 vtkParametricFunction ()
 
 ~vtkParametricFunction () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
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
 
vtkTypeBool AllowRandomGeneration
 
int previousNumberOfHills
 
double previousHillXVariance
 
double previousHillYVariance
 
double previousHillAmplitude
 
int previousRandomSeed
 
double previousXVarianceScaleFactor
 
double previousYVarianceScaleFactor
 
double previousAmplitudeScaleFactor
 
int previousAllowRandomGeneration
 
- Protected Attributes inherited from vtkParametricFunction
double MinimumU
 
double MaximumU
 
double MinimumV
 
double MaximumV
 
double MinimumW
 
double MaximumW
 
vtkTypeBool JoinU
 
vtkTypeBool JoinV
 
vtkTypeBool JoinW
 
vtkTypeBool TwistU
 
vtkTypeBool TwistV
 
vtkTypeBool TwistW
 
vtkTypeBool ClockwiseOrdering
 
vtkTypeBool DerivativesAvailable
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Generate a surface covered with randomly placed hills.

vtkParametricRandomHills generates a surface covered with randomly placed hills. Hills will vary in shape and height since the presence of nearby hills will contribute to the shape and height of a given hill. An option is provided for placing hills on a regular grid on the surface. In this case the hills will all have the same shape and height.

For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/publications in the "VTK Technical Documents" section in the VTk.org web pages.

Thanks:
Andrew Maclean andre.nosp@m.w.am.nosp@m.aclea.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om for creating and contributing the class.

Definition at line 44 of file vtkParametricRandomHills.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkParametricRandomHills.h.

Constructor & Destructor Documentation

◆ vtkParametricRandomHills()

vtkParametricRandomHills::vtkParametricRandomHills ( )
protected

◆ ~vtkParametricRandomHills()

vtkParametricRandomHills::~vtkParametricRandomHills ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkParametricRandomHills::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkParametricRandomHills* vtkParametricRandomHills::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkParametricRandomHills::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkParametricFunction.

◆ NewInstance()

vtkParametricRandomHills* vtkParametricRandomHills::NewInstance ( ) const

◆ PrintSelf()

void vtkParametricRandomHills::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ GetDimension()

int vtkParametricRandomHills::GetDimension ( )
inlineoverridevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 54 of file vtkParametricRandomHills.h.

◆ New()

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 = 0, 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 = 2, Scaling factor for the amplitude = 1/3, RandomSeed = 1, AllowRandomGeneration = 1.

◆ SetNumberOfHills()

virtual void vtkParametricRandomHills::SetNumberOfHills ( int  )
virtual

Set/Get the number of hills.

Default is 30.

◆ GetNumberOfHills()

virtual int vtkParametricRandomHills::GetNumberOfHills ( )
virtual

◆ SetHillXVariance()

virtual void vtkParametricRandomHills::SetHillXVariance ( double  )
virtual

Set/Get the hill variance in the x-direction.

Default is 2.5.

◆ GetHillXVariance()

virtual double vtkParametricRandomHills::GetHillXVariance ( )
virtual

◆ SetHillYVariance()

virtual void vtkParametricRandomHills::SetHillYVariance ( double  )
virtual

Set/Get the hill variance in the y-direction.

Default is 2.5.

◆ GetHillYVariance()

virtual double vtkParametricRandomHills::GetHillYVariance ( )
virtual

◆ SetHillAmplitude()

virtual void vtkParametricRandomHills::SetHillAmplitude ( double  )
virtual

Set/Get the hill amplitude (height).

Default is 2.

◆ GetHillAmplitude()

virtual double vtkParametricRandomHills::GetHillAmplitude ( )
virtual

◆ SetRandomSeed()

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.

◆ GetRandomSeed()

virtual int vtkParametricRandomHills::GetRandomSeed ( )
virtual

◆ SetAllowRandomGeneration()

virtual void vtkParametricRandomHills::SetAllowRandomGeneration ( vtkTypeBool  )
virtual

Set/Get the random generation flag.

A value of 0 will disable the generation of random hills on the surface allowing a reproducible number of identically shaped hills to be generated. If zero, then the number of hills used will be the nearest perfect square less than or equal to the number of hills. For example, selecting 30 hills will result in a 5 X 5 array of hills being generated. Thus a square array of hills will be generated.

Any other value means that the hills will be placed randomly on the surface. Default is 1.

◆ GetAllowRandomGeneration()

virtual vtkTypeBool vtkParametricRandomHills::GetAllowRandomGeneration ( )
virtual

◆ AllowRandomGenerationOn()

virtual void vtkParametricRandomHills::AllowRandomGenerationOn ( )
virtual

◆ AllowRandomGenerationOff()

virtual void vtkParametricRandomHills::AllowRandomGenerationOff ( )
virtual

◆ SetXVarianceScaleFactor()

virtual void vtkParametricRandomHills::SetXVarianceScaleFactor ( double  )
virtual

Set/Get the scaling factor for the variance in the x-direction.

Default is 1/3.

◆ GetXVarianceScaleFactor()

virtual double vtkParametricRandomHills::GetXVarianceScaleFactor ( )
virtual

◆ SetYVarianceScaleFactor()

virtual void vtkParametricRandomHills::SetYVarianceScaleFactor ( double  )
virtual

Set/Get the scaling factor for the variance in the y-direction.

Default is 1/3.

◆ GetYVarianceScaleFactor()

virtual double vtkParametricRandomHills::GetYVarianceScaleFactor ( )
virtual

◆ SetAmplitudeScaleFactor()

virtual void vtkParametricRandomHills::SetAmplitudeScaleFactor ( double  )
virtual

Set/Get the scaling factor for the amplitude.

Default is 1/3.

◆ GetAmplitudeScaleFactor()

virtual double vtkParametricRandomHills::GetAmplitudeScaleFactor ( )
virtual

◆ Evaluate()

void vtkParametricRandomHills::Evaluate ( double  uvw[3],
double  Pt[3],
double  Duvw[9] 
)
overridevirtual

Construct a terrain consisting of hills on a 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$ .

Implements vtkParametricFunction.

◆ EvaluateScalar()

double vtkParametricRandomHills::EvaluateScalar ( double  uvw[3],
double  Pt[3],
double  Duvw[9] 
)
overridevirtual

Calculate a user defined scalar using one or all of uvw, Pt, Duvw.

uvw are the parameters with Pt being 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

◆ NumberOfHills

int vtkParametricRandomHills::NumberOfHills
protected

Definition at line 197 of file vtkParametricRandomHills.h.

◆ HillXVariance

double vtkParametricRandomHills::HillXVariance
protected

Definition at line 198 of file vtkParametricRandomHills.h.

◆ HillYVariance

double vtkParametricRandomHills::HillYVariance
protected

Definition at line 199 of file vtkParametricRandomHills.h.

◆ HillAmplitude

double vtkParametricRandomHills::HillAmplitude
protected

Definition at line 200 of file vtkParametricRandomHills.h.

◆ RandomSeed

int vtkParametricRandomHills::RandomSeed
protected

Definition at line 201 of file vtkParametricRandomHills.h.

◆ XVarianceScaleFactor

double vtkParametricRandomHills::XVarianceScaleFactor
protected

Definition at line 202 of file vtkParametricRandomHills.h.

◆ YVarianceScaleFactor

double vtkParametricRandomHills::YVarianceScaleFactor
protected

Definition at line 203 of file vtkParametricRandomHills.h.

◆ AmplitudeScaleFactor

double vtkParametricRandomHills::AmplitudeScaleFactor
protected

Definition at line 204 of file vtkParametricRandomHills.h.

◆ AllowRandomGeneration

vtkTypeBool vtkParametricRandomHills::AllowRandomGeneration
protected

Definition at line 205 of file vtkParametricRandomHills.h.

◆ previousNumberOfHills

int vtkParametricRandomHills::previousNumberOfHills
protected

Definition at line 208 of file vtkParametricRandomHills.h.

◆ previousHillXVariance

double vtkParametricRandomHills::previousHillXVariance
protected

Definition at line 209 of file vtkParametricRandomHills.h.

◆ previousHillYVariance

double vtkParametricRandomHills::previousHillYVariance
protected

Definition at line 210 of file vtkParametricRandomHills.h.

◆ previousHillAmplitude

double vtkParametricRandomHills::previousHillAmplitude
protected

Definition at line 211 of file vtkParametricRandomHills.h.

◆ previousRandomSeed

int vtkParametricRandomHills::previousRandomSeed
protected

Definition at line 212 of file vtkParametricRandomHills.h.

◆ previousXVarianceScaleFactor

double vtkParametricRandomHills::previousXVarianceScaleFactor
protected

Definition at line 213 of file vtkParametricRandomHills.h.

◆ previousYVarianceScaleFactor

double vtkParametricRandomHills::previousYVarianceScaleFactor
protected

Definition at line 214 of file vtkParametricRandomHills.h.

◆ previousAmplitudeScaleFactor

double vtkParametricRandomHills::previousAmplitudeScaleFactor
protected

Definition at line 215 of file vtkParametricRandomHills.h.

◆ previousAllowRandomGeneration

int vtkParametricRandomHills::previousAllowRandomGeneration
protected

Definition at line 216 of file vtkParametricRandomHills.h.


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