frameShot

frameShot(surface, camera, aspect): MapView

Defined in: packages/engine/src/gameplay/map/frameShot.ts:204

The camera a shot looks through, framed from the map’s data and the ground with no render: a raw view as written, or one that fits its subject from its angle, at the aspect the shot is taken at. A scene with no map, as a track game’s, passes the box it draws instead, and all frames that box. Throws on a subject the map has not got.

Parameters

Parameter	Type
surface	Readonly<{ getNormalAt: (position, target) => Vector3; map: Readonly<{ cell: number; hills: Readonly<{ amplitude: number; detail: number; wavelength: number; }>; paths: Readonly<Record<string, Readonly<{ fade: number; halfWidth: number; points: readonly readonly […, …][]; surface?: "dirt" | "stone" | "sand"; }>>>; props: Readonly<Record<string, Readonly<{ color: string; kind: PropShape; position: … | …; scale: … | …; size: readonly […, …, …]; yaw: number; }> | Readonly<{ kind: ScatterKind; position: … | …; scale: number; yaw: number; }> | Readonly<{ model: string; position: … | …; scale: … | …; yaw: number; }>>>; regions: Readonly<Record<string, Readonly<{ center: readonly [number, number]; fade: number; hills: Readonly<{ amplitude: …; detail: …; wavelength: …; }>; radius: number; scatter: Readonly<{ bushRound: …; clearing: …; grassTuft: …; rockBoulder: …; rockFlat: …; seedOffset: …; treeRound: …; treeTall: …; }>; }>>>; rim: number; scatter: Readonly<{ bushRound: number; grassTuft: number; rockBoulder: number; rockFlat: number; seedOffset: number; treeRound: number; treeTall: number; }>; seed: number; size: number; views: Readonly<Record<string, Readonly<{ eye: readonly [number, number, number]; fov: number; ortho?: number; target: readonly [number, number, number]; }>>>; }>; seed: number; segments: number; size: number; getHeightAt: number; getPathDistanceAt: number; getPathSurfaceAt: { surface: NonNullable<"dirt" | "stone" | "sand" | undefined>; weight: number; } | undefined; getRegionWeightsAt: number[]; getSlopeAt: number; }> | Box3
camera	Readonly<{ eye: readonly number[]; fov?: number; ortho?: number; target: readonly number[]; }> | { angle?: Top | Bottom | Front | Back | Left | Right | Iso | { azimuth: number; elevation: number; }; around?: string | readonly number[] | readonly number[][]; ortho?: boolean; zoom?: number; }
aspect	number

Returns

MapView