vtkPerlinNoise Class Reference

an implicit function that implements Perlin noise More...

#include <vtkPerlinNoise.h>

Inheritance diagram for vtkPerlinNoise:

Collaboration diagram for vtkPerlinNoise:

Public Types
typedef vtkImplicitFunction	Superclass
Public Types inherited from vtkImplicitFunction
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.
vtkPerlinNoise *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	EvaluateGradient (double x[3], double n[3]) override
	Evaluate PerlinNoise gradient.
double	EvaluateFunction (double x[3]) override
	Evaluate PerlinNoise function.
virtual double	EvaluateFunction (double x[3])=0
	Evaluate PerlinNoise function.
virtual void	EvaluateFunction (vtkDataArray *input, vtkDataArray *output)
	Evaluate PerlinNoise function.
virtual double	EvaluateFunction (double x, double y, double z)
	Evaluate PerlinNoise function.
virtual void	SetFrequency (double, double, double)
	Set/get the frequency, or physical scale, of the noise function (higher is finer scale).
virtual void	SetFrequency (double[3])
	Set/get the frequency, or physical scale, of the noise function (higher is finer scale).
virtual double *	GetFrequency ()
	Set/get the frequency, or physical scale, of the noise function (higher is finer scale).
virtual void	GetFrequency (double data[3])
	Set/get the frequency, or physical scale, of the noise function (higher is finer scale).
virtual void	SetPhase (double, double, double)
	Set/get the phase of the noise function.
virtual void	SetPhase (double[3])
	Set/get the phase of the noise function.
virtual double *	GetPhase ()
	Set/get the phase of the noise function.
virtual void	GetPhase (double data[3])
	Set/get the phase of the noise function.
virtual void	SetAmplitude (double)
	Set/get the amplitude of the noise function.
virtual double	GetAmplitude ()
	Set/get the amplitude of the noise function.
Public Member Functions inherited from vtkImplicitFunction
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkImplicitFunction *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	Overload standard modified time function.
virtual void	EvaluateGradient (double x[3], double g[3])=0
	Evaluate function gradient at position x-y-z and pass back vector.
virtual void	FunctionValue (vtkDataArray *input, vtkDataArray *output)
	Evaluate function at position x-y-z and return value.
double	FunctionValue (const double x[3])
	Evaluate function at position x-y-z and return value.
double	FunctionValue (double x, double y, double z)
	Evaluate function at position x-y-z and return value.
void	FunctionGradient (const double x[3], double g[3])
	Evaluate function gradient at position x-y-z and pass back vector.
double *	FunctionGradient (const double x[3])
	Evaluate function gradient at position x-y-z and pass back vector.
double *	FunctionGradient (double x, double y, double z)
	Evaluate function gradient at position x-y-z and pass back vector.
virtual void	SetTransform (vtkAbstractTransform *)
	Set/Get a transformation to apply to input points before executing the implicit function.
virtual void	SetTransform (const double elements[16])
	Set/Get a transformation to apply to input points before executing the implicit function.
virtual vtkAbstractTransform *	GetTransform ()
	Set/Get a transformation to apply to input points before executing the implicit function.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPerlinNoise *	SafeDownCast (vtkObjectBase *o)
static vtkPerlinNoise *	New ()
	Instantiate the class.
Static Public Member Functions inherited from vtkImplicitFunction
static vtkTypeBool	IsTypeOf (const char *type)
static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPerlinNoise ()
	~vtkPerlinNoise () override=default
Protected Member Functions inherited from vtkImplicitFunction
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImplicitFunction ()
	~vtkImplicitFunction () 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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	Frequency [3]
double	Phase [3]
double	Amplitude
Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform
double	ReturnValue [3]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

an implicit function that implements Perlin noise

vtkPerlinNoise computes a Perlin noise field as an implicit function. vtkPerlinNoise is a concrete implementation of vtkImplicitFunction. Perlin noise, originally described by Ken Perlin, is a non-periodic and continuous noise function useful for modeling real-world objects.

The amplitude and frequency of the noise pattern are adjustable. This implementation of Perlin noise is derived closely from Greg Ward's version in Graphics Gems II.

See also

vtkImplicitFunction

Online Examples:

PerlinNoise

Definition at line 57 of file vtkPerlinNoise.h.

Member Typedef Documentation

Superclass

typedef vtkImplicitFunction vtkPerlinNoise::Superclass

Definition at line 60 of file vtkPerlinNoise.h.

Constructor & Destructor Documentation

vtkPerlinNoise()

vtkPerlinNoise::vtkPerlinNoise ( )

protected

~vtkPerlinNoise()

vtkPerlinNoise::~vtkPerlinNoise ( )

overrideprotecteddefault

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkPerlinNoise::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 vtkImplicitFunction.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPerlinNoise::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

NewInstance()

vtkPerlinNoise * vtkPerlinNoise::NewInstance

(

)

const

PrintSelf()

void vtkPerlinNoise::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 vtkImplicitFunction.

New()

static vtkPerlinNoise * vtkPerlinNoise::New ( )

static

Instantiate the class.

EvaluateFunction() [1/4]

double vtkPerlinNoise::EvaluateFunction ( double  x[3] )

overridevirtual

Evaluate PerlinNoise function.

Implements vtkImplicitFunction.

EvaluateGradient()

void vtkPerlinNoise::EvaluateGradient ( double  x[3], double  n[3]  )

overridevirtual

Evaluate PerlinNoise gradient.

Currently, the method returns a 0 gradient.

Implements vtkImplicitFunction.

SetFrequency() [1/2]

virtual void vtkPerlinNoise::SetFrequency ( double  , double  , double    )

virtual

Set/get the frequency, or physical scale, of the noise function (higher is finer scale).

The frequency can be adjusted per axis, or the same for all axes.

SetFrequency() [2/2]

virtual void vtkPerlinNoise::SetFrequency ( double  [3] )

virtual

Set/get the frequency, or physical scale, of the noise function (higher is finer scale).

The frequency can be adjusted per axis, or the same for all axes.

GetFrequency() [1/2]

virtual double * vtkPerlinNoise::GetFrequency ( )

virtual

Set/get the frequency, or physical scale, of the noise function (higher is finer scale).

The frequency can be adjusted per axis, or the same for all axes.

GetFrequency() [2/2]

virtual void vtkPerlinNoise::GetFrequency ( double  data[3] )

virtual

Set/get the frequency, or physical scale, of the noise function (higher is finer scale).

The frequency can be adjusted per axis, or the same for all axes.

SetPhase() [1/2]

virtual void vtkPerlinNoise::SetPhase ( double  , double  , double    )

virtual

Set/get the phase of the noise function.

This parameter can be used to shift the noise function within space (perhaps to avoid a beat with a noise pattern at another scale). Phase tends to repeat about every unit, so a phase of 0.5 is a half-cycle shift.

SetPhase() [2/2]

virtual void vtkPerlinNoise::SetPhase ( double  [3] )

virtual

Set/get the phase of the noise function.

This parameter can be used to shift the noise function within space (perhaps to avoid a beat with a noise pattern at another scale). Phase tends to repeat about every unit, so a phase of 0.5 is a half-cycle shift.

GetPhase() [1/2]

virtual double * vtkPerlinNoise::GetPhase ( )

virtual

Set/get the phase of the noise function.

This parameter can be used to shift the noise function within space (perhaps to avoid a beat with a noise pattern at another scale). Phase tends to repeat about every unit, so a phase of 0.5 is a half-cycle shift.

GetPhase() [2/2]

virtual void vtkPerlinNoise::GetPhase ( double  data[3] )

virtual

Set/get the phase of the noise function.

This parameter can be used to shift the noise function within space (perhaps to avoid a beat with a noise pattern at another scale). Phase tends to repeat about every unit, so a phase of 0.5 is a half-cycle shift.

SetAmplitude()

virtual void vtkPerlinNoise::SetAmplitude ( double  )

virtual

Set/get the amplitude of the noise function.

Amplitude can be negative. The noise function varies randomly between -|Amplitude| and |Amplitude|. Therefore the range of values is 2*|Amplitude| large. The initial amplitude is 1.

GetAmplitude()

virtual double vtkPerlinNoise::GetAmplitude ( )

virtual

Set/get the amplitude of the noise function.

Amplitude can be negative. The noise function varies randomly between -|Amplitude| and |Amplitude|. Therefore the range of values is 2*|Amplitude| large. The initial amplitude is 1.

EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction ( double  x[3] )

virtual

Evaluate PerlinNoise function.

Implements vtkImplicitFunction.

EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction ( vtkDataArray *  input, vtkDataArray *  output  )

virtual

Evaluate PerlinNoise function.

Reimplemented from vtkImplicitFunction.

EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction ( double  x, double  y, double  z  )

inlinevirtual

Evaluate PerlinNoise function.

Reimplemented from vtkImplicitFunction.

Definition at line 142 of file vtkImplicitFunction.h.

Member Data Documentation

Frequency

double vtkPerlinNoise::Frequency[3]

protected

Definition at line 118 of file vtkPerlinNoise.h.

Phase

double vtkPerlinNoise::Phase[3]

protected

Definition at line 119 of file vtkPerlinNoise.h.

Amplitude

double vtkPerlinNoise::Amplitude

protected

Definition at line 120 of file vtkPerlinNoise.h.

---

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

• Common/DataModel/vtkPerlinNoise.h