Zn_SpotNoise — C# API

Specialization of cellular noise intented for cheap "ore patch" generation or deterministic point scattering.

class Zn_SpotNoiseReckfellSharpInherits Resource

Specialization of cellular noise intented for cheap "ore patch" generation or deterministic point scattering.

Divides space into a grid where each cell contains a circular "spot". Noise evaluation returns 1 when the position is inside a spot, 0 otherwise. Limitation: high jitter can make spots clip with cell borders. This is expected. If you need higher quality (but slower) results, you may use another noise library such as FastNoiseLite.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

Zn_SpotNoiseConstructor

# Zn_SpotNoise

C#
public Zn_SpotNoise();

Properties4

CellSizeProperty

# CellSize

C#
public float CellSize { get; set; }

JitterProperty

# Jitter

C#
public float Jitter { get; set; }

SeedProperty

# Seed

C#
public int Seed { get; set; }

SpotRadiusProperty

# SpotRadius

C#
public float SpotRadius { get; set; }

Methods14

GetCellSizefloat

# GetCellSize

C#
public float GetCellSize();

Returns float

GetJitterfloat

# GetJitter

C#
public float GetJitter();

Returns float

GetNoise2Dfloat

# GetNoise2D

C#
public float GetNoise2D(float x, float y);

Parameters
Name	Type	Default
`x`	`float`	—
`y`	`float`	—

Returns float

GetNoise2Dvfloat

# GetNoise2Dv

C#
public float GetNoise2Dv(Vector2 pos);

Parameters
Name	Type	Default
`pos`	`Vector2`	—

Returns float

GetNoise3Dfloat

# GetNoise3D

C#
public float GetNoise3D(float x, float y, float z);

Parameters
Name	Type	Default
`x`	`float`	—
`y`	`float`	—
`z`	`float`	—

Returns float

GetNoise3Dvfloat

# GetNoise3Dv

C#
public float GetNoise3Dv(Vector3 pos);

Parameters
Name	Type	Default
`pos`	`Vector3`	—

Returns float

GetSeedint

# GetSeed

C#
public int GetSeed();

Returns int

GetSpotPositionsInArea2DVector2[]

# GetSpotPositionsInArea2D

C#
public Vector2[] GetSpotPositionsInArea2D(Rect2 rect);

Parameters
Name	Type	Default
`rect`	`Rect2`	—

Returns Vector2[]

GetSpotPositionsInArea3DVector3[]

# GetSpotPositionsInArea3D

C#
public Vector3[] GetSpotPositionsInArea3D(Aabb aabb);

Parameters
Name	Type	Default
`aabb`	`Aabb`	—

Returns Vector3[]

GetSpotRadiusfloat

# GetSpotRadius

C#
public float GetSpotRadius();

Returns float

SetCellSizevoid

# SetCellSize

C#
public void SetCellSize(float cellSize);

Parameters
Name	Type	Default
`cellSize`	`float`	—

SetJittervoid

# SetJitter

C#
public void SetJitter(float jitter);

Parameters
Name	Type	Default
`jitter`	`float`	—

SetSeedvoid

# SetSeed

C#
public void SetSeed(int seed);

Parameters
Name	Type	Default
`seed`	`int`	—

SetSpotRadiusvoid

# SetSpotRadius

C#
public void SetSpotRadius(float radius);

Parameters
Name	Type	Default
`radius`	`float`	—