Kitware.VTK.vtkPerlinNoise Class Reference

vtkPerlinNoise - an implicit function that implements Perlin noise More...

Inheritance diagram for Kitware.VTK.vtkPerlinNoise:

Collaboration diagram for Kitware.VTK.vtkPerlinNoise:

List of all members.

Public Member Functions
	vtkPerlinNoise (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkPerlinNoise ()
	Description Instantiate the class.
override double	EvaluateFunction (IntPtr x)
	Evaluate PerlinNoise function.
new double	EvaluateFunction (double x, double y, double z)
	Evaluate PerlinNoise function.
override void	EvaluateGradient (IntPtr x, IntPtr n)
	Evaluate PerlinNoise gradient. Currently, the method returns a 0 gradient.
virtual double	GetAmplitude ()
	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.
virtual double[]	GetFrequency ()
	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.
virtual void	GetFrequency (IntPtr data)
	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.
virtual double[]	GetPhase ()
	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.
virtual void	GetPhase (IntPtr data)
	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.
override int	IsA (string type)
	Undocumented Block.
new vtkPerlinNoise	NewInstance ()
	Undocumented Block.
virtual void	SetAmplitude (double _arg)
	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.
virtual void	SetFrequency (double _arg1, double _arg2, double _arg3)
	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.
virtual void	SetFrequency (IntPtr _arg)
	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.
virtual void	SetPhase (double _arg1, double _arg2, double _arg3)
	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.
virtual void	SetPhase (IntPtr _arg)
	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.
Static Public Member Functions
static new vtkPerlinNoise	New ()
	Description Instantiate the class.
static new int	IsTypeOf (string type)
	Undocumented Block.
static new vtkPerlinNoise	SafeDownCast (vtkObjectBase o)
	Undocumented Block.
Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkPerlinNoise"
	Automatically generated type registration mechanics.
Static Public Attributes
static new readonly string	MRClassNameKey = "14vtkPerlinNoise"
	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	vtkPerlinNoise_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double	vtkPerlinNoise_EvaluateFunction_01 (HandleRef pThis, IntPtr x)
static internal double	vtkPerlinNoise_EvaluateFunction_02 (HandleRef pThis, double x, double y, double z)
static internal void	vtkPerlinNoise_EvaluateGradient_03 (HandleRef pThis, IntPtr x, IntPtr n)
static internal double	vtkPerlinNoise_GetAmplitude_04 (HandleRef pThis)
static internal IntPtr	vtkPerlinNoise_GetFrequency_05 (HandleRef pThis)
static internal void	vtkPerlinNoise_GetFrequency_06 (HandleRef pThis, IntPtr data)
static internal IntPtr	vtkPerlinNoise_GetPhase_07 (HandleRef pThis)
static internal void	vtkPerlinNoise_GetPhase_08 (HandleRef pThis, IntPtr data)
static internal int	vtkPerlinNoise_IsA_09 (HandleRef pThis, string type)
static internal int	vtkPerlinNoise_IsTypeOf_10 (string type)
static internal IntPtr	vtkPerlinNoise_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr	vtkPerlinNoise_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkPerlinNoise_SetAmplitude_14 (HandleRef pThis, double _arg)
static internal void	vtkPerlinNoise_SetFrequency_15 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void	vtkPerlinNoise_SetFrequency_16 (HandleRef pThis, IntPtr _arg)
static internal void	vtkPerlinNoise_SetPhase_17 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void	vtkPerlinNoise_SetPhase_18 (HandleRef pThis, IntPtr _arg)
Static Private Member Functions
static	vtkPerlinNoise ()
	Automatically generated type registration mechanics.

---

Detailed Description

vtkPerlinNoise - an implicit function that implements Perlin noise

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

---

Constructor & Destructor Documentation

static Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise

(

)

[static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

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

Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise

(

)

Description Instantiate the class.

---

Member Function Documentation

override void Kitware.VTK.vtkPerlinNoise.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.vtkImplicitFunction.

override double Kitware.VTK.vtkPerlinNoise.EvaluateFunction

(

IntPtr

x

)

[virtual]

Evaluate PerlinNoise function.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

new double Kitware.VTK.vtkPerlinNoise.EvaluateFunction	(	double	x,
		double	y,
		double	z
	)

Evaluate PerlinNoise function.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

override void Kitware.VTK.vtkPerlinNoise.EvaluateGradient	(	IntPtr	x,
		IntPtr	n
	)		[virtual]

Evaluate PerlinNoise gradient. Currently, the method returns a 0 gradient.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

virtual double Kitware.VTK.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.

virtual double [] Kitware.VTK.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.

virtual void Kitware.VTK.vtkPerlinNoise.GetFrequency

(

IntPtr

data

)

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

virtual double [] Kitware.VTK.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.

virtual void Kitware.VTK.vtkPerlinNoise.GetPhase

(

IntPtr

data

)

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

override int Kitware.VTK.vtkPerlinNoise.IsA

(

string

type

)

[virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new int Kitware.VTK.vtkPerlinNoise.IsTypeOf

(

string

type

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new vtkPerlinNoise Kitware.VTK.vtkPerlinNoise.New

(

)

[static]

Description Instantiate the class.

Reimplemented from Kitware.VTK.vtkObject.

new vtkPerlinNoise Kitware.VTK.vtkPerlinNoise.NewInstance

(

)

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new vtkPerlinNoise Kitware.VTK.vtkPerlinNoise.SafeDownCast

(

vtkObjectBase

o

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkPerlinNoise.SetAmplitude

(

double

_arg

)

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

virtual void Kitware.VTK.vtkPerlinNoise.SetFrequency	(	double	_arg1,
		double	_arg2,
		double	_arg3
	)		[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.

virtual void Kitware.VTK.vtkPerlinNoise.SetFrequency

(

IntPtr

_arg

)

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

virtual void Kitware.VTK.vtkPerlinNoise.SetPhase	(	double	_arg1,
		double	_arg2,
		double	_arg3
	)		[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.

virtual void Kitware.VTK.vtkPerlinNoise.SetPhase

(

IntPtr

_arg

)

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

static internal double Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_EvaluateFunction_01	(	HandleRef	pThis,
		IntPtr	x
	)		[private]

static internal double Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_EvaluateFunction_02	(	HandleRef	pThis,
		double	x,
		double	y,
		double	z
	)		[private]

static internal void Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_EvaluateGradient_03	(	HandleRef	pThis,
		IntPtr	x,
		IntPtr	n
	)		[private]

static internal double Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_GetAmplitude_04

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_GetFrequency_05

(

HandleRef

pThis

)

[private]

static internal void Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_GetFrequency_06	(	HandleRef	pThis,
		IntPtr	data
	)		[private]

static internal IntPtr Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_GetPhase_07

(

HandleRef

pThis

)

[private]

static internal void Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_GetPhase_08	(	HandleRef	pThis,
		IntPtr	data
	)		[private]

static internal int Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_IsA_09	(	HandleRef	pThis,
		string	type
	)		[private]

static internal int Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_IsTypeOf_10

(

string

type

)

[private]

static internal IntPtr Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_New	(	ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal IntPtr Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_NewInstance_12	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal IntPtr Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_SafeDownCast_13	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal void Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_SetAmplitude_14	(	HandleRef	pThis,
		double	_arg
	)		[private]

static internal void Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_SetFrequency_15	(	HandleRef	pThis,
		double	_arg1,
		double	_arg2,
		double	_arg3
	)		[private]

static internal void Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_SetFrequency_16	(	HandleRef	pThis,
		IntPtr	_arg
	)		[private]

static internal void Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_SetPhase_17	(	HandleRef	pThis,
		double	_arg1,
		double	_arg2,
		double	_arg3
	)		[private]

static internal void Kitware.VTK.vtkPerlinNoise.vtkPerlinNoise_SetPhase_18	(	HandleRef	pThis,
		IntPtr	_arg
	)		[private]

---

Member Data Documentation

new readonly string Kitware.VTK.vtkPerlinNoise.MRClassNameKey = "14vtkPerlinNoise" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

---

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

• csharp/vtkPerlinNoise.cs