# allyhub scenery measure

> Measures a 3D scenery's geometry: surfaces, contacts, gaps and what rests on what; line of sight, clear space and free floor when asked

Source: https://allyhub.com/docs/reference/cli/scenery-measure · AllyHub 0.10.0
Index of all docs: https://allyhub.com/llms.txt

## Usage

```bash
allyhub scenery measure [item] [options]
```

## Arguments

| Argument | Type | What it is |
| --- | --- | --- |
| `<item>` | string | The scenery: its id in allyhub.yaml, or its module's file, listed or not |

## 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) |
| `--at` | number | `0` | Scenery time to pose it at, s |
| `--only` | list of string |  | The only named objects measured (default every named object with no named object above it; the rest still stand under them for support) |
| `--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) |
| `--between` | list of string |  | One pair measured whatever the distance: two names |
| `--all` | boolean | `false` | Every pair, however far apart |
| `--sight` | list of string |  | Line of sight between two objects: two names |
| `--clear` | string |  | How far is clear ahead of this object, along its own +Z |
| `--floor` | string |  | The free floor on this object |
| `--floor-from` | string |  | With --floor: what the connected floor starts from (default the largest free area) |

## Parameters

Each is given as `--param name=value`.

| Name | Type | Default | What it does |
| --- | --- | --- | --- |
| `radius` | number | `0.3` | With --floor: the free floor keeps so far from anything standing, m |

## Global options

`--dir <value>`: the project's folder; default the one around where it is run. `--json`: print the result as JSON.

## Output

With `--json`, the command prints an object with these fields:

| Field | Type | What it is |
| --- | --- | --- |
| `file` | string |  |

## Examples

```bash
allyhub scenery measure room
allyhub scenery measure room --between crate,floor
allyhub scenery measure room --floor floor
```

## Exit codes

`0` when it succeeds; the others are listed in [Exit codes](https://allyhub.com/docs/reference/cli/exit-codes.md).

## In the work

**3d**: Building a 3D scenery and its cameras

[`add search`](https://allyhub.com/docs/reference/cli/add-search.md) → [`add`](https://allyhub.com/docs/reference/cli/add.md) → [`scenery`](https://allyhub.com/docs/reference/cli/scenery.md) → [`scenery view`](https://allyhub.com/docs/reference/cli/scenery-view.md) → [`scenery map`](https://allyhub.com/docs/reference/cli/scenery-map.md) → [`scenery see`](https://allyhub.com/docs/reference/cli/scenery-see.md) → `scenery measure` → [`scenery motion`](https://allyhub.com/docs/reference/cli/scenery-motion.md) → [`scenery solve`](https://allyhub.com/docs/reference/cli/scenery-solve.md) → [`scenery bake`](https://allyhub.com/docs/reference/cli/scenery-bake.md) → [`inspect fidelity`](https://allyhub.com/docs/reference/cli/inspect-fidelity.md) → [`dev`](https://allyhub.com/docs/reference/cli/dev.md)
