View functions¶
/view/* (ch16) controls model view, selection, and capture — the same
"Argument"-wrapped, one-TypedDict-parameter convention as
midas_nx.ope.
midas_nx.view
¶
/view/* — model view control (selection, capture, viewpoint, active
target, display options, result graphics); these settings control the
on-screen model view and are not persisted to the DB.
Source: docs/manual/16_VIEW.md, items 1-7. Bodies are wrapped in an
"Argument" key like doc.py (not ID-keyed "Assign" like db/*.py), but
/view/DISPLAY and /view/RESULTGRAPHIC have very deeply-nested bodies
(dozens of nested objects/booleans), so — unlike doc.py's few-named-kwargs
style — every endpoint here (except the GET-only /view/SELECT) takes one
TypedDict argument that documents the endpoint's full body shape, with large
sub-groups factored into their own nested TypedDict classes (mirrors
db/pushover.py's Hyper-S nested-object style).
Documentation quirks preserved from the manual (not silently "fixed" — see
inline comments at point of use for details):
- /view/DISPLAY: MISC.GRID_MODEL_LOAD_LINE is missing from the raw
JSON Schema but present in the Specifications table and worked example, so
it is included. The raw schema/example key VIEWPPORT_GIZMO is a
documented typo; the real key VIEWPORT_GIZMO is used.
- /view/RESULTGRAPHIC: TYPE_OF_DISPLAY.CONTOUR.COLOR_TYPE's enum
differs between the JSON Schema (vrgb/rgb/brg/grayscaled)
and the Specifications table (vrgb/rgb/rbg/gray scaled);
we type it as str (not a Literal) so both variants remain usable, and
document the discrepancy on the field.
- /view/CAPTURE: the Parameters table lists PERSPECTIVE/
ZOOM_LEVEL/BGCOLOR_TOP/BGCOLOR_BOTTOM as top-level Argument
keys, but the worked example nests them inside DISPLAY instead — both
are documented on the field below.