Theme-aware sizing helpers for consistent UI layout. More...

#include <layout_helpers.h>

Classes
struct	SafeAreaInsets

struct	WindowClampResult

Static Public Member Functions
static float	GetStandardWidgetHeight ()

static float	GetStandardSpacing ()

static float	GetToolbarHeight ()

static float	GetPanelPadding ()

static float	GetStandardInputWidth ()

static float	GetHexInputWidth ()

static float	GetComboWidth ()

static float	GetSliderWidth ()

static float	GetCompactInputWidth ()

static float	GetButtonPadding ()

static float	GetTableRowHeight ()

static float	GetCanvasToolbarHeight ()

static void	BeginPaddedPanel (const char *label, float padding=-1.0f)

static void	EndPaddedPanel ()

static bool	BeginTableWithTheming (const char *str_id, int columns, ImGuiTableFlags flags=0, const ImVec2 &outer_size=ImVec2(0, 0), float inner_width=0.0f)

static void	EndTableWithTheming ()

static void	EndTable ()

static void	BeginCanvasPanel (const char label, ImVec2 canvas_size=nullptr)

static void	EndCanvasPanel ()

static bool	BeginContentChild (const char *id, const ImVec2 &min_size, bool border=false, ImGuiWindowFlags flags=0)

static void	EndContentChild ()

static bool	AutoSizedInputField (const char label, char buf, size_t buf_size, ImGuiInputTextFlags flags=0)

static bool	AutoSizedInputInt (const char label, int v, int step=1, int step_fast=100, ImGuiInputTextFlags flags=0)

static bool	AutoSizedInputFloat (const char label, float v, float step=0.0f, float step_fast=0.0f, const char *format="%.3f", ImGuiInputTextFlags flags=0)

static bool	InputHexRow (const char label, uint8_t data)

static bool	InputHexRow (const char label, uint16_t data)

static void	BeginPropertyGrid (const char *label)

static void	EndPropertyGrid ()

static bool	InputToolbarField (const char label, char buf, size_t buf_size)

static void	BeginToolbar (const char *label)

static void	EndToolbar ()

static void	ToolbarSeparator ()

static bool	ToolbarButton (const char *label, const ImVec2 &size=ImVec2(0, 0))

static void	PropertyRow (const char *label, std::function< void()> widget_callback)

static void	SectionHeader (const char *label)

static void	HelpMarker (const char *desc)

static SafeAreaInsets	GetSafeAreaInsets ()

static float	GetTopInset ()

static bool	IsTouchDevice ()

static float	GetMinTouchTarget ()

static float	GetTouchSafeWidgetHeight ()

static WindowClampResult	ClampWindowToRect (const ImVec2 &pos, const ImVec2 &size, const ImVec2 &rect_pos, const ImVec2 &rect_size, float min_visible=32.0f)

static const Theme &	GetTheme ()

Static Private Member Functions
static float	GetBaseFontSize ()

static float	ApplyCompactFactor (float base_value)

Detailed Description

Theme-aware sizing helpers for consistent UI layout.

All sizing functions respect the current theme's compact_factor and semantic multipliers, ensuring layouts are consistent but customizable.

Definition at line 19 of file layout_helpers.h.

Member Function Documentation

◆ GetStandardWidgetHeight()

float yaze::gui::LayoutHelpers::GetStandardWidgetHeight ( )

static

Definition at line 26 of file layout_helpers.cc.

References GetBaseFontSize(), and GetTheme().

Referenced by yaze::editor::DungeonWorkbenchToolbar::Draw(), yaze::editor::ActivityBar::DrawPanelBrowser(), yaze::editor::ActivityBar::DrawSidePanel(), and GetTouchSafeWidgetHeight().

Here is the call graph for this function:

◆ GetStandardSpacing()

float yaze::gui::LayoutHelpers::GetStandardSpacing ( )

static

Definition at line 32 of file layout_helpers.cc.

References GetBaseFontSize(), and GetTheme().

Referenced by yaze::gui::plotting::anonymous_namespace{implot_support.cc}::BuildBaseStyle(), yaze::editor::DungeonCanvasViewer::DrawCompactLayerToggles(), yaze::editor::MapPropertiesSystem::DrawGraphicsPopup(), yaze::editor::MapPropertiesSystem::DrawPalettesPopup(), yaze::editor::MapPropertiesSystem::DrawPropertiesPopup(), yaze::editor::MapPropertiesSystem::DrawQuickAccessPopup(), yaze::editor::ActivityBar::DrawSidePanel(), yaze::editor::MapPropertiesSystem::DrawViewPopup(), yaze::gui::plotting::anonymous_namespace{implot_support.cc}::ScaledSpacing(), and ToolbarSeparator().

Here is the call graph for this function:

◆ GetToolbarHeight()

float yaze::gui::LayoutHelpers::GetToolbarHeight ( )

static

Definition at line 38 of file layout_helpers.cc.

References GetBaseFontSize(), and GetTheme().

Referenced by BeginToolbar().

Here is the call graph for this function:

◆ GetPanelPadding()

float yaze::gui::LayoutHelpers::GetPanelPadding ( )

static

Definition at line 44 of file layout_helpers.cc.

References GetBaseFontSize(), and GetTheme().

Referenced by BeginPaddedPanel(), and EndPaddedPanel().

Here is the call graph for this function:

◆ GetStandardInputWidth()

float yaze::gui::LayoutHelpers::GetStandardInputWidth ( )

static

Definition at line 50 of file layout_helpers.cc.

References GetBaseFontSize(), and GetTheme().

Referenced by AutoSizedInputField(), AutoSizedInputFloat(), AutoSizedInputInt(), BeginPropertyGrid(), yaze::editor::PolyhedralEditorPanel::Draw(), yaze::editor::PaletteControlsPanel::DrawPaletteGroupSelector(), yaze::editor::PaletteGroupPanel::DrawPaletteSelector(), yaze::editor::PolyhedralEditorPanel::DrawVertexList(), InputToolbarField(), and yaze::editor::PolyhedralEditorPanel::Update().

Here is the call graph for this function:

◆ GetHexInputWidth()

float yaze::gui::LayoutHelpers::GetHexInputWidth ( )

static

Definition at line 56 of file layout_helpers.cc.

References yaze::gui::Theme::compact_factor, GetBaseFontSize(), and GetTheme().

Referenced by yaze::editor::GfxGroupEditor::DrawPaletteControls(), yaze::editor::SheetBrowserPanel::DrawSearchBar(), InputHexRow(), and InputHexRow().

Here is the call graph for this function:

◆ GetComboWidth()

float yaze::gui::LayoutHelpers::GetComboWidth ( )

static

Definition at line 60 of file layout_helpers.cc.

References yaze::gui::Theme::compact_factor, GetBaseFontSize(), GetTheme(), and yaze::gui::Theme::input_width_multiplier.

Referenced by yaze::editor::GfxGroupEditor::DrawPaletteControls(), yaze::editor::PaletteControlsPanel::DrawPaletteGroupSelector(), yaze::editor::LinkSpritePanel::DrawPaletteSelector(), and yaze::editor::PolyhedralEditorPanel::DrawPreview().

Here is the call graph for this function:

◆ GetSliderWidth()

float yaze::gui::LayoutHelpers::GetSliderWidth ( )

static

Definition at line 65 of file layout_helpers.cc.

References yaze::gui::Theme::compact_factor, GetBaseFontSize(), GetTheme(), and yaze::gui::Theme::input_width_multiplier.

Referenced by yaze::editor::SheetBrowserPanel::DrawBatchOperations(), yaze::editor::GfxGroupEditor::DrawBlocksetViewer(), yaze::editor::GfxGroupEditor::DrawPaletteControls(), yaze::editor::PolyhedralEditorPanel::DrawPreview(), yaze::editor::LinkSpritePanel::DrawPreviewCanvas(), yaze::editor::GfxGroupEditor::DrawRoomsetViewer(), and yaze::editor::GfxGroupEditor::DrawSpritesetViewer().

Here is the call graph for this function:

◆ GetCompactInputWidth()

float yaze::gui::LayoutHelpers::GetCompactInputWidth ( )

static

Definition at line 70 of file layout_helpers.cc.

References yaze::gui::Theme::compact_factor, GetBaseFontSize(), and GetTheme().

Referenced by yaze::editor::PolyhedralEditorPanel::DrawFaceList(), and yaze::editor::SheetBrowserPanel::DrawSearchBar().

Here is the call graph for this function:

◆ GetButtonPadding()

float yaze::gui::LayoutHelpers::GetButtonPadding ( )

static

Definition at line 74 of file layout_helpers.cc.

References GetBaseFontSize(), and GetTheme().

Referenced by BeginToolbar(), yaze::editor::DungeonCanvasViewer::DrawCompactLayerToggles(), yaze::editor::MapPropertiesSystem::DrawGraphicsPopup(), yaze::editor::MapPropertiesSystem::DrawPalettesPopup(), yaze::editor::MapPropertiesSystem::DrawPropertiesPopup(), yaze::editor::MapPropertiesSystem::DrawQuickAccessPopup(), yaze::editor::MemoryEditor::DrawToolbar(), yaze::editor::MapPropertiesSystem::DrawViewPopup(), and ToolbarButton().

Here is the call graph for this function:

◆ GetTableRowHeight()

float yaze::gui::LayoutHelpers::GetTableRowHeight ( )

static

Definition at line 80 of file layout_helpers.cc.

References GetBaseFontSize(), and GetTheme().

Referenced by BeginTableWithTheming().

Here is the call graph for this function:

◆ GetCanvasToolbarHeight()

float yaze::gui::LayoutHelpers::GetCanvasToolbarHeight ( )

static

Definition at line 86 of file layout_helpers.cc.

References GetBaseFontSize(), and GetTheme().

Here is the call graph for this function:

◆ BeginPaddedPanel()

void yaze::gui::LayoutHelpers::BeginPaddedPanel	(	const char *	label,
		float	padding = -1.0f )

static

Definition at line 159 of file layout_helpers.cc.

References GetPanelPadding().

Here is the call graph for this function:

◆ EndPaddedPanel()

void yaze::gui::LayoutHelpers::EndPaddedPanel ( )

static

Definition at line 170 of file layout_helpers.cc.

References GetPanelPadding().

Here is the call graph for this function:

◆ BeginTableWithTheming()

bool yaze::gui::LayoutHelpers::BeginTableWithTheming	(	const char *	str_id,
		int	columns,
		ImGuiTableFlags	flags = 0,
		const ImVec2 &	outer_size = ImVec2(0, 0),
		float	inner_width = 0.0f )

static

Definition at line 178 of file layout_helpers.cc.

References yaze::gui::ConvertColorToImVec4(), GetTableRowHeight(), and GetTheme().

Referenced by yaze::editor::UICoordinator::DrawCommandPalette().

Here is the call graph for this function:

◆ EndTableWithTheming()

void yaze::gui::LayoutHelpers::EndTableWithTheming ( )

static

Definition at line 206 of file layout_helpers.cc.

Referenced by yaze::editor::UICoordinator::DrawCommandPalette().

◆ EndTable()

static void yaze::gui::LayoutHelpers::EndTable ( )

inlinestatic

Definition at line 56 of file layout_helpers.h.

◆ BeginCanvasPanel()

void yaze::gui::LayoutHelpers::BeginCanvasPanel	(	const char *	label,
		ImVec2 *	canvas_size = nullptr )

static

Definition at line 214 of file layout_helpers.cc.

References yaze::gui::ConvertColorToImVec4(), and GetTheme().

Here is the call graph for this function:

◆ EndCanvasPanel()

void yaze::gui::LayoutHelpers::EndCanvasPanel ( )

static

Definition at line 229 of file layout_helpers.cc.

◆ BeginContentChild()

bool yaze::gui::LayoutHelpers::BeginContentChild	(	const char *	id,
		const ImVec2 &	min_size,
		bool	border = false,
		ImGuiWindowFlags	flags = 0 )

static

Definition at line 235 of file layout_helpers.cc.

References yaze::gui::GetContentRegionAvailClamped().

Referenced by yaze::editor::RightPanelManager::Draw(), yaze::editor::DungeonWorkbenchPanel::Draw(), yaze::editor::RightPanelManager::DrawNotificationsPanel(), yaze::editor::DungeonObjectSelector::DrawObjectRenderer(), yaze::editor::ActivityBar::DrawSidePanel(), yaze::editor::DungeonWorkbenchPanel::DrawSplitView(), and yaze::editor::DungeonObjectSelector::DrawTileSelector().

Here is the call graph for this function:

◆ EndContentChild()

static void yaze::gui::LayoutHelpers::EndContentChild ( )

inlinestatic

Definition at line 66 of file layout_helpers.h.

Referenced by yaze::editor::RightPanelManager::Draw(), yaze::editor::DungeonWorkbenchPanel::Draw(), yaze::editor::RightPanelManager::DrawNotificationsPanel(), yaze::editor::DungeonObjectSelector::DrawObjectRenderer(), yaze::editor::ActivityBar::DrawSidePanel(), yaze::editor::DungeonWorkbenchPanel::DrawSplitView(), and yaze::editor::DungeonObjectSelector::DrawTileSelector().

◆ AutoSizedInputField()

bool yaze::gui::LayoutHelpers::AutoSizedInputField	(	const char *	label,
		char *	buf,
		size_t	buf_size,
		ImGuiInputTextFlags	flags = 0 )

static

Definition at line 242 of file layout_helpers.cc.

References GetStandardInputWidth().

Here is the call graph for this function:

◆ AutoSizedInputInt()

bool yaze::gui::LayoutHelpers::AutoSizedInputInt	(	const char *	label,
		int *	v,
		int	step = 1,
		int	step_fast = 100,
		ImGuiInputTextFlags	flags = 0 )

static

Definition at line 249 of file layout_helpers.cc.

References GetStandardInputWidth().

Here is the call graph for this function:

◆ AutoSizedInputFloat()

bool yaze::gui::LayoutHelpers::AutoSizedInputFloat	(	const char *	label,
		float *	v,
		float	step = 0.0f,
		float	step_fast = 0.0f,
		const char *	format = "%.3f",
		ImGuiInputTextFlags	flags = 0 )

static

Definition at line 256 of file layout_helpers.cc.

References GetStandardInputWidth().

Here is the call graph for this function:

◆ InputHexRow() [1/2]

bool yaze::gui::LayoutHelpers::InputHexRow	(	const char *	label,
		uint8_t *	data )

static

Definition at line 264 of file layout_helpers.cc.

References GetHexInputWidth().

Here is the call graph for this function:

◆ InputHexRow() [2/2]

bool yaze::gui::LayoutHelpers::InputHexRow	(	const char *	label,
		uint16_t *	data )

static

Definition at line 291 of file layout_helpers.cc.

References GetHexInputWidth().

Here is the call graph for this function:

◆ BeginPropertyGrid()

void yaze::gui::LayoutHelpers::BeginPropertyGrid ( const char * label )

static

Definition at line 318 of file layout_helpers.cc.

References GetStandardInputWidth(), and GetTheme().

Here is the call graph for this function:

◆ EndPropertyGrid()

void yaze::gui::LayoutHelpers::EndPropertyGrid ( )

static

Definition at line 331 of file layout_helpers.cc.

◆ InputToolbarField()

bool yaze::gui::LayoutHelpers::InputToolbarField	(	const char *	label,
		char *	buf,
		size_t	buf_size )

static

Definition at line 335 of file layout_helpers.cc.

References yaze::gui::Theme::compact_factor, GetStandardInputWidth(), and GetTheme().

Here is the call graph for this function:

◆ BeginToolbar()

void yaze::gui::LayoutHelpers::BeginToolbar ( const char * label )

static

Definition at line 347 of file layout_helpers.cc.

References yaze::gui::ConvertColorToImVec4(), GetButtonPadding(), GetTheme(), GetToolbarHeight(), and GetTouchSafeWidgetHeight().

◆ EndToolbar()

void yaze::gui::LayoutHelpers::EndToolbar ( )

static

Definition at line 366 of file layout_helpers.cc.

◆ ToolbarSeparator()

void yaze::gui::LayoutHelpers::ToolbarSeparator ( )

static

Definition at line 386 of file layout_helpers.cc.

References GetStandardSpacing().

Here is the call graph for this function:

◆ ToolbarButton()

bool yaze::gui::LayoutHelpers::ToolbarButton	(	const char *	label,
		const ImVec2 &	size = ImVec2(0, 0) )

static

Definition at line 396 of file layout_helpers.cc.

References GetButtonPadding(), and GetMinTouchTarget().

Here is the call graph for this function:

◆ PropertyRow()

void yaze::gui::LayoutHelpers::PropertyRow	(	const char *	label,
		std::function< void()>	widget_callback )

static

Definition at line 411 of file layout_helpers.cc.

Referenced by yaze::editor::DungeonWorkbenchPanel::DrawInspectorShelfRoom(), and yaze::editor::DungeonWorkbenchPanel::DrawInspectorShelfSelection().

◆ SectionHeader()

void yaze::gui::LayoutHelpers::SectionHeader ( const char * label )

static

Definition at line 422 of file layout_helpers.cc.

References yaze::gui::ConvertColorToImVec4(), and GetTheme().

Here is the call graph for this function:

◆ HelpMarker()

void yaze::gui::LayoutHelpers::HelpMarker ( const char * desc )

static

Definition at line 429 of file layout_helpers.cc.

Referenced by yaze::editor::PaletteGroupPanel::DrawColorPicker().

◆ GetSafeAreaInsets()

LayoutHelpers::SafeAreaInsets yaze::gui::LayoutHelpers::GetSafeAreaInsets ( )

static

Definition at line 92 of file layout_helpers.cc.

References yaze::platform::ios::GetSafeAreaInsets().

Referenced by yaze::editor::RightPanelManager::Draw(), yaze::editor::StatusBar::Draw(), yaze::editor::ActivityBar::DrawActivityBarStrip(), yaze::editor::ActivityBar::DrawSidePanel(), and GetTopInset().

Here is the call graph for this function:

◆ GetTopInset()

float yaze::gui::LayoutHelpers::GetTopInset ( )

static

Definition at line 108 of file layout_helpers.cc.

References yaze::platform::ios::GetOverlayTopInset(), GetSafeAreaInsets(), and yaze::gui::LayoutHelpers::SafeAreaInsets::top.

Referenced by yaze::editor::RightPanelManager::Draw(), yaze::editor::ActivityBar::DrawActivityBarStrip(), and yaze::editor::ActivityBar::DrawSidePanel().

Here is the call graph for this function:

◆ IsTouchDevice()

bool yaze::gui::LayoutHelpers::IsTouchDevice ( )

static

Definition at line 116 of file layout_helpers.cc.

Referenced by yaze::gui::PanelWindow::Begin(), yaze::editor::StatusBar::Draw(), yaze::editor::PanelManager::DrawAllVisiblePanels(), yaze::gui::Canvas::DrawBackground(), yaze::editor::UICoordinator::DrawPanelFinder(), yaze::editor::DungeonWorkbenchPanel::DrawRecentRoomTabs(), yaze::editor::DungeonRoomSelector::DrawRoomSelector(), yaze::editor::StatusBar::GetHeight(), GetMinTouchTarget(), yaze::editor::DungeonCanvasViewer::HandleTouchLongPressContextMenu(), yaze::editor::DungeonCanvasViewer::RenderPotItems(), and yaze::editor::DungeonCanvasViewer::RenderSprites().

◆ GetMinTouchTarget()

float yaze::gui::LayoutHelpers::GetMinTouchTarget ( )

static

Definition at line 121 of file layout_helpers.cc.

References IsTouchDevice().

Referenced by yaze::editor::DungeonWorkbenchPanel::Draw(), yaze::editor::DungeonRoomSelector::DrawRoomSelector(), GetTouchSafeWidgetHeight(), and ToolbarButton().

Here is the call graph for this function:

◆ GetTouchSafeWidgetHeight()

float yaze::gui::LayoutHelpers::GetTouchSafeWidgetHeight ( )

static

Definition at line 125 of file layout_helpers.cc.

References GetMinTouchTarget(), and GetStandardWidgetHeight().

Referenced by BeginToolbar(), yaze::editor::DungeonWorkbenchPanel::Draw(), and yaze::editor::DungeonWorkbenchToolbar::Draw().

Here is the call graph for this function:

◆ ClampWindowToRect()

LayoutHelpers::WindowClampResult yaze::gui::LayoutHelpers::ClampWindowToRect	(	const ImVec2 &	pos,
		const ImVec2 &	size,
		const ImVec2 &	rect_pos,
		const ImVec2 &	rect_size,
		float	min_visible = 32.0f )

static

Definition at line 129 of file layout_helpers.cc.

Referenced by yaze::gui::PanelWindow::Begin(), and yaze::platform::IOSWindowBackend::RenderImGui().

◆ GetTheme()

static const Theme & yaze::gui::LayoutHelpers::GetTheme ( )

inlinestatic

Definition at line 116 of file layout_helpers.h.

References yaze::gui::ThemeManager::Get(), and yaze::gui::ThemeManager::GetCurrentTheme().

Referenced by ApplyCompactFactor(), BeginCanvasPanel(), BeginPropertyGrid(), BeginTableWithTheming(), BeginToolbar(), GetButtonPadding(), GetCanvasToolbarHeight(), GetComboWidth(), GetCompactInputWidth(), GetHexInputWidth(), GetPanelPadding(), GetSliderWidth(), GetStandardInputWidth(), GetStandardSpacing(), GetStandardWidgetHeight(), GetTableRowHeight(), GetToolbarHeight(), InputToolbarField(), and SectionHeader().

Here is the call graph for this function:

◆ GetBaseFontSize()

static float yaze::gui::LayoutHelpers::GetBaseFontSize ( )

inlinestaticprivate

Definition at line 121 of file layout_helpers.h.

Referenced by GetButtonPadding(), GetCanvasToolbarHeight(), GetComboWidth(), GetCompactInputWidth(), GetHexInputWidth(), GetPanelPadding(), GetSliderWidth(), GetStandardInputWidth(), GetStandardSpacing(), GetStandardWidgetHeight(), GetTableRowHeight(), and GetToolbarHeight().

◆ ApplyCompactFactor()

static float yaze::gui::LayoutHelpers::ApplyCompactFactor ( float base_value )

inlinestaticprivate

Definition at line 122 of file layout_helpers.h.

References yaze::gui::Theme::compact_factor, and GetTheme().

Here is the call graph for this function:

The documentation for this class was generated from the following files:

src/app/gui/core/layout_helpers.h
src/app/gui/core/layout_helpers.cc

	yaze 0.3.2 Link to the Past ROM Editor

Classes

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ GetStandardWidgetHeight()

◆ GetStandardSpacing()

◆ GetToolbarHeight()

◆ GetPanelPadding()

◆ GetStandardInputWidth()

◆ GetHexInputWidth()

◆ GetComboWidth()

◆ GetSliderWidth()

◆ GetCompactInputWidth()

◆ GetButtonPadding()

◆ GetTableRowHeight()

◆ GetCanvasToolbarHeight()

◆ BeginPaddedPanel()

◆ EndPaddedPanel()

◆ BeginTableWithTheming()

◆ EndTableWithTheming()

◆ EndTable()

◆ BeginCanvasPanel()

◆ EndCanvasPanel()

◆ BeginContentChild()

◆ EndContentChild()

◆ AutoSizedInputField()

◆ AutoSizedInputInt()

◆ AutoSizedInputFloat()

◆ InputHexRow() [1/2]

◆ InputHexRow() [2/2]

◆ BeginPropertyGrid()

◆ EndPropertyGrid()

◆ InputToolbarField()

◆ BeginToolbar()

◆ EndToolbar()

◆ ToolbarSeparator()

◆ ToolbarButton()

◆ PropertyRow()

◆ SectionHeader()

◆ HelpMarker()

◆ GetSafeAreaInsets()

◆ GetTopInset()

◆ IsTouchDevice()

◆ GetMinTouchTarget()

◆ GetTouchSafeWidgetHeight()

◆ ClampWindowToRect()

◆ GetTheme()

◆ GetBaseFontSize()

◆ ApplyCompactFactor()