allyhub scenery view
Draws a 3D scenery from cameras at moments, each picture captioned with its camera in numbers
allyhub scenery view [item] [options]Arguments
Section titled “Arguments”| Argument | Type | What it is |
|---|---|---|
<item> |
string | The scenery: its id in allyhub.yaml, or its module’s file, listed or not |
Options
Section titled “Options”| Option | Type | Default | What it does |
|---|---|---|---|
--times |
list of string | Seconds of scenery time for the word and anchor references the scenery’s moves and its update (w.time) are timed by, as a video’s part gives them: @turn=3.2,@show=5.1 (@turn+0.2 is found from @turn); over –piece’s | |
--piece |
string | The video whose scenery layers give those times (default, when one is needed and –times gives none: the one video of the project that draws this scenery) | |
--camera |
list of string or object | Cameras to look from: each a named camera of the scenery, or one written in JSON as a scenery’s code writes a CameraState: {“position”:[0,1.6,3],“target”:“crate”,“lens”:26}; its fields position, target, direction, yaw, pitch, up, roll, lens (default 26), lensFrame, fov, near (default 0.05), far (default 500), aperture, focus, ev | |
--move |
list of string | The scenery’s named moves to look from, at each moment | |
--around |
string | Frame this object from its sides, with fitCamera | |
--sides |
list of front, back, left, right, top, three-quarter |
["front","left","top","three-quarter"] |
With –around: the sides it is framed from; front is its own +Z, a glTF model’s front |
--at |
list of number | Moments of scenery time, s (default –from) | |
--every |
number | A moment every so many seconds over –from…–to | |
--from |
number | 0 |
Where –every starts, s |
--to |
number | Where –every ends, s | |
--size |
string | "540x960" |
Each picture’s pixels, WIDTHxHEIGHT |
--overlay |
boolean | false |
Draw over each picture the floor grid a metre apart, the axes, each named object’s box and its name with the share of it others hide |
--nested |
boolean | false |
Also each named object inside a model or group (default: only those with no named object above them, each with all it holds) |
--only |
list of string | The only objects drawn, by name (with what is under them) | |
--out |
string | The picture to write, a WebP (default .allyhub/work/scenery/<scenery>-view.webp) |
Global options
Section titled “Global options”--dir <value>: the project’s folder; default the one around where it is run. --json: print the result as JSON.
Output
Section titled “Output”With --json, the command prints an object with these fields:
| Field | Type | What it is |
|---|---|---|
file |
string |
Examples
Section titled “Examples”allyhub scenery view room --camera doorallyhub scenery view room --camera '{"position":[0,1.6,3],"target":"crate","lens":26}' --overlayallyhub scenery view room --around crateExit codes
Section titled “Exit codes”0 when it succeeds; the others are listed in Exit codes.
In the work
Section titled “In the work”3d: Building a 3D scenery and its cameras
add search → add → scenery → scenery view → scenery map → scenery see → scenery measure → scenery motion → scenery solve → scenery bake → inspect fidelity → dev