@bendyline/molen-ambient/client

Molen ambient-life capability: transport networks built from roads, rail and paths, with lane-following NPC cars, trains, aircraft and pedestrians spawned around an observer (kernel) and instanced rendering (client).

import { /* … */ } from '@bendyline/molen-ambient/client';

Classes

AmbientFigures

Constructors

Constructor

new AmbientFigures(prepare?): AmbientFigures;

Parameters

prepare?

(object) => void

Returns

AmbientFigures

Properties

group

readonly group: Group;

Accessors

count

Get Signature

get count(): number;

Returns

number

Methods

dispose()

dispose(): void;

Returns

void

setBudget()

setBudget(budget): void;

Parameters

budget

Partial<FigureBudget>

Returns

void

update()

update(
   walkers, 
   camera, 
   tick, 
   tickRate
): void;

Update every walker for this frame.

Parameters

walkers

readonly WalkerView[]

camera

readonly [number, number, number]

tick

number

tickRate

number

Returns

void

---

ProxyBatches

Constructors

Constructor

new ProxyBatches(prepare?, initialCapacity?): ProxyBatches;

Parameters

prepare?

(object) => void

initialCapacity?

number

Returns

ProxyBatches

Properties

group

readonly group: Group;

Accessors

meshCount

Get Signature

get meshCount(): number;

Number of instanced meshes (draw calls when all are populated).

Returns

number

Methods

add()

add(instance): void;

Parameters

instance

ProxyInstance

Returns

void

begin()

begin(camera): void;

Start a frame: keep the anchor within a few hundred metres of the camera.

Parameters

camera

readonly [number, number, number]

Returns

void

dispose()

dispose(): void;

Returns

void

end()

end(): number;

Finish a frame: upload what changed and cull empty batches from drawing.

Returns

number

Interfaces

AmbientAircraftModels

Methods

aircraft()

aircraft(type): AircraftSpec | undefined;

The aircraft spec (rotor and gear bindings) of a type, if it is an aircraft type.

Parameters

type

string

Returns

AircraftSpec | undefined

load()

load(type): Promise<Object3D<Object3DEventMap> | undefined>;

Parameters

type

string

Returns

Promise<Object3D<Object3DEventMap> | undefined>

---

AmbientRenderBudget

Properties

detailedCars

detailedCars: number;

Cars drawn with their full model at most.

figureRadius

figureRadius: number;

Pedestrians beyond this distance (m) are not drawn.

posesPerFrame

posesPerFrame: number;

Pedestrian pose evaluations per frame.

skinnedFigures

skinnedFigures: number;

Animated (skinned) pedestrians at most.

---

AmbientRenderer

Properties

object

readonly object: Group;

Methods

dispose()

dispose(): void;

Returns

void

setBudget()

setBudget(budget): void;

Parameters

budget

Partial<AmbientRenderBudget>

Returns

void

setVisible()

setVisible(visible): void;

Parameters

visible

boolean

Returns

void

stats()

stats(): AmbientRenderStats;

Returns

AmbientRenderStats

update()

update(camera, dt): void;

Draw the current world state; camera is the absolute camera position.

Parameters

camera

readonly [number, number, number]

dt

number

Returns

void

---

AmbientRendererOptions

Properties

aircraft?

optional aircraft?: AmbientAircraftModels;

Aircraft models (absent: proxies only).

budget?

optional budget?: Partial<AmbientRenderBudget>;

heights?

optional heights?: Readonly<Record<string, number>>;

Body heights by type id, for proxies (the kernel stores length and width only).

parent

parent: Object3D;

Parent in absolute world coordinates (e.g. the terrain stream object).

prepare?

optional prepare?: (object) => void | Promise<void>;

Shader warm-up for new objects (e.g. renderer.prepareObject).

Parameters

object

Object3D

Returns

void | Promise<void>

vehicles?

optional vehicles?: AmbientVehicleModels;

Full vehicle models for nearby cars (absent: proxies only).

world

world: World;

---

AmbientRenderStats

Properties

aircraft

aircraft: number;

cars

cars: number;

detailedCars

detailedCars: number;

drawBatches

drawBatches: number;

figures

figures: number;

pedestrians

pedestrians: number;

proxies

proxies: number;

trains

trains: number;

---

AmbientVehicleKindOptions

Properties

heights?

optional heights?: Readonly<Record<string, number>>;

Body heights by type id (default: from the shape).

---

AmbientVehicleModels

Where full vehicle models come from (absent: every car stays a proxy).

Methods

load()

load(type): Promise<Object3D<Object3DEventMap> | undefined>;

A fresh model instance for a type, or undefined when the type has no model.

Parameters

type

string

Returns

Promise<Object3D<Object3DEventMap> | undefined>

vehicle()

vehicle(type): VehicleData | undefined;

The vehicle data (wheel nodes, paint material, spec) of a type, if it is a vehicle type.

Parameters

type

string

Returns

VehicleData | undefined

---

DetailCandidate

Properties

color

color: string;

distance

distance: number;

id

id: string;

type

type: string;

---

FigureBudget

Properties

posesPerFrame

posesPerFrame: number;

Pose evaluations per frame (nearest first, the rest round-robin).

radius

radius: number;

Figures beyond this radius (m) are not drawn.

skinned

skinned: number;

Skinned (animated) figures at most.

---

ProxyDimensions

Properties

height

height: number;

length

length: number;

width

width: number;

---

ProxyInstance

Properties

color

color: Color;

dims

dims: ProxyDimensions;

pos

pos: readonly [number, number, number];

rot

rot: readonly [number, number, number, number];

scale

scale: number;

shape

shape: ProxyShape;

---

WalkerView

Properties

figure

figure: FigureData;

hidden

hidden: boolean;

id

id: string;

pos

pos: readonly [number, number, number];

rot

rot: readonly [number, number, number, number];

since

since: number;

speed

speed: number;

Type Aliases

ProxyShape

type ProxyShape = "car" | "bus" | "rail" | "aircraft";

Functions

ambientVehicleKind()

function ambientVehicleKind(options?): RenderableKind;

The ambient-vehicle renderable kind (proxy meshes) for Worker-hosted scenes.

Parameters

options?

AmbientVehicleKindOptions

Returns

RenderableKind

---

createAmbientRenderer()

function createAmbientRenderer(options): AmbientRenderer;

Parameters

options

AmbientRendererOptions

Returns

AmbientRenderer

---

proxyGeometry()

function proxyGeometry(shape, dims): BufferGeometry;

Cached geometry for a shape at given dimensions (rounded to 10 cm). Never dispose it.

Parameters

shape

ProxyShape

dims

ProxyDimensions

Returns

BufferGeometry

---

proxyHeight()

function proxyHeight(
   shape, 
   length, 
   width, 
   type
): number;

Default body height for a proxy when the type gives none.

Parameters

shape

ProxyShape

length

number

width

number

type

string

Returns

number

---

proxyShapeFor()

function proxyShapeFor(kind, length): ProxyShape;

The shape to draw for an agent kind and its dimensions.

Parameters

kind

string

length

number

Returns

ProxyShape