Skip to main content
Version: dev-latest

Focus

Purpose​

  • Create a plex in which all components are spatially connected to only one "focus" component, i.e. a "hub-and-spoke" plex.

Usage​

metrical shape focus [OPTIONS] --component <COMPONENT> <PLEX_OR_RESULTS_PATH> <OUTPUT_DIR>

Concepts​

This Shape command creates a plex in which all components are spatially connected to only one origin component/object space ID. In other words, one component acts as a "focus", with spatial constraints to all other components.

Notice that this mode will compose two or more spatial constraints to achieve the optimal "path" between two components in space.

An illustration of a plex created through Focus mode

Examples​

Create a plex focused around component ir_one​

metrical shape focus --component ir_one $RESULTS $OUTPUT_DIR

Arguments​

[PLEX_OR_RESULTS_PATH]​

The path to the input plex. This can be a MetriCal results JSON or a plex JSON.

[OUTPUT_DIR]​

The output directory for this shaping operation.

Options​

Universal Options​

As with every mode, all universal options are supported (though not all may be used).

-a, --component [COMPONENT]​

The component around which this plex is focused.