allyhub scenery map
Draws a 3D scenery from above, the front and the side, orthographic: a grid, each named object's outline, name and front, the cameras and the moves; and each object's footprint on the floor
allyhub scenery map [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 written in JSON, drawn beside the scenery’s own: {“position”:[0,1.6,3],“target”:“crate”,“lens”:26} | |
--move |
list of string | The scenery’s named moves to draw (default every move) | |
--at |
number | 0 |
Scenery time to pose it at, s |
--from |
number | 0 |
Where the moves start being drawn, s |
--to |
number | 10 |
Where the moves stop being drawn, s |
--size |
string | "540x960" |
The frame the cameras’ frustums are drawn for, WIDTHxHEIGHT; its longer side is each view’s |
--views |
list of top, front, side |
["top","front","side"] |
The views |
--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 folder the views go in (default .allyhub/work/scenery) |
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 map roomallyhub scenery map room --move swing --times @turn=2 --to 4Exit 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