Summary of a single MxN cell exposed via the REST window list. More...
#include <mitkRenderWindowBridge.h>
Public Attributes | |
| std::string | id |
| std::optional< std::string > | displayName |
| WindowKind | kind |
| std::optional< AnatomicalPlane > | viewDirection |
| std::string | selectionGroup |
Detailed Description
Summary of a single MxN cell exposed via the REST window list.
Carries the per-cell layout-document fields that REST clients need without forcing them to fetch the full layout: identity (id), optional display label, kind ("2d" / "3d"), v2 view direction, and selection-group label.
Distinct from WindowInfo because MxN cells carry persisted layout state (viewDirection, selectionGroup) that does not apply to StdMulti windows. Future v3 dimensions add fields here additively.
Identity vs. display label: id mirrors the v2 schema's required id field – the canonical fully-qualified window name (<editor_name>__<bare>), URL-segment-safe, unique within the layout document, used verbatim as the URL path segment for sub-resources. displayName mirrors the optional name field – a free-form human-readable label, std::nullopt when absent.
viewDirection mirrors the v2 view_direction field. Under v2 every MxN cell is 2D and the layout schema requires a value drawn from the closed enum {axial, sagittal, coronal, original}, so the optional always carries a value in v2. The std::optional wrapper is reserved purely for forward-compatibility with v3, which will introduce 3D cells (kind == ThreeD) for which no anatomical plane applies.
Definition at line 211 of file mitkRenderWindowBridge.h.
Member Data Documentation
◆ displayName
| std::optional<std::string> mitk::MxNWindowInfo::displayName |
Definition at line 214 of file mitkRenderWindowBridge.h.
◆ id
| std::string mitk::MxNWindowInfo::id |
Definition at line 213 of file mitkRenderWindowBridge.h.
◆ kind
| WindowKind mitk::MxNWindowInfo::kind |
Definition at line 215 of file mitkRenderWindowBridge.h.
◆ selectionGroup
| std::string mitk::MxNWindowInfo::selectionGroup |
Definition at line 217 of file mitkRenderWindowBridge.h.
◆ viewDirection
| std::optional<AnatomicalPlane> mitk::MxNWindowInfo::viewDirection |
Definition at line 216 of file mitkRenderWindowBridge.h.
The documentation for this struct was generated from the following file:
