@bendyline/molen-worldgen-earth/kernel

Earth binding for Molen worldgen: terrain-semantics adapter, OSM label mapping, and lon/lat region atlas (kernel) with terrain tile renderers (client).

import { /* … */ } from '@bendyline/molen-worldgen-earth/kernel';

Interfaces

AtlasRegion

Properties

bbox?

optional bbox?: [number, number, number, number];

[minLon, minLat, maxLon, maxLat] in degrees; quick reject and sole geometry when no polygons.

bindings

bindings: AtlasRegionBindings;

id

id: string;

polygons?

optional polygons?: [number, number][][];

WGS84 outer rings (union, no holes, no antimeridian crossing).

priority

priority: number;

Higher wins where regions overlap.

title?

optional title?: string;

---

AtlasRegionBindings

Properties

buildings

buildings: StyleRule[];

Ordered style rules evaluated first for buildings inside the region.

default?

optional default?: string;

Archstyle used inside the region when no region rule matches (before pack rules).

scatter?

optional scatter?: string;

Scatter rule set for the region.

treeFillFactor?

optional treeFillFactor?: number;

Synthetic tree fill around low-rise homes, 0..1. Zero disables it; inherits atlas default.

---

BusinessCatalog

A business identity catalog, resolved against the landmark models its signs use.

Properties

doc

readonly doc: BusinessCatalogDoc;

hash

readonly hash: string;

Hash of the validated catalog; a cache key for generated tiles.

profiles

readonly profiles: readonly BusinessProfile[];

version

readonly version: number;

Methods

resolve()

resolve(poi): ResolvedBusiness | undefined;

Identify a mapped place, or undefined when it is not a business this catalog knows.

Parameters

poi

PoiIdentity

Returns

ResolvedBusiness | undefined

---

BusinessCatalogDoc

Properties

categories

categories: object[];

id

id: BusinessCategory;

kinds

kinds: string[];

landmark

landmark: string;

format

format: "molen/business-catalog@1";

profiles

profiles: object[];

aliases

aliases: string[];

brandIds

brandIds: string[];

categories

categories: string[];

id

id: string;

landmark

landmark: string;

version

version: number;

---

BusinessProfile

Properties

accent

accent: string;

aliases

aliases: readonly string[];

brandIds

brandIds: readonly string[];

categories

categories: readonly string[];

id

id: string;

sign

sign: string;

wall

wall: string;

---

HistoricalStructureAppearance

A dated reconstruction that is never eligible for the default current-world view.

Properties

currentWorldEligible

currentWorldEligible: false;

kind

kind: "historical";

representedDate?

optional representedDate?: string;

validFrom

validFrom: string;

Inclusive ISO calendar date.

validUntil

validUntil: string;

Exclusive ISO calendar date.

---

PlacesContent

Properties

businesses

readonly businesses: BusinessCatalog;

landmarks

readonly landmarks: LandmarkLibrary;

---

PlacesContentDocs

Places content as loaded documents; plain data, so it can be posted to a Worker.

Properties

businesses

businesses: unknown;

A molen/business-catalog@1 document.

landmarks

landmarks: LandmarkDocs;

---

ProjectedRegion

Properties

bounds

bounds: WorldBounds;

polygons

polygons: Vec2[][];

region

region: AtlasRegion;

---

RegionAtlasDefaults

Properties

buildings

buildings: StyleRule[];

scatter?

optional scatter?: string;

style?

optional style?: string;

treeFillFactor?

optional treeFillFactor?: number;

Synthetic residential tree fill, 0..1. Omitted means disabled in unclassified regions.

---

RegionAtlasDoc

Properties

default

default: RegionAtlasDefaults;

Worldwide fallback chain, evaluated after region bindings and before pack defaults.

doc?

optional doc?: string;

format

format: "molen/region-atlas@1";

id

id: string;

regions

regions: AtlasRegion[];

title

title: string;

version

version: number;

---

RegionResolver

Properties

atlas

readonly atlas: RegionAtlasDoc;

Methods

intersecting()

intersecting(bounds): AtlasRegion[];

Regions whose extent intersects a world rectangle.

Parameters

bounds

WorldBounds

Returns

AtlasRegion[]

resolve()

resolve(x, z): AtlasRegion | undefined;

Highest-priority region containing a world point (document order breaks ties).

Parameters

x

number

z

number

Returns

AtlasRegion | undefined

---

RegionResolverOptions

Properties

metersPerUnit

metersPerUnit: number;

cos(center latitude) factor the terrain package applies to Mercator meters.

---

ResolvedBusiness

Properties

accent

accent: string;

category

category: BusinessCategory;

matchedBy

matchedBy: "name" | "brand" | "brand-id" | "category";

profile?

optional profile?: BusinessProfile;

sharedWidth?

optional sharedWidth?: number;

sign

sign: string;

style?

optional style?: string;

width?

optional width?: number;

---

SemanticAdapterOptions

Extended by

• WorldgenTileInput

Properties

atlas?

optional atlas?: RegionAtlasDoc;

budgets?

optional budgets?: Partial<WorldgenBudgets>;

buffer?

optional buffer?: number;

Source clip buffer in tile units (default: the Protomaps basemap buffer).

features?

optional features?: object;

buildings?

optional buildings?: boolean;

interiors?

optional interiors?: boolean;

scatter?

optional scatter?: boolean;

keep?

optional keep?: number;

Extra keep multiplier on top of the scatter tiers (default 1).

pack

pack: ResolvedStylePack;

places?

optional places?: PlacesContent;

Landmarks and business identities for mapped places. Without them, mapped businesses are not recognized and street furniture is not placed.

regions?

optional regions?: RegionResolver;

tierOffset?

optional tierOffset?: number;

Added to the detail tier derived from the level (economy quality starts one tier lower).

---

SemanticBatch

Extends

• WorldgenBatchInput

Properties

budgets?

optional budgets?: Partial<WorldgenBudgets>;

Inherited from

WorldgenBatchInput.budgets

buildings

buildings: BuildingRequest[];

Inherited from

WorldgenBatchInput.buildings

clippedPieces

clippedPieces: number;

fallbackStyle?

optional fallbackStyle?: string;

Inherited from

WorldgenBatchInput.fallbackStyle

ground?

optional ground?: HeightSampler;

Inherited from

WorldgenBatchInput.ground

interiors?

optional interiors?: boolean;

Real ground-floor openings and lazy interior descriptors; needs the pack's interiors.

Inherited from

WorldgenBatchInput.interiors

pack

pack: ResolvedStylePack;

Inherited from

WorldgenBatchInput.pack

props?

optional props?: ModelPlacementRequest[];

Authored point placements, admitted before procedural scatter.

Inherited from

WorldgenBatchInput.props

regionId?

optional regionId?: string;

rules?

optional rules?: StyleRule[];

Rules evaluated before the pack defaults (e.g. from a world binding).

Inherited from

WorldgenBatchInput.rules

scatter?

optional scatter?: ScatterRequest;

Inherited from

WorldgenBatchInput.scatter

scatterId?

optional scatterId?: string;

Overrides

WorldgenBatchInput.scatterId

skippedByOwnership

skippedByOwnership: number;

Building polygons this tile skipped because a neighbour owns them.

tier?

optional tier?: number;

Detail tier for the batch (0 = full).

Inherited from

WorldgenBatchInput.tier

---

StructureCatalogDoc

Properties

entries

entries: StructurePlacement[];

format

format: "molen/structure-placements@1";

rules?

optional rules?: StructureMapRule[];

title

title: string;

---

StructureIndex

Properties

cells

readonly cells: ReadonlyMap<string, readonly StructurePlacement[]>;

entries

readonly entries: readonly StructurePlacement[];

rules

readonly rules: readonly StructureMapRule[];

Methods

query()

query(bounds, options?): StructurePlacement[];

Geographic rectangle [west, south, east, north].

Parameters

bounds

readonly [number, number, number, number]

options?

boolean | StructureQueryOptions

Returns

StructurePlacement[]

---

StructureMapRule

A deliberately reusable model. Never inferred from a unique landmark's category.

Properties

asset

asset: string;

dimensions

dimensions: [number, number, number];

Native model dimensions in meters, in +X,+Y,+Z order. Base must be Y=0.

fit?

optional fit?: "native" | "footprint";

id

id: string;

lengthAxis?

optional lengthAxis?: "x" | "z";

match

match: object;

All supplied fields must match; values within each array are alternatives.

classes?

optional classes?: string[];

subclasses?

optional subclasses?: string[];

tags?

optional tags?: Record<string, string[]>;

maxPerTile?

optional maxPerTile?: number;

minLevel?

optional minLevel?: number;

orientation?

optional orientation?: "direction" | "longest-edge" | "north";

replaceFootprint?

optional replaceFootprint?: boolean;

Also replace a nongeneralized building containing a matching point feature.

source

source: string;

title

title: string;

---

StructurePlacement

Properties

anchor

anchor: [number, number];

[longitude, latitude], at the intended model origin.

appearance?

optional appearance?: HistoricalStructureAppearance;

asset

asset: string;

bounds?

optional bounds?: [number, number, number, number];

WGS84 extent [west, south, east, north]. Extended models are clipped per resident tile.

datum?

optional datum?: "terrain" | "sea-level";

elevation?

optional elevation?: number;

Vertical offset from datum, in world meters (lake surfaces need not be sea level).

groundCutout?

optional groundCutout?: object;

Ground opening in native model X/Z metres; active only while this structure is visible.

basis

basis: string;

outline

outline: [number, number][];

heading?

optional heading?: number;

Rotation about +Y in radians, from the model's authored +Z front.

id

id: string;

lengthAxis?

optional lengthAxis?: "x" | "z";

Model horizontal axis aligned to the longest mapped edge (default +X).

mapIdentity?

optional mapIdentity?: object;

Optional confirmed map identity used to refine orientation from a nearby feature.

maxDistance?

optional maxDistance?: number;

names?

optional names?: string[];

wikidata?

optional wikidata?: string;

minLevel?

optional minLevel?: number;

The model enters adaptive terrain at this level.

note?

optional note?: string;

orientation?

optional orientation?: "fixed" | "mapped";

Fixed is the catalog heading; mapped follows a confirmed footprint or bridge axis.

replaceFootprint?

optional replaceFootprint?: boolean;

Only a contained, nongeneralized mapped footprint may be replaced.

replaceRoads?

optional replaceRoads?: object;

Suppress mapped bridge centerlines inside this model-local rectangle (meters).

deckHeight?

optional deckHeight?: number;

deckHeights?

optional deckHeights?: [number, number];

includeConnectedApproaches?

optional includeConnectedApproaches?: boolean;

length

length: number;

outline?

optional outline?: [number, number][];

width

width: number;

scale?

optional scale?: [number, number, number];

Multiplicative model scale; omitted means authored meters.

source

source: string;

status

status: "historical" | "preview" | "draft";

Draft records are never drawn; historical records require an explicit viewing date.

terrainReference?

optional terrainReference?: object;

Ground at another known site point; modelHeight is that point's native model Y in metres.

anchor

anchor: [number, number];

basis

basis: string;

modelHeight

modelHeight: number;

title

title: string;

---

StructureQueryOptions

Properties

includeDraft?

optional includeDraft?: boolean;

Inspection only: include every record regardless of status or date.

viewingDate?

optional viewingDate?: string;

Explicit ISO calendar date for historical models. Omitted means current-world previews.

---

StyleSuggestion

Properties

regionId?

optional regionId?: string;

variants

variants: object[];

share

share: number;

style

style: string;

weight

weight: number;

---

TileGeometry

Properties

level

level: number;

levelBelowMax

levelBelowMax: number;

0 at the finest level, 1 one level coarser, ...

metersPerUnit

metersPerUnit: number;

cos(center latitude) factor between projected units and world meters.

originX

originX: number;

World XZ of the tile corner (local (0, 0)).

originZ

originZ: number;

size

size: number;

Tile edge in world meters.

x

x: number;

z

z: number;

---

WorldgenTileInput

Extends

• SemanticAdapterOptions

Properties

atlas?

optional atlas?: RegionAtlasDoc;

Inherited from

SemanticAdapterOptions.atlas

budgets?

optional budgets?: Partial<WorldgenBudgets>;

Inherited from

SemanticAdapterOptions.budgets

buffer?

optional buffer?: number;

Source clip buffer in tile units (default: the Protomaps basemap buffer).

Inherited from

SemanticAdapterOptions.buffer

features?

optional features?: object;

buildings?

optional buildings?: boolean;

interiors?

optional interiors?: boolean;

scatter?

optional scatter?: boolean;

Inherited from

SemanticAdapterOptions.features

geom

geom: TileGeometry;

ground

ground: Pick<Heightfield, "sampleHeight" | "slopeAt" | "normalAt">;

World-space ground (a terrain heightfield); wrapped into tile-local meters.

keep?

optional keep?: number;

Extra keep multiplier on top of the scatter tiers (default 1).

Inherited from

SemanticAdapterOptions.keep

pack

pack: ResolvedStylePack;

Inherited from

SemanticAdapterOptions.pack

places?

optional places?: PlacesContent;

Landmarks and business identities for mapped places. Without them, mapped businesses are not recognized and street furniture is not placed.

Inherited from

SemanticAdapterOptions.places

regions?

optional regions?: RegionResolver;

Inherited from

SemanticAdapterOptions.regions

tierOffset?

optional tierOffset?: number;

Added to the detail tier derived from the level (economy quality starts one tier lower).

Inherited from

SemanticAdapterOptions.tierOffset

tile

tile: TerrainSemanticTile;

---

WorldgenTileOutput

Extends

• WorldgenBatchOutput

Properties

buildingCells?

optional buildingCells?: PreparedBuildingCell[];

Optional renderer preparation returned by the worker; source geometry remains canonical.

buildings?

optional buildings?: MeshBuffers;

Inherited from

WorldgenBatchOutput.buildings

clippedPieces

clippedPieces: number;

generationMs?

optional generationMs?: number;

hash

hash: string;

sha256 over every output array; equal hashes mean byte-identical output.

Inherited from

WorldgenBatchOutput.hash

placements

placements: PlacementSet[];

Inherited from

WorldgenBatchOutput.placements

preparationMs?

optional preparationMs?: number;

records

records: BuildingRecord[];

Inherited from

WorldgenBatchOutput.records

regionId?

optional regionId?: string;

scatterId?

optional scatterId?: string;

skippedByOwnership

skippedByOwnership: number;

stats

stats: WorldgenStats;

Inherited from

WorldgenBatchOutput.stats

---

WorldgenWorkerCancel

Properties

id

id: number;

kind

kind: "cancel";

---

WorldgenWorkerConfigure

Properties

atlas?

optional atlas?: RegionAtlasDoc;

kind

kind: "configure";

metersPerUnit

metersPerUnit: number;

pack

pack: ResolvedStylePack;

places?

optional places?: PlacesContentDocs;

Places content as documents; the worker builds the libraries (none when omitted).

---

WorldgenWorkerGenerate

Properties

budgets?

optional budgets?: Partial<WorldgenBudgets>;

features?

optional features?: object;

buildings?

optional buildings?: boolean;

interiors?

optional interiors?: boolean;

scatter?

optional scatter?: boolean;

geom

geom: TileGeometry;

ground

ground: HeightGrid;

Tile ground as a plain grid (transferable).

id

id: number;

kind

kind: "generate";

renderCellsOnly?

optional renderCellsOnly?: boolean;

tierOffset?

optional tierOffset?: number;

tile

tile: TerrainSemanticTile;

---

WorldgenWorkerHandler

Methods

handle()

handle(message): Promise<void>;

Handle one request; generation runs cooperatively and resolves when its result was posted.

Parameters

message

WorldgenWorkerRequest

Returns

Promise<void>

---

WorldgenWorkerPort

Methods

postMessage()

postMessage(message, transfer?): void;

Parameters

message

unknown

transfer?

Transferable[]

Returns

void

---

WorldgenWorkerResult

Properties

cancelled?

optional cancelled?: boolean;

error?

optional error?: string;

id

id: number;

kind

kind: "result";

output?

optional output?: WorldgenTileOutput;

Type Aliases

BusinessCategory

type BusinessCategory = 
  | "grocery"
  | "restaurant"
  | "cafe"
  | "pharmacy"
  | "shop"
  | "mall"
  | "department_store"
  | "outlet_mall"
  | "strip_mall";

---

EdgeDecision

type EdgeDecision = 
  | {
  mode: "whole";
}
  | {
  mode: "clipped";
  polygon: TerrainSemanticPolygon;
  seamEdges: number[];
}
  | {
  mode: "skip";
};

---

WorldBounds

type WorldBounds = [number, number, number, number];

---

WorldgenQualityPreset

type WorldgenQualityPreset = "economy" | "balanced" | "high";

---

WorldgenWorkerRequest

type WorldgenWorkerRequest = 
  | WorldgenWorkerConfigure
  | WorldgenWorkerGenerate
  | WorldgenWorkerCancel;

Variables

PROTOMAPS_TILE_BUFFER

const PROTOMAPS_TILE_BUFFER: number;

Protomaps basemap tiles carry a 64 / 4096 buffer.

---

REGION_ATLAS_EXAMPLE

const REGION_ATLAS_EXAMPLE: JsonValue;

Functions

analyzeTileEdge()

function analyzeTileEdge(polygon, buffer): EdgeDecision;

Decide whether this tile renders a footprint whole, clipped to the unit square, or not at all.

Parameters

polygon

TerrainSemanticPolygon

buffer

number

Returns

EdgeDecision

---

associateBusinesses()

function associateBusinesses(
   tile, 
   pieces, 
   catalog
): BuildingOccupants;

Parameters

tile

TerrainSemanticTile

pieces

readonly BuildingPiece[]

catalog

BusinessCatalog

Returns

BuildingOccupants

---

buildingClipBuffer()

function buildingClipBuffer(
   tile, 
   level, 
   buffer?
): number;

The clip buffer of a tile's building footprints. Footprints composed from a finer level (buildingSourceLevel, a building-detail sidecar) were cut at that level's buffer, which is 2^(source - tile level) times narrower in this tile's units.

Parameters

tile

buildingSourceLevel?

number

level

number

buffer?

number

Returns

number

---

buildingLabels()

function buildingLabels(feature): string[];

Specific building use when present; generic outline/part tags never override that use.

Parameters

feature

TerrainBuildingFeature

Returns

string[]

---

contextLabelAt()

function contextLabelAt(point, landcover): string | undefined;

Most specific mapped land use, then the smallest physical landcover polygon.

Parameters

point

TerrainSemanticPoint

landcover

readonly TerrainLandcoverFeature[]

Returns

string | undefined

---

createBusinessCatalog()

function createBusinessCatalog(doc, landmarks): BusinessCatalog;

Validate a molen/business-catalog@1 document against a landmark library.

Parameters

doc

unknown

landmarks

LandmarkLibrary

Returns

BusinessCatalog

---

createPlacesContent()

function createPlacesContent(docs): PlacesContent;

Validate places documents and build the libraries generation reads.

Parameters

docs

PlacesContentDocs

Returns

PlacesContent

---

createRegionResolver()

function createRegionResolver(atlas, options): RegionResolver;

Parameters

atlas

RegionAtlasDoc

options

RegionResolverOptions

Returns

RegionResolver

---

createStructureIndex()

function createStructureIndex(doc): StructureIndex;

Parameters

doc

StructureCatalogDoc

Returns

StructureIndex

---

createWorldgenWorkerHandler()

function createWorldgenWorkerHandler(port): WorldgenWorkerHandler;

Parameters

port

WorldgenWorkerPort

Returns

WorldgenWorkerHandler

---

encodeStructureGeohash()

function encodeStructureGeohash(
   longitude, 
   latitude, 
   length?
): string;

Standard geohash, kept here so the Earth pack does not depend on Qualla.

Parameters

longitude

number

latitude

number

length?

number

Returns

string

---

generateWorldgenTile()

function generateWorldgenTile(input): WorldgenTileOutput;

Parameters

input

WorldgenTileInput

Returns

WorldgenTileOutput

---

generateWorldgenTileSteps()

function generateWorldgenTileSteps(input, step?): Generator<WorldgenProgress, WorldgenTileOutput, void>;

Parameters

input

WorldgenTileInput

step?

number

Returns

Generator<WorldgenProgress, WorldgenTileOutput, void>

---

isHistoricalStructureAppearance()

function isHistoricalStructureAppearance(value): value is HistoricalStructureAppearance;

Parameters

value

unknown

Returns

value is HistoricalStructureAppearance

---

isStructureViewingDate()

function isStructureViewingDate(value): value is string;

Calendar-only ISO date validation without a clock, timezone, or Date dependency.

Parameters

value

unknown

Returns

value is string

---

landcoverAreaOf()

function landcoverAreaOf(tile, geom): number;

Total land polygon area in the tile, in m² (diagnostics).

Parameters

tile

TerrainSemanticTile

geom

TileGeometry

Returns

number

---

landcoverLabel()

function landcoverLabel(feature): string;

Land label for scatter rules: class plus subclass so word matching sees both.

Parameters

feature

TerrainLandcoverFeature

Returns

string

---

mappedPropExclusions()

function mappedPropExclusions(tile, size): ScatterExclusion[];

Exclude around mapped crowns (including neighbors' buffered records) before scattering.

Parameters

tile

TerrainSemanticTile

size

number

Returns

ScatterExclusion[]

---

mappedPropRequests()

function mappedPropRequests(
   tile, 
   geom, 
   trees, 
   furniture
): ModelPlacementRequest[];

Mapped trees (when trees) and street furniture. Furniture is placed only for landmark models the furniture library holds; pass undefined for none.

Parameters

tile

TerrainSemanticTile

geom

TileGeometry

trees

boolean

furniture

Pick<LandmarkLibrary, "get"> | undefined

Returns

ModelPlacementRequest[]

---

matchMapStructures()

function matchMapStructures(
   tile, 
   geometry, 
   rules, 
   geographic?, 
   maxPerTile?
): StructurePlacement[];

Emit at most 64 category structures per resident tile. Rule order defines preference.

Parameters

tile

TerrainSemanticTile

geometry

TileGeometry

rules

readonly StructureMapRule[]

geographic?

readonly StructurePlacement[]

maxPerTile?

number

Returns

StructurePlacement[]

---

orientMappedStructure()

function orientMappedStructure(
   entry, 
   tile, 
   geometry
): StructurePlacement | undefined;

Resolve a named landmark only against its explicit identity, never category similarity.

Parameters

entry

StructurePlacement

tile

TerrainSemanticTile

geometry

TileGeometry

Returns

StructurePlacement | undefined

---

regionScatterId()

function regionScatterId(atlas, region): string | undefined;

Scatter rule set id for a region, falling back to the atlas default (may be undefined).

Parameters

atlas

RegionAtlasDoc

region

AtlasRegion | undefined

Returns

string | undefined

---

regionStyleRules()

function regionStyleRules(atlas, region): StyleRule[];

The ordered rule chain for a region: region rules, region default, atlas rules, atlas default.

Parameters

atlas

RegionAtlasDoc

region

AtlasRegion | undefined

Returns

StyleRule[]

---

registerBusinessCatalogSchema()

function registerBusinessCatalogSchema(): void;

Returns

void

---

registerRegionAtlasSchema()

function registerRegionAtlasSchema(): void;

Returns

void

---

registerStructurePlacementsSchema()

function registerStructurePlacementsSchema(): void;

Returns

void

---

scatterRequestFromTile()

function scatterRequestFromTile(
   tile, 
   geom, 
   avoid, 
   keep
): ScatterRequest;

Build the scatter request: land polygons with labels plus road, water, and building exclusions.

Parameters

tile

TerrainSemanticTile

geom

TileGeometry

avoid

buildings

number

roads

number

water

number

keep

number

Returns

ScatterRequest

---

semanticTileToBatch()

function semanticTileToBatch(
   tile, 
   geom, 
   options
): SemanticBatch;

Turn a semantic tile into a batch input (without ground; the caller supplies the sampler).

Parameters

tile

TerrainSemanticTile

geom

TileGeometry

options

SemanticAdapterOptions

Returns

SemanticBatch

---

suggestStructureStyles()

function suggestStructureStyles(
   atlas, 
   longitude, 
   latitude, 
   metrics
): StyleSuggestion | undefined;

Inspect the same ordered atlas rules used by generation, without choosing a random variant.

Parameters

atlas

RegionAtlasDoc

longitude

number

latitude

number

metrics

BuildingMetrics

Returns

StyleSuggestion | undefined

---

tileGroundSampler()

function tileGroundSampler(ground, geom): HeightSampler;

Tile-local sampler over a world-space heightfield.

Parameters

ground

Pick<Heightfield, "sampleHeight" | "slopeAt" | "normalAt">

geom

TileGeometry

Returns

HeightSampler

---

validateBusinessCatalogDocuments()

function validateBusinessCatalogDocuments(data, definitions): BusinessCatalogDoc;

Validate a catalog and check that every sign it names is a sign in definitions.

Parameters

data

unknown

definitions

LandmarkDefinitions

Returns

BusinessCatalogDoc

---

validateRegionAtlas()

function validateRegionAtlas(data): ValidationIssue[];

Parameters

data

unknown

Returns

ValidationIssue[]

---

worldgenBuildingCellSize()

function worldgenBuildingCellSize(levelBelowMax): number;

Edge of the spatial cells a tile's buildings are batched into, meters. Each cell is a draw (per material group up close), so the coarser levels, which cover four or sixteen times the ground and only switch detail far from the camera, use cells four times the area.

Parameters

levelBelowMax

number

Returns

number

---

worldgenTileBudgetForQuality()

function worldgenTileBudgetForQuality(quality, levelBelowMax): WorldgenBudgets;

Per-tile budgets by quality and detail level. The finest level keeps every building: the largest get full detail, the rest a simplified facade (a row of windows per floor), then walls and roof alone, then an instanced stand-in once vertices run out. The level below it, which covers four times the ground, draws a few hundred simplified buildings and stands in the rest (pitched buildings as gabled boxes, so a neighbourhood seen from the air still reads as roofs). Coarser levels carry no buildings at all (the human-feature layer is level-bounded). Scatter shrinks with the level (see SCATTER_INSTANCES) and stops three levels below the finest.

The counts are sized for real footprints: a zoom-15 suburb has 800-1,600 houses per zoom-14 tile, and a downtown about 1,700 footprints and parts.

Parameters

quality

WorldgenQualityPreset

levelBelowMax

number

Returns

WorldgenBudgets