raisim::TerrainProperties

struct · #include <raisim/Terrain.hpp>

Parameters of a fractal Perlin-noise terrain (see TerrainGenerator and World::addHeightMap()).

Constructors & destructor

TerrainProperties

TerrainProperties() = default

TerrainProperties(
    double frequency,
    double xSize,
    double ySize,
    double zScale,
    size_t xSamples,
    size_t ySamples,
    size_t fractalOctaves,
    double fractalLacunarity,
    double fractalGain,
    double stepSize,
    double heightOffset,
    std::uint32_t seed)

Sets every field; see the field descriptions.

Parameters

Parameter	Description
frequency (in)	noise frequency
xSize (in)	terrain size in x (m)
ySize (in)	terrain size in y (m)
zScale (in)	height scale (m)
xSamples (in)	number of samples in x
ySamples (in)	number of samples in y
fractalOctaves (in)	number of octaves
fractalLacunarity (in)	frequency multiplier per octave
fractalGain (in)	amplitude multiplier per octave
stepSize (in)	quantization step (m); 0 disables
heightOffset (in)	height offset (m)
seed (in)	noise seed

Public attributes

frequency

double frequency

Base noise frequency (noise lattice cycles per meter).

xSize

double xSize

Terrain size in x direction (meters).

ySize

double ySize

Terrain size in y direction (meters).

zScale

double zScale

Height scale multiplier (m). The normalized noise, roughly in [0, 1], is multiplied by it.

fractalLacunarity

double fractalLacunarity

Fractal lacunarity (frequency multiplier).

fractalGain

double fractalGain

Fractal gain (amplitude multiplier).

stepSize

double stepSize

Quantization step size for stair-like terrain (m; 0 disables). Heights are floored to multiples of it.

heightOffset

double heightOffset

Constant height offset added to all samples (m), after quantization.

fractalOctaves

size_t fractalOctaves

Number of fractal octaves, in [1, 64].

xSamples

size_t xSamples

Number of samples in x direction.

ySamples

size_t ySamples

Number of samples in y direction.

seed

std::uint32_t seed

Seed for the noise generator.