Skip to content

Topography API

Topography

Extends Effect.

Factory Function

typescript
createTopography(config?: TopographyConfig): Effect<TopographyConfig>

Methods

See Effect for the full method reference.


TopographyConfig

typescript
interface TopographyConfig {
    readonly speed?: number;
    readonly scale?: number;
    readonly resolution?: number;
    readonly contourSpacing?: number;
    readonly lineWidth?: number;
    readonly color?: string;
}
PropertyTypeDefaultDescription
speednumber0.5Speed of height field evolution.
scalenumber1Scales all sizes proportionally.
resolutionnumber4Pixel step size for the height field grid.
contourSpacingnumber0.1Spacing between contour levels (0–1).
lineWidthnumber1.5Width of contour lines in pixels.
colorstring'#2d5016'Color of the contour lines.