Reference · Facts, line drawings and positions
PlacedItemtype
A body of a scene as the layout puts it: its place and size now (stored, or worked out by an automatic layout), and how far its picture reaches past the disc.
Import it
import type { PlacedItem } from "@johnmorrisdotca/wakusei-planets";Definition
interface Placed extends Item {
index: number;
reach: number;
}Members
| Name | Type | Description |
|---|---|---|
index | number | |
reach | number | How far the picture of the body reaches from its centre (rings, the Sun's glow), in scene units. |
body | BodyId | |
x | number | |
y | number | |
r | number | The radius, in scene units. |
spin | number | The longitude at the middle of the disc, degrees east (with a date: turned this much from the real one). |
tilt (optional) | number | undefined | The pole's lean on the page, degrees; the body's own tilt when left out. |
pitch (optional) | number | undefined | How far the viewer looks over the pole, degrees; the usual for the body when left out. |
turn | number | Degrees a second it turns by itself, eastward. |
Examples
import { addBody, defaultPortrait, layoutPortrait, type PlacedItem } from "@johnmorrisdotca/wakusei-planets";
const placed: PlacedItem[] = layoutPortrait(addBody(defaultPortrait(), "saturn")).placed;
console.log(placed[0]?.reach, placed[0]?.r);0.8417508417508418 0.3477788484205139What it prints (run when this page was built)