QtCraft API C++ classes QML types Handbook

QcRiverField::Sample Struct

struct QcRiverField::Sample

The river near one column. More...

Public Functions

bool inChannel() const

Public Variables

double depth
double distance
double halfWidth
double lineX
double lineZ
double nearDistance
double nearHalfWidth
double steepness
double strength
double value

Detailed Description

Member Function Documentation

bool Sample::inChannel() const

Returns whether the column lies in the water of the channel (before the terrain's rounding).

Member Variable Documentation

double Sample::depth

Depth of the water at the middle line below the water surface.

double Sample::distance

Blocks from the middle line of the nearest river, about (the noise over its slope); far away from rivers.

double Sample::halfWidth

Half the width of the water at this point of the river, 0 where none runs.

double Sample::nearDistance

Blocks from the middle line, estimated with the noise's bend as well as its slope: at most distance, close to it where the noise rises evenly, and growing by about a block per block also where the noise flattens (a shallow hill or hollow just past zero), where distance grows by several blocks per block (decision E-969). far where distance is.

double Sample::nearHalfWidth

halfWidth with the fading of small rings also where only nearDistance lies within reach (halfWidth has it only within reach of distance; decision E-969).

double Sample::steepness

How much steeper than usual the banks rise: 1 in low land, more in rugged land, where the river runs through a gorge.

double Sample::strength

How much of the valley is carved (0..1): 1 along the river, falling to 0 where the river ends in dry land or at a tight bend of its zero line.

double Sample::value

The river noise at the column (its zero line is the middle line of the rivers), wherever the river field was asked and the land is not dry; far elsewhere. The river deltas (decision E-850) read it to skip columns far from every river at once.