Table of Contents

Class GuiLayout

Namespace
OpenEphys.Miniscope.Gui
Assembly
OpenEphys.Miniscope.Gui.dll

Snapshot of the shared GUI layout state, threaded through the panel chain each render tick. Every panel reads the fields it needs and returns an updated copy, so cross-panel coordination happens through the dataflow graph rather than through mutable static state.

public record GuiLayout : IEquatable<GuiLayout>
Inheritance
GuiLayout
Implements
Inherited Members

Constructors

GuiLayout()

Creates a layout with the default state used to seed the workflow's Layout subject.

GuiLayout(bool, float, bool, bool, float, bool, float)

Snapshot of the shared GUI layout state, threaded through the panel chain each render tick. Every panel reads the fields it needs and returns an updated copy, so cross-panel coordination happens through the dataflow graph rather than through mutable static state.

Properties

ConsoleHeight

The dragged pixel height of the console.

ConsoleOpen

Whether the console is expanded (showing its log content and splitter) or collapsed to its header row.

ConsoleSplitterThickness

Thickness, in pixels, of the draggable splitter above the console. Scales with OpenEphys.Miniscope.Gui.UiScale.

ImageExpanded

Whether the image pane fills the entire data panel. When set, the settings sidebar and the console are both fully hidden and the image/signal splitter and signal pane are skipped.

ImageExpandedRequested

The Expand/Collapse button has been toggled, and on the next frame it will be drawn as toggled; this is to remove the one-frame lag that can cause visual flickering in the GUI by changing the ImageExpanded value halfway through the frame, leaving some panels drawn with and some without this value.

ImagePaneHeight

The dragged pixel height of the image pane inside DataPanel.

RecordingSectionHeight

The height, in pixels, that the Recording section's content occupied last frame.

SidebarOpen

Whether the settings sidebar is currently expanded (showing its full content) rather than collapsed to icon width.

Methods

ClampConsoleHeight(float, float)

Clamps height to a sane console height for the given windowHeight: never below the scaled minimum, never above a fraction of the window.

ReservedConsoleHeight(float)

Gets the total vertical space, in pixels, that panels above the console must leave free so the splitter and console fit beneath them. Zero while ImageExpanded is set (the console is fully hidden); just enough for the header row while ConsoleOpen is false.