SDOM Namespace Reference

Contains all core classes and utilities for the SDOM library. More...

Classes
class	AssetHandle
struct	AssetTypeCreators
class	BitmapFont
struct	Bounds
	Represents a rectangle's position and size in 2D space. More...
class	Button
class	Checkbox
class	Core
	The central singleton framework object for SDOM. More...
class	DisplayHandle
class	Event
class	EventManager
class	EventType
struct	EventTypeHash
class	Exception
	Custom exception class for SDOM errors. More...
class	Factory
struct	FontStyle
class	Frame
class	Group
class	IAssetObject
class	IButtonObject
class	IconButton
class	IDataObject
class	IDisplayObject
class	IFontObject
class	IPanelObject
interface	IUnitTest
	Interface for unit testing objects in SDOM. More...
class	Label
class	Radiobox
class	SDL_Utils
class	SpriteSheet
class	Stage
class	Texture
class	TriStateCheckbox
class	TruetypeFont
class	TTFAsset
struct	TypeCreators
class	UnitTests

Enumerations
enum class	AnchorPoint : uint8_t {   DEFAULT = 0 , TOP_LEFT = 0 , TOP_CENTER = 1 , TOP_RIGHT = 2 ,   MIDDLE_LEFT = 3 , MIDDLE_CENTER = 4 , MIDDLE_RIGHT = 5 , BOTTOM_LEFT = 6 ,   BOTTOM_CENTER = 7 , BOTTOM_RIGHT = 8 , Aliases for anchor points , LEFT = MIDDLE_LEFT ,   CENTER = MIDDLE_CENTER , RIGHT = MIDDLE_RIGHT , TOP = TOP_CENTER , MIDDLE = MIDDLE_CENTER ,   BOTTOM = BOTTOM_CENTER , LEFT_TOP = TOP_LEFT , CENTER_TOP = TOP_CENTER , RIGHT_TOP = TOP_RIGHT ,   LEFT_MIDDLE = MIDDLE_LEFT , CENTER_MIDDLE = MIDDLE_CENTER , RIGHT_MIDDLE = MIDDLE_RIGHT , LEFT_BOTTOM = BOTTOM_LEFT ,   CENTER_BOTTOM = BOTTOM_CENTER , RIGHT_BOTTOM = BOTTOM_RIGHT }
	Reference points for anchoring child edges to a parent. More...
enum class	ButtonState {   Normal , Hovered , Pressed , Disabled ,   Checked , Unchecked , Indeterminate , HoveredChecked ,   PressedChecked }
enum class	IconIndex : int {   Hamburger = 54 , Arrow_Left_Raised , Arrow_Right_Raised , Arrow_Up_Raised ,   Arrow_Down_Raised , Arrow_Left_Depressed , Arrow_Right_Depressed , Arrow_Up_Depressed ,   Arrow_Down_Depressed , Knob_Horizontal , Knob_Vertical , Slider_Tick ,   HSlider_Rail , VSlider_Rail , Checkbox_Empty , Checkbox_Checked ,   Checkbox_X , Radiobox_Unselected , Radiobox_Selected , HProgress_Left ,   HProgress_Empty , HProgress_Thumb , HProgress_Right , VProgress_Top ,   VProgress_Empty , VProgress_Thumb , VProgress_Bottom }
enum class	LabelAlign : uint8_t {   DEFAULT = 0b0000 , LEFT = 0b0001 , CENTER = 0b0010 , RIGHT = 0b0011 ,   TOP = 0b0100 , TOP_LEFT = 0b0101 , TOP_CENTER = 0b0110 , TOP_RIGHT = 0b0111 ,   MIDDLE = 0b1000 , MIDDLE_LEFT = 0b1001 , MIDDLE_CENTER = 0b1010 , MIDDLE_RIGHT = 0b1011 ,   BOTTOM = 0b1100 , BOTTOM_LEFT = 0b1101 , BOTTOM_CENTER = 0b1110 , BOTTOM_RIGHT = 0b1111 }
enum class	PanelBaseIndex {   ButtonUp = 0 , ButtonUpSelected = 9 , ButtonDown = 18 , ButtonDownSelected = 27 ,   Frame = 36 , Group = 45 }
enum class	PanelTileOffset {   TopLeft = 0 , TopCenter = 1 , TopRight = 2 , LeftCenter = 3 ,   Center = 4 , RightCenter = 5 , BottomLeft = 6 , BottomCenter = 7 ,   BottomRight = 8 }
enum class	TriState : int { Unchecked = 0 , Checked = 1 , Indeterminate = 2 }

Functions
void	bind_noarg (const std::string &name, std::function< void()> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_table (const std::string &name, std::function< void(const sol::table &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_string (const std::string &name, std::function< void(const std::string &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_bool_arg (const std::string &name, std::function< void(bool)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_do_arg (const std::string &name, std::function< void(const DisplayHandle &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_object_arg (const std::string &name, std::function< void(const sol::object &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_return_displayobject (const std::string &name, std::function< DisplayHandle()> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_return_bool (const std::string &name, std::function< bool()> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_return_string (const std::string &name, std::function< std::string()> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_return_float (const std::string &name, std::function< float()> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_return_int (const std::string &name, std::function< int()> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_return_vector_do (const std::string &name, std::function< std::vector< DisplayHandle >()> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_return_vector_string (const std::string &name, std::function< std::vector< std::string >()> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_string_table_return_do (const std::string &name, std::function< DisplayHandle(const std::string &, const sol::table &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_string_table_return_asset (const std::string &name, std::function< AssetHandle(const std::string &, const sol::table &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_string_return_do (const std::string &name, std::function< DisplayHandle(const std::string &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_string_return_asset (const std::string &name, std::function< AssetHandle(const std::string &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_string_return_bool (const std::string &name, std::function< bool(const std::string &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_callback_bool (const std::string &name, std::function< void(std::function< bool()>)> registrar, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_callback_void (const std::string &name, std::function< void(std::function< void()>)> registrar, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_callback_update (const std::string &name, std::function< void(std::function< void(float)>)> registrar, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_callback_event (const std::string &name, std::function< void(std::function< void(const Event &)>)> registrar, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_callback_resize (const std::string &name, std::function< void(std::function< void(int, int)>)> registrar, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_string_function_forwarder (const std::string &name, std::function< void(const std::string &, const sol::function &)> func, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	bind_name_or_handle (const std::string &name, std::function< void(const std::string &)> nameFunc, std::function< void(const DisplayHandle &)> handleFunc, sol::usertype< Core > &objHandleType, sol::table &coreTable, sol::state_view lua)
void	quit_lua ()
void	shutdown_lua ()
void	configure_lua (const sol::table &config)
void	configureFromFile_lua (const std::string &filename)
void	registerOnInit_lua (std::function< bool()> fn)
void	registerOnQuit_lua (std::function< void()> fn)
void	registerOnUpdate_lua (std::function< void(float)> fn)
void	registerOnEvent_lua (std::function< void(const Event &)> fn)
void	registerOnRender_lua (std::function< void()> fn)
void	registerOnUnitTest_lua (std::function< bool()> fn)
void	registerOnWindowResize_lua (std::function< void(int, int)> fn)
void	registerOn_lua (const std::string &name, const sol::function &f)
void	setRootNodeByName_lua (const std::string &name)
void	setRootNode_lua (const DisplayHandle &handle)
void	setStageByName_lua (const std::string &name)
void	setStage_lua (const DisplayHandle &handle)
DisplayHandle	getRoot_lua ()
DisplayHandle	getStage_lua ()
bool	getIsTraversing_lua ()
void	setIsTraversing_lua (bool traversing)
DisplayHandle	createDisplayObject_lua (const std::string &typeName, const sol::table &config)
DisplayHandle	getDisplayObject_lua (const std::string &name)
bool	hasDisplayObject_lua (const std::string &name)
AssetHandle	createAssetObject_lua (const std::string &typeName, const sol::table &config)
AssetHandle	getAssetObject_lua (const std::string &name)
bool	hasAssetObject_lua (const std::string &name)
void	doTabKeyPressForward_lua ()
void	doTabKeyPressReverse_lua ()
void	setKeyboardFocusedObject_lua (const DisplayHandle &handle)
DisplayHandle	getKeyboardFocusedObject_lua ()
void	setMouseHoveredObject_lua (const DisplayHandle &handle)
DisplayHandle	getMouseHoveredObject_lua ()
std::string	getWindowTitle_lua ()
void	setWindowTitle_lua (const std::string &title)
float	getElapsedTime_lua ()
void	pumpEventsOnce_lua ()
void	pushMouseEvent_lua (const sol::object &args)
void	pushKeyboardEvent_lua (const sol::object &args)
void	destroyDisplayObject_lua (const std::string &name)
int	countOrphanedDisplayObjects_lua ()
std::vector< DisplayHandle >	getOrphanedDisplayObjects_lua ()
void	destroyOrphanedDisplayObjects_lua ()
void	collectGarbage_lua ()
std::vector< std::string >	listDisplayObjectNames_lua ()
void	printObjectRegistry_lua ()
void	cleanAll_lua (IDisplayObject *obj)
bool	getDirty_lua (const IDisplayObject *obj)
void	setDirty_lua (IDisplayObject *obj)
bool	isDirty_lua (const IDisplayObject *obj)
void	printTree_lua (const IDisplayObject *obj)
void	addEventListener_lua (IDisplayObject *obj, EventType &type, sol::function listener, bool useCapture, int priority)
void	removeEventListener_lua (IDisplayObject *obj, EventType &type, sol::function listener, bool useCapture)
void	addEventListener_lua_any (IDisplayObject *obj, const sol::object &descriptor, const sol::object &maybe_listener, const sol::object &maybe_useCapture, const sol::object &maybe_priority)
void	removeEventListener_lua_any (IDisplayObject *obj, const sol::object &descriptor, const sol::object &maybe_listener, const sol::object &maybe_useCapture)
void	addEventListener_lua_any_short (IDisplayObject *obj, const sol::object &descriptor)
void	removeEventListener_lua_any_short (IDisplayObject *obj, const sol::object &descriptor)
void	addChild_lua (IDisplayObject *obj, DisplayHandle child)
DisplayHandle	getChild_lua (const IDisplayObject *obj, std::string name)
bool	removeChild_lua (IDisplayObject *obj, DisplayHandle child)
bool	removeChild_lua (IDisplayObject *obj, const std::string &name)
bool	hasChild_lua (const IDisplayObject *obj, DisplayHandle child)
DisplayHandle	getParent_lua (const IDisplayObject *obj)
void	setParent_lua (IDisplayObject *obj, const DisplayHandle &parent)
bool	isAncestorOf_lua (IDisplayObject *obj, DisplayHandle descendant)
bool	isAncestorOf_lua (IDisplayObject *obj, const std::string &name)
bool	isDescendantOf_lua (IDisplayObject *obj, DisplayHandle ancestor)
bool	isDescendantOf_lua (IDisplayObject *obj, const std::string &name)
bool	removeFromParent_lua (IDisplayObject *obj)
bool	removeDescendant_lua (IDisplayObject *obj, DisplayHandle descendant)
bool	removeDescendant_lua (IDisplayObject *obj, const std::string &descendantName)
std::string	getName_lua (const IDisplayObject *obj)
void	setName_lua (IDisplayObject *obj, const std::string &newName)
std::string	getType_lua (const IDisplayObject *obj)
void	setType_lua (IDisplayObject *obj, const std::string &newType)
Bounds	getBounds_lua (const IDisplayObject *obj)
void	setBounds_lua (IDisplayObject *obj, const sol::object &bobj)
SDL_Color	getColor_lua (const IDisplayObject *obj)
void	setColor_lua (IDisplayObject *obj, const sol::object &colorObj)
std::string	getName_handle_lua (DisplayHandle &self)
int	getMaxPriority_lua (const IDisplayObject *obj)
int	getMinPriority_lua (const IDisplayObject *obj)
int	getPriority_lua (const IDisplayObject *obj)
void	setToHighestPriority_lua (IDisplayObject *obj)
void	setToLowestPriority_lua (IDisplayObject *obj)
void	sortChildrenByPriority_lua (IDisplayObject *obj)
void	setPriority_lua (IDisplayObject *obj, int priority)
void	setPriority_lua_any (IDisplayObject *obj, const sol::object &descriptor)
void	setPriority_lua_target (IDisplayObject *obj, const sol::object &descriptor, int value)
std::vector< int >	getChildrenPriorities_lua (const IDisplayObject *obj)
void	moveToTop_lua (IDisplayObject *obj)
void	moveToTop_lua_any (IDisplayObject *obj, const sol::object &descriptor)
int	getZOrder_lua (const IDisplayObject *obj)
void	setZOrder_lua (IDisplayObject *obj, int z_order)
void	setZOrder_lua_any (IDisplayObject *obj, const sol::object &descriptor)
void	setToHighestPriority_lua_any (IDisplayObject *obj, const sol::object &descriptor)
void	setToLowestPriority_lua_any (IDisplayObject *obj, const sol::object &descriptor)
void	setKeyboardFocus_lua (IDisplayObject *obj)
bool	isKeyboardFocused_lua (const IDisplayObject *obj)
bool	isMouseHovered_lua (const IDisplayObject *obj)
bool	isClickable_lua (const IDisplayObject *obj)
void	setClickable_lua (IDisplayObject *obj, bool clickable)
bool	isEnabled_lua (const IDisplayObject *obj)
void	setEnabled_lua (IDisplayObject *obj, bool enabled)
bool	isHidden_lua (const IDisplayObject *obj)
void	setHidden_lua (IDisplayObject *obj, bool hidden)
bool	isVisible_lua (const IDisplayObject *obj)
void	setVisible_lua (IDisplayObject *obj, bool visible)
int	getTabPriority_lua (const IDisplayObject *obj)
void	setTabPriority_lua (IDisplayObject *obj, int index)
bool	isTabEnabled_lua (const IDisplayObject *obj)
void	setTabEnabled_lua (IDisplayObject *obj, bool enabled)
int	getX_lua (const IDisplayObject *obj)
int	getY_lua (const IDisplayObject *obj)
int	getWidth_lua (const IDisplayObject *obj)
int	getHeight_lua (const IDisplayObject *obj)
void	setX_lua (IDisplayObject *obj, int p_x)
void	setY_lua (IDisplayObject *obj, int p_y)
void	setWidth_lua (IDisplayObject *obj, int width)
void	setHeight_lua (IDisplayObject *obj, int height)
AnchorPoint	getAnchorTop_lua (const IDisplayObject *obj)
AnchorPoint	getAnchorLeft_lua (const IDisplayObject *obj)
AnchorPoint	getAnchorBottom_lua (const IDisplayObject *obj)
AnchorPoint	getAnchorRight_lua (const IDisplayObject *obj)
void	setAnchorTop_lua (IDisplayObject *obj, AnchorPoint ap)
void	setAnchorLeft_lua (IDisplayObject *obj, AnchorPoint ap)
void	setAnchorBottom_lua (IDisplayObject *obj, AnchorPoint ap)
void	setAnchorRight_lua (IDisplayObject *obj, AnchorPoint ap)
float	getLeft_lua (const IDisplayObject *obj)
float	getRight_lua (const IDisplayObject *obj)
float	getTop_lua (const IDisplayObject *obj)
float	getBottom_lua (const IDisplayObject *obj)
void	setLeft_lua (IDisplayObject *obj, float p_left)
void	setRight_lua (IDisplayObject *obj, float p_right)
void	setTop_lua (IDisplayObject *obj, float p_top)
void	setBottom_lua (IDisplayObject *obj, float p_bottom)
float	getLocalLeft_lua (const IDisplayObject *obj)
float	getLocalRight_lua (const IDisplayObject *obj)
float	getLocalTop_lua (const IDisplayObject *obj)
float	getLocalBottom_lua (const IDisplayObject *obj)
void	setLocalLeft_lua (IDisplayObject *obj, float p_left)
void	setLocalRight_lua (IDisplayObject *obj, float p_right)
void	setLocalTop_lua (IDisplayObject *obj, float p_top)
void	setLocalBottom_lua (IDisplayObject *obj, float p_bottom)
IDisplayObject::OrphanRetentionPolicy	orphanPolicyFromString_lua (IDisplayObject *obj, const std::string &s)
std::string	orphanPolicyToString_lua (IDisplayObject *obj, IDisplayObject::OrphanRetentionPolicy p)
void	setOrphanRetentionPolicy_lua (IDisplayObject *obj, const std::string &policyStr)
std::string	getOrphanRetentionPolicyString_lua (IDisplayObject *obj)
int	getOrphanGrace_lua (const IDisplayObject *obj)
void	setOrphanGrace_lua (IDisplayObject *obj, std::chrono::milliseconds grace)
bool	operator< (const IAssetObject &a, const IAssetObject &b)
bool	operator== (const IAssetObject &a, const IAssetObject &b)
bool	operator<= (const IAssetObject &a, const IAssetObject &b)
static std::optional< std::string >	icon_name_from_index (IconIndex idx)
static std::optional< IconIndex >	icon_index_from_name (const std::string &name)
bool	operator!= (const SDOM::FontStyle &a, const SDOM::FontStyle &b)
bool	operator== (const SDOM::FontStyle &a, const SDOM::FontStyle &b)
static std::optional< std::string >	tristate_name_from_index (TriState idx)
static std::optional< TriState >	tristate_index_from_name (const std::string &name)
void	quit ()
void	shutdown ()
Core &	getCore ()
Factory &	getFactory ()
Stage *	getStage ()
DisplayHandle	getStageHandle ()
SDL_Renderer *	getRenderer ()
SDL_Window *	getWindow ()
SDL_Texture *	getTexture ()
sol::state &	getLua ()
SDL_Color	parseColor (const sol::object &colorObj)
std::string	normalizeAnchorString (const std::string &s)
bool	validateAnchorPointString (const std::string &anchorString)
bool	validateAnchorAssignments (const sol::table &config)
void	printMessageBox (const std::string &title, const std::string &message, const std::string &file, int line, const std::string &colorTitle, const std::string &colorMsg, const std::string &colorBorder)
void	showWarning (const std::string &message, const std::string &file, int line)
void	setBounds_lua (IDisplayObject *obj, const Bounds &b)
void	setColor_lua (IDisplayObject *obj, const SDL_Color &color)
static void	set_if_absent (sol::table &handle, const char *name, auto &&fn)
static void	set_if_absent (sol::table &handle, const char *name, auto &&fn)
static std::string	trim (const std::string &s)

Variables
static const std::unordered_map< AnchorPoint, std::string >	anchorPointToString_
	Maps AnchorPoint enum values to their corresponding string names.
static const std::unordered_map< std::string, AnchorPoint >	stringToAnchorPoint_
	Maps string names to AnchorPoint enum values.
static const std::unordered_map< int, std::string >	icon_index_to_string
static const std::unordered_map< std::string, int >	icon_string_to_index
constexpr int	maxOutlineThickness = 3
static const std::unordered_map< std::string, PanelBaseIndex >	stringToPanelBaseIndex_
static const std::unordered_map< PanelBaseIndex, std::string >	panelBaseIndexToString_
static const std::unordered_map< std::string, PanelTileOffset >	stringToPanelTileOffset_
static const std::unordered_map< PanelTileOffset, std::string >	panelTileOffsetToString_
unsigned char	internal_font_8x8 []
int	internal_font_8x8_len = 2885
unsigned char	internal_font_8x12 []
int	internal_font_8x12_len = 3340
unsigned char	internal_icon_8x8 []
int	internal_icon_8x8_len = 1305
static const std::unordered_map< int, std::string >	tristate_to_string
static const std::unordered_map< std::string, int >	tristate_string_to_index
unsigned char	internal_ttf []
int	internal_ttf_len = 455188
static bool	isDragging = false
static DisplayHandle	draggedObject = nullptr

Detailed Description

Contains all core classes and utilities for the SDOM library.

Enumeration Type Documentation

AnchorPoint

enum class SDOM::AnchorPoint : uint8_t

strong

Reference points for anchoring child edges to a parent.

Specifies where each edge of a child display object should be anchored relative to its parent, enabling flexible positioning and layout.

The main anchor points correspond to corners, edges, and the center of the parent. Aliases are provided for convenience and readability.

Enumerator
DEFAULT	Default anchor point (same as TOP_LEFT)
TOP_LEFT	Top-left corner of the parent.
TOP_CENTER	Top-center edge of the parent.
TOP_RIGHT	Top-right corner of the parent.
MIDDLE_LEFT	Middle-left edge of the parent.
MIDDLE_CENTER	Center of the parent.
MIDDLE_RIGHT	Middle-right edge of the parent.
BOTTOM_LEFT	Bottom-left corner of the parent.
BOTTOM_CENTER	Bottom-center edge of the parent.
BOTTOM_RIGHT	Bottom-right corner of the parent.
Aliases for anchor points
LEFT	Alias for MIDDLE_LEFT.
CENTER	Alias for MIDDLE_CENTER.
RIGHT	Alias for MIDDLE_RIGHT.
TOP	Alias for TOP_CENTER.
MIDDLE	Alias for MIDDLE_CENTER.
BOTTOM	Alias for BOTTOM_CENTER.
LEFT_TOP	Alias for TOP_LEFT.
CENTER_TOP	Alias for TOP_CENTER.
RIGHT_TOP	Alias for TOP_RIGHT.
LEFT_MIDDLE	Alias for MIDDLE_LEFT.
CENTER_MIDDLE	Alias for MIDDLE_CENTER.
RIGHT_MIDDLE	Alias for MIDDLE_RIGHT.
LEFT_BOTTOM	Alias for BOTTOM_LEFT.
CENTER_BOTTOM	Alias for BOTTOM_CENTER.
RIGHT_BOTTOM	Alias for BOTTOM_RIGHT.

ButtonState

enum class SDOM::ButtonState

strong

Enumerator
Normal
Hovered
Pressed
Disabled
Checked
Unchecked
Indeterminate
HoveredChecked
PressedChecked

IconIndex

enum class SDOM::IconIndex : int

strong

Enumerator
Hamburger
Arrow_Left_Raised
Arrow_Right_Raised
Arrow_Up_Raised
Arrow_Down_Raised
Arrow_Left_Depressed
Arrow_Right_Depressed
Arrow_Up_Depressed
Arrow_Down_Depressed
Knob_Horizontal
Knob_Vertical
Slider_Tick
HSlider_Rail
VSlider_Rail
Checkbox_Empty
Checkbox_Checked
Checkbox_X
Radiobox_Unselected
Radiobox_Selected
HProgress_Left
HProgress_Empty
HProgress_Thumb
HProgress_Right
VProgress_Top
VProgress_Empty
VProgress_Thumb
VProgress_Bottom

LabelAlign

enum class SDOM::LabelAlign : uint8_t

strong

Enumerator
DEFAULT
LEFT
CENTER
RIGHT
TOP
TOP_LEFT
TOP_CENTER
TOP_RIGHT
MIDDLE
MIDDLE_LEFT
MIDDLE_CENTER
MIDDLE_RIGHT
BOTTOM
BOTTOM_LEFT
BOTTOM_CENTER
BOTTOM_RIGHT

PanelBaseIndex

enum class SDOM::PanelBaseIndex

strong

Enumerator
ButtonUp
ButtonUpSelected
ButtonDown
ButtonDownSelected
Frame
Group

PanelTileOffset

enum class SDOM::PanelTileOffset

strong

Enumerator
TopLeft
TopCenter
TopRight
LeftCenter
Center
RightCenter
BottomLeft
BottomCenter
BottomRight

TriState

enum class SDOM::TriState : int

strong

Enumerator
Unchecked
Checked
Indeterminate

Function Documentation

addChild_lua()

void SDOM::addChild_lua	(	IDisplayObject *	obj,
		DisplayHandle	child
	)

addEventListener_lua()

void SDOM::addEventListener_lua	(	IDisplayObject *	obj,
		EventType &	type,
		sol::function	listener,
		bool	useCapture,
		int	priority
	)

addEventListener_lua_any()

void SDOM::addEventListener_lua_any	(	IDisplayObject *	obj,
		const sol::object &	descriptor,
		const sol::object &	maybe_listener,
		const sol::object &	maybe_useCapture,
		const sol::object &	maybe_priority
	)

addEventListener_lua_any_short()

void SDOM::addEventListener_lua_any_short	(	IDisplayObject *	obj,
		const sol::object &	descriptor
	)

bind_bool_arg()

void SDOM::bind_bool_arg	(	const std::string &	name,
		std::function< void(bool)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_callback_bool()

void SDOM::bind_callback_bool	(	const std::string &	name,
		std::function< void(std::function< bool()>)>	registrar,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_callback_event()

void SDOM::bind_callback_event	(	const std::string &	name,
		std::function< void(std::function< void(const Event &)>)>	registrar,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_callback_resize()

void SDOM::bind_callback_resize	(	const std::string &	name,
		std::function< void(std::function< void(int, int)>)>	registrar,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_callback_update()

void SDOM::bind_callback_update	(	const std::string &	name,
		std::function< void(std::function< void(float)>)>	registrar,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_callback_void()

void SDOM::bind_callback_void	(	const std::string &	name,
		std::function< void(std::function< void()>)>	registrar,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_do_arg()

void SDOM::bind_do_arg	(	const std::string &	name,
		std::function< void(const DisplayHandle &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_name_or_handle()

void SDOM::bind_name_or_handle	(	const std::string &	name,
		std::function< void(const std::string &)>	nameFunc,
		std::function< void(const DisplayHandle &)>	handleFunc,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_noarg()

void SDOM::bind_noarg	(	const std::string &	name,
		std::function< void()>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_object_arg()

void SDOM::bind_object_arg	(	const std::string &	name,
		std::function< void(const sol::object &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_return_bool()

void SDOM::bind_return_bool	(	const std::string &	name,
		std::function< bool()>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_return_displayobject()

void SDOM::bind_return_displayobject	(	const std::string &	name,
		std::function< DisplayHandle()>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_return_float()

void SDOM::bind_return_float	(	const std::string &	name,
		std::function< float()>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_return_int()

void SDOM::bind_return_int	(	const std::string &	name,
		std::function< int()>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_return_string()

void SDOM::bind_return_string	(	const std::string &	name,
		std::function< std::string()>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_return_vector_do()

void SDOM::bind_return_vector_do	(	const std::string &	name,
		std::function< std::vector< DisplayHandle >()>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_return_vector_string()

void SDOM::bind_return_vector_string	(	const std::string &	name,
		std::function< std::vector< std::string >()>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_string()

void SDOM::bind_string	(	const std::string &	name,
		std::function< void(const std::string &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_string_function_forwarder()

void SDOM::bind_string_function_forwarder	(	const std::string &	name,
		std::function< void(const std::string &, const sol::function &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_string_return_asset()

void SDOM::bind_string_return_asset	(	const std::string &	name,
		std::function< AssetHandle(const std::string &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_string_return_bool()

void SDOM::bind_string_return_bool	(	const std::string &	name,
		std::function< bool(const std::string &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_string_return_do()

void SDOM::bind_string_return_do	(	const std::string &	name,
		std::function< DisplayHandle(const std::string &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_string_table_return_asset()

void SDOM::bind_string_table_return_asset	(	const std::string &	name,
		std::function< AssetHandle(const std::string &, const sol::table &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_string_table_return_do()

void SDOM::bind_string_table_return_do	(	const std::string &	name,
		std::function< DisplayHandle(const std::string &, const sol::table &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

bind_table()

void SDOM::bind_table	(	const std::string &	name,
		std::function< void(const sol::table &)>	func,
		sol::usertype< Core > &	objHandleType,
		sol::table &	coreTable,
		sol::state_view	lua
	)

cleanAll_lua()

void SDOM::cleanAll_lua

(

IDisplayObject *

obj

)

collectGarbage_lua()

void SDOM::collectGarbage_lua

(

)

configure_lua()

void SDOM::configure_lua

(

const sol::table &

config

)

configureFromFile_lua()

void SDOM::configureFromFile_lua

(

const std::string &

filename

)

countOrphanedDisplayObjects_lua()

int SDOM::countOrphanedDisplayObjects_lua

(

)

createAssetObject_lua()

AssetHandle SDOM::createAssetObject_lua	(	const std::string &	typeName,
		const sol::table &	config
	)

createDisplayObject_lua()

DisplayHandle SDOM::createDisplayObject_lua	(	const std::string &	typeName,
		const sol::table &	config
	)

destroyDisplayObject_lua()

void SDOM::destroyDisplayObject_lua

(

const std::string &

name

)

destroyOrphanedDisplayObjects_lua()

void SDOM::destroyOrphanedDisplayObjects_lua

(

)

doTabKeyPressForward_lua()

void SDOM::doTabKeyPressForward_lua

(

)

doTabKeyPressReverse_lua()

void SDOM::doTabKeyPressReverse_lua

(

)

getAnchorBottom_lua()

AnchorPoint SDOM::getAnchorBottom_lua

(

const IDisplayObject *

obj

)

getAnchorLeft_lua()

AnchorPoint SDOM::getAnchorLeft_lua

(

const IDisplayObject *

obj

)

getAnchorRight_lua()

AnchorPoint SDOM::getAnchorRight_lua

(

const IDisplayObject *

obj

)

getAnchorTop_lua()

AnchorPoint SDOM::getAnchorTop_lua

(

const IDisplayObject *

obj

)

getAssetObject_lua()

AssetHandle SDOM::getAssetObject_lua

(

const std::string &

name

)

getBottom_lua()

float SDOM::getBottom_lua

(

const IDisplayObject *

obj

)

getBounds_lua()

Bounds SDOM::getBounds_lua

(

const IDisplayObject *

obj

)

getChild_lua()

DisplayHandle SDOM::getChild_lua	(	const IDisplayObject *	obj,
		std::string	name
	)

getChildrenPriorities_lua()

std::vector< int > SDOM::getChildrenPriorities_lua

(

const IDisplayObject *

obj

)

getColor_lua()

SDL_Color SDOM::getColor_lua

(

const IDisplayObject *

obj

)

getCore()

Core & SDOM::getCore

(

)

getDirty_lua()

bool SDOM::getDirty_lua

(

const IDisplayObject *

obj

)

getDisplayObject_lua()

DisplayHandle SDOM::getDisplayObject_lua

(

const std::string &

name

)

getElapsedTime_lua()

float SDOM::getElapsedTime_lua

(

)

getFactory()

Factory & SDOM::getFactory

(

)

getHeight_lua()

int SDOM::getHeight_lua

(

const IDisplayObject *

obj

)

getIsTraversing_lua()

bool SDOM::getIsTraversing_lua

(

)

getKeyboardFocusedObject_lua()

DisplayHandle SDOM::getKeyboardFocusedObject_lua

(

)

getLeft_lua()

float SDOM::getLeft_lua

(

const IDisplayObject *

obj

)

getLocalBottom_lua()

float SDOM::getLocalBottom_lua

(

const IDisplayObject *

obj

)

getLocalLeft_lua()

float SDOM::getLocalLeft_lua

(

const IDisplayObject *

obj

)

getLocalRight_lua()

float SDOM::getLocalRight_lua

(

const IDisplayObject *

obj

)

getLocalTop_lua()

float SDOM::getLocalTop_lua

(

const IDisplayObject *

obj

)

getLua()

sol::state & SDOM::getLua

(

)

getMaxPriority_lua()

int SDOM::getMaxPriority_lua

(

const IDisplayObject *

obj

)

getMinPriority_lua()

int SDOM::getMinPriority_lua

(

const IDisplayObject *

obj

)

getMouseHoveredObject_lua()

DisplayHandle SDOM::getMouseHoveredObject_lua

(

)

getName_handle_lua()

std::string SDOM::getName_handle_lua

(

DisplayHandle &

self

)

getName_lua()

std::string SDOM::getName_lua

(

const IDisplayObject *

obj

)

getOrphanedDisplayObjects_lua()

std::vector< DisplayHandle > SDOM::getOrphanedDisplayObjects_lua

(

)

getOrphanGrace_lua()

int SDOM::getOrphanGrace_lua

(

const IDisplayObject *

obj

)

getOrphanRetentionPolicyString_lua()

std::string SDOM::getOrphanRetentionPolicyString_lua

(

IDisplayObject *

obj

)

getParent_lua()

DisplayHandle SDOM::getParent_lua

(

const IDisplayObject *

obj

)

getPriority_lua()

int SDOM::getPriority_lua

(

const IDisplayObject *

obj

)

getRenderer()

SDL_Renderer * SDOM::getRenderer

(

)

getRight_lua()

float SDOM::getRight_lua

(

const IDisplayObject *

obj

)

getRoot_lua()

DisplayHandle SDOM::getRoot_lua

(

)

getStage()

Stage * SDOM::getStage

(

)

getStage_lua()

DisplayHandle SDOM::getStage_lua

(

)

getStageHandle()

DisplayHandle SDOM::getStageHandle

(

)

getTabPriority_lua()

int SDOM::getTabPriority_lua

(

const IDisplayObject *

obj

)

getTexture()

SDL_Texture * SDOM::getTexture

(

)

getTop_lua()

float SDOM::getTop_lua

(

const IDisplayObject *

obj

)

getType_lua()

std::string SDOM::getType_lua

(

const IDisplayObject *

obj

)

getWidth_lua()

int SDOM::getWidth_lua

(

const IDisplayObject *

obj

)

getWindow()

SDL_Window * SDOM::getWindow

(

)

getWindowTitle_lua()

std::string SDOM::getWindowTitle_lua

(

)

getX_lua()

int SDOM::getX_lua

(

const IDisplayObject *

obj

)

getY_lua()

int SDOM::getY_lua

(

const IDisplayObject *

obj

)

getZOrder_lua()

int SDOM::getZOrder_lua

(

const IDisplayObject *

obj

)

hasAssetObject_lua()

bool SDOM::hasAssetObject_lua

(

const std::string &

name

)

hasChild_lua()

bool SDOM::hasChild_lua	(	const IDisplayObject *	obj,
		DisplayHandle	child
	)

hasDisplayObject_lua()

bool SDOM::hasDisplayObject_lua

(

const std::string &

name

)

icon_index_from_name()

static std::optional< IconIndex > SDOM::icon_index_from_name ( const std::string &  name )

inlinestatic

icon_name_from_index()

static std::optional< std::string > SDOM::icon_name_from_index ( IconIndex  idx )

inlinestatic

isAncestorOf_lua() [1/2]

bool SDOM::isAncestorOf_lua	(	IDisplayObject *	obj,
		const std::string &	name
	)

isAncestorOf_lua() [2/2]

bool SDOM::isAncestorOf_lua	(	IDisplayObject *	obj,
		DisplayHandle	descendant
	)

isClickable_lua()

bool SDOM::isClickable_lua

(

const IDisplayObject *

obj

)

isDescendantOf_lua() [1/2]

bool SDOM::isDescendantOf_lua	(	IDisplayObject *	obj,
		const std::string &	name
	)

isDescendantOf_lua() [2/2]

bool SDOM::isDescendantOf_lua	(	IDisplayObject *	obj,
		DisplayHandle	ancestor
	)

isDirty_lua()

bool SDOM::isDirty_lua

(

const IDisplayObject *

obj

)

isEnabled_lua()

bool SDOM::isEnabled_lua

(

const IDisplayObject *

obj

)

isHidden_lua()

bool SDOM::isHidden_lua

(

const IDisplayObject *

obj

)

isKeyboardFocused_lua()

bool SDOM::isKeyboardFocused_lua

(

const IDisplayObject *

obj

)

isMouseHovered_lua()

bool SDOM::isMouseHovered_lua

(

const IDisplayObject *

obj

)

isTabEnabled_lua()

bool SDOM::isTabEnabled_lua

(

const IDisplayObject *

obj

)

isVisible_lua()

bool SDOM::isVisible_lua

(

const IDisplayObject *

obj

)

listDisplayObjectNames_lua()

std::vector< std::string > SDOM::listDisplayObjectNames_lua

(

)

moveToTop_lua()

void SDOM::moveToTop_lua

(

IDisplayObject *

obj

)

moveToTop_lua_any()

void SDOM::moveToTop_lua_any	(	IDisplayObject *	obj,
		const sol::object &	descriptor
	)

normalizeAnchorString()

std::string SDOM::normalizeAnchorString

(

const std::string &

s

)

operator!=()

bool SDOM::operator!= ( const SDOM::FontStyle &  a, const SDOM::FontStyle &  b  )

inline

operator<()

bool SDOM::operator< ( const IAssetObject &  a, const IAssetObject &  b  )

inline

operator<=()

bool SDOM::operator<= ( const IAssetObject &  a, const IAssetObject &  b  )

inline

operator==() [1/2]

bool SDOM::operator== ( const IAssetObject &  a, const IAssetObject &  b  )

inline

operator==() [2/2]

bool SDOM::operator== ( const SDOM::FontStyle &  a, const SDOM::FontStyle &  b  )

inline

orphanPolicyFromString_lua()

IDisplayObject::OrphanRetentionPolicy SDOM::orphanPolicyFromString_lua	(	IDisplayObject *	obj,
		const std::string &	s
	)

orphanPolicyToString_lua()

std::string SDOM::orphanPolicyToString_lua	(	IDisplayObject *	obj,
		IDisplayObject::OrphanRetentionPolicy	p
	)

parseColor()

SDL_Color SDOM::parseColor

(

const sol::object &

colorObj

)

printMessageBox()

void SDOM::printMessageBox	(	const std::string &	title,
		const std::string &	message,
		const std::string &	file,
		int	line,
		const std::string &	colorTitle,
		const std::string &	colorMsg,
		const std::string &	colorBorder
	)

printObjectRegistry_lua()

void SDOM::printObjectRegistry_lua

(

)

printTree_lua()

void SDOM::printTree_lua

(

const IDisplayObject *

obj

)

pumpEventsOnce_lua()

void SDOM::pumpEventsOnce_lua

(

)

pushKeyboardEvent_lua()

void SDOM::pushKeyboardEvent_lua

(

const sol::object &

args

)

pushMouseEvent_lua()

void SDOM::pushMouseEvent_lua

(

const sol::object &

args

)

quit()

void SDOM::quit

(

)

quit_lua()

void SDOM::quit_lua

(

)

registerOn_lua()

void SDOM::registerOn_lua	(	const std::string &	name,
		const sol::function &	f
	)

registerOnEvent_lua()

void SDOM::registerOnEvent_lua

(

std::function< void(const Event &)>

fn

)

registerOnInit_lua()

void SDOM::registerOnInit_lua

(

std::function< bool()>

fn

)

registerOnQuit_lua()

void SDOM::registerOnQuit_lua

(

std::function< void()>

fn

)

registerOnRender_lua()

void SDOM::registerOnRender_lua

(

std::function< void()>

fn

)

registerOnUnitTest_lua()

void SDOM::registerOnUnitTest_lua

(

std::function< bool()>

fn

)

registerOnUpdate_lua()

void SDOM::registerOnUpdate_lua

(

std::function< void(float)>

fn

)

registerOnWindowResize_lua()

void SDOM::registerOnWindowResize_lua

(

std::function< void(int, int)>

fn

)

removeChild_lua() [1/2]

bool SDOM::removeChild_lua	(	IDisplayObject *	obj,
		const std::string &	name
	)

removeChild_lua() [2/2]

bool SDOM::removeChild_lua	(	IDisplayObject *	obj,
		DisplayHandle	child
	)

removeDescendant_lua() [1/2]

bool SDOM::removeDescendant_lua	(	IDisplayObject *	obj,
		const std::string &	descendantName
	)

removeDescendant_lua() [2/2]

bool SDOM::removeDescendant_lua	(	IDisplayObject *	obj,
		DisplayHandle	descendant
	)

removeEventListener_lua()

void SDOM::removeEventListener_lua	(	IDisplayObject *	obj,
		EventType &	type,
		sol::function	listener,
		bool	useCapture
	)

removeEventListener_lua_any()

void SDOM::removeEventListener_lua_any	(	IDisplayObject *	obj,
		const sol::object &	descriptor,
		const sol::object &	maybe_listener,
		const sol::object &	maybe_useCapture
	)

removeEventListener_lua_any_short()

void SDOM::removeEventListener_lua_any_short	(	IDisplayObject *	obj,
		const sol::object &	descriptor
	)

removeFromParent_lua()

bool SDOM::removeFromParent_lua

(

IDisplayObject *

obj

)

set_if_absent() [1/2]

static void SDOM::set_if_absent ( sol::table &  handle, const char *  name, auto &&  fn  )

inlinestatic

set_if_absent() [2/2]

static void SDOM::set_if_absent ( sol::table &  handle, const char *  name, auto &&  fn  )

inlinestatic

setAnchorBottom_lua()

void SDOM::setAnchorBottom_lua	(	IDisplayObject *	obj,
		AnchorPoint	ap
	)

setAnchorLeft_lua()

void SDOM::setAnchorLeft_lua	(	IDisplayObject *	obj,
		AnchorPoint	ap
	)

setAnchorRight_lua()

void SDOM::setAnchorRight_lua	(	IDisplayObject *	obj,
		AnchorPoint	ap
	)

setAnchorTop_lua()

void SDOM::setAnchorTop_lua	(	IDisplayObject *	obj,
		AnchorPoint	ap
	)

setBottom_lua()

void SDOM::setBottom_lua	(	IDisplayObject *	obj,
		float	p_bottom
	)

setBounds_lua() [1/2]

void SDOM::setBounds_lua	(	IDisplayObject *	obj,
		const Bounds &	b
	)

setBounds_lua() [2/2]

void SDOM::setBounds_lua	(	IDisplayObject *	obj,
		const sol::object &	bobj
	)

setClickable_lua()

void SDOM::setClickable_lua	(	IDisplayObject *	obj,
		bool	clickable
	)

setColor_lua() [1/2]

void SDOM::setColor_lua	(	IDisplayObject *	obj,
		const SDL_Color &	color
	)

setColor_lua() [2/2]

void SDOM::setColor_lua	(	IDisplayObject *	obj,
		const sol::object &	colorObj
	)

setDirty_lua()

void SDOM::setDirty_lua

(

IDisplayObject *

obj

)

setEnabled_lua()

void SDOM::setEnabled_lua	(	IDisplayObject *	obj,
		bool	enabled
	)

setHeight_lua()

void SDOM::setHeight_lua	(	IDisplayObject *	obj,
		int	height
	)

setHidden_lua()

void SDOM::setHidden_lua	(	IDisplayObject *	obj,
		bool	hidden
	)

setIsTraversing_lua()

void SDOM::setIsTraversing_lua

(

bool

traversing

)

setKeyboardFocus_lua()

void SDOM::setKeyboardFocus_lua

(

IDisplayObject *

obj

)

setKeyboardFocusedObject_lua()

void SDOM::setKeyboardFocusedObject_lua

(

const DisplayHandle &

handle

)

setLeft_lua()

void SDOM::setLeft_lua	(	IDisplayObject *	obj,
		float	p_left
	)

setLocalBottom_lua()

void SDOM::setLocalBottom_lua	(	IDisplayObject *	obj,
		float	p_bottom
	)

setLocalLeft_lua()

void SDOM::setLocalLeft_lua	(	IDisplayObject *	obj,
		float	p_left
	)

setLocalRight_lua()

void SDOM::setLocalRight_lua	(	IDisplayObject *	obj,
		float	p_right
	)

setLocalTop_lua()

void SDOM::setLocalTop_lua	(	IDisplayObject *	obj,
		float	p_top
	)

setMouseHoveredObject_lua()

void SDOM::setMouseHoveredObject_lua

(

const DisplayHandle &

handle

)

setName_lua()

void SDOM::setName_lua	(	IDisplayObject *	obj,
		const std::string &	newName
	)

setOrphanGrace_lua()

void SDOM::setOrphanGrace_lua	(	IDisplayObject *	obj,
		std::chrono::milliseconds	grace
	)

setOrphanRetentionPolicy_lua()

void SDOM::setOrphanRetentionPolicy_lua	(	IDisplayObject *	obj,
		const std::string &	policyStr
	)

setParent_lua()

void SDOM::setParent_lua	(	IDisplayObject *	obj,
		const DisplayHandle &	parent
	)

setPriority_lua()

void SDOM::setPriority_lua	(	IDisplayObject *	obj,
		int	priority
	)

setPriority_lua_any()

void SDOM::setPriority_lua_any	(	IDisplayObject *	obj,
		const sol::object &	descriptor
	)

setPriority_lua_target()

void SDOM::setPriority_lua_target	(	IDisplayObject *	obj,
		const sol::object &	descriptor,
		int	value
	)

setRight_lua()

void SDOM::setRight_lua	(	IDisplayObject *	obj,
		float	p_right
	)

setRootNode_lua()

void SDOM::setRootNode_lua

(

const DisplayHandle &

handle

)

setRootNodeByName_lua()

void SDOM::setRootNodeByName_lua

(

const std::string &

name

)

setStage_lua()

void SDOM::setStage_lua

(

const DisplayHandle &

handle

)

setStageByName_lua()

void SDOM::setStageByName_lua

(

const std::string &

name

)

setTabEnabled_lua()

void SDOM::setTabEnabled_lua	(	IDisplayObject *	obj,
		bool	enabled
	)

setTabPriority_lua()

void SDOM::setTabPriority_lua	(	IDisplayObject *	obj,
		int	index
	)

setToHighestPriority_lua()

void SDOM::setToHighestPriority_lua

(

IDisplayObject *

obj

)

setToHighestPriority_lua_any()

void SDOM::setToHighestPriority_lua_any	(	IDisplayObject *	obj,
		const sol::object &	descriptor
	)

setToLowestPriority_lua()

void SDOM::setToLowestPriority_lua

(

IDisplayObject *

obj

)

setToLowestPriority_lua_any()

void SDOM::setToLowestPriority_lua_any	(	IDisplayObject *	obj,
		const sol::object &	descriptor
	)

setTop_lua()

void SDOM::setTop_lua	(	IDisplayObject *	obj,
		float	p_top
	)

setType_lua()

void SDOM::setType_lua	(	IDisplayObject *	obj,
		const std::string &	newType
	)

setVisible_lua()

void SDOM::setVisible_lua	(	IDisplayObject *	obj,
		bool	visible
	)

setWidth_lua()

void SDOM::setWidth_lua	(	IDisplayObject *	obj,
		int	width
	)

setWindowTitle_lua()

void SDOM::setWindowTitle_lua

(

const std::string &

title

)

setX_lua()

void SDOM::setX_lua	(	IDisplayObject *	obj,
		int	p_x
	)

setY_lua()

void SDOM::setY_lua	(	IDisplayObject *	obj,
		int	p_y
	)

setZOrder_lua()

void SDOM::setZOrder_lua	(	IDisplayObject *	obj,
		int	z_order
	)

setZOrder_lua_any()

void SDOM::setZOrder_lua_any	(	IDisplayObject *	obj,
		const sol::object &	descriptor
	)

showWarning()

void SDOM::showWarning	(	const std::string &	message,
		const std::string &	file,
		int	line
	)

shutdown()

void SDOM::shutdown

(

)

shutdown_lua()

void SDOM::shutdown_lua

(

)

sortChildrenByPriority_lua()

void SDOM::sortChildrenByPriority_lua

(

IDisplayObject *

obj

)

trim()

static std::string SDOM::trim ( const std::string &  s )

static

tristate_index_from_name()

static std::optional< TriState > SDOM::tristate_index_from_name ( const std::string &  name )

inlinestatic

tristate_name_from_index()

static std::optional< std::string > SDOM::tristate_name_from_index ( TriState  idx )

inlinestatic

validateAnchorAssignments()

bool SDOM::validateAnchorAssignments

(

const sol::table &

config

)

validateAnchorPointString()

bool SDOM::validateAnchorPointString

(

const std::string &

anchorString

)

Variable Documentation

anchorPointToString_

const std::unordered_map<AnchorPoint, std::string> SDOM::anchorPointToString_

inlinestatic

Initial value:

= {
        { AnchorPoint::TOP_LEFT,     "top_left" },
        { AnchorPoint::TOP_CENTER,   "top_center" },
        { AnchorPoint::TOP_RIGHT,    "top_right" },
        { AnchorPoint::MIDDLE_LEFT,  "middle_left" },
        { AnchorPoint::MIDDLE_CENTER,"middle_center" },
        { AnchorPoint::MIDDLE_RIGHT, "middle_right" },
        { AnchorPoint::BOTTOM_LEFT,  "bottom_left" },
        { AnchorPoint::BOTTOM_CENTER,"bottom_center" },
        { AnchorPoint::BOTTOM_RIGHT, "bottom_right" }
    }

Maps AnchorPoint enum values to their corresponding string names.

Used for serialization, debugging, and user interface display. Only the main anchor points are included; aliases are omitted for clarity.

Example usage: std::string name = anchorPointToString_.at(AnchorPoint::TOP_LEFT); // "top_left"

draggedObject

DisplayHandle SDOM::draggedObject = nullptr

static

icon_index_to_string

const std::unordered_map<int, std::string> SDOM::icon_index_to_string

inlinestatic

Initial value:

= {
        { static_cast<int>(IconIndex::Hamburger), "hamburger" },
        { static_cast<int>(IconIndex::Arrow_Left_Raised), "arrow_left_raised" },
        { static_cast<int>(IconIndex::Arrow_Right_Raised), "arrow_right_raised" },
        { static_cast<int>(IconIndex::Arrow_Up_Raised), "arrow_up_raised" },
        { static_cast<int>(IconIndex::Arrow_Down_Raised), "arrow_down_raised" },
        { static_cast<int>(IconIndex::Arrow_Left_Depressed), "arrow_left_depressed" },
        { static_cast<int>(IconIndex::Arrow_Right_Depressed), "arrow_right_depressed" },
        { static_cast<int>(IconIndex::Arrow_Up_Depressed), "arrow_up_depressed" },
        { static_cast<int>(IconIndex::Arrow_Down_Depressed), "arrow_down_depressed" },
        { static_cast<int>(IconIndex::Knob_Horizontal), "knob_horizontal" },
        { static_cast<int>(IconIndex::Knob_Vertical), "knob_vertical" },
        { static_cast<int>(IconIndex::Slider_Tick), "slider_tick" },
        { static_cast<int>(IconIndex::HSlider_Rail), "hslider_rail" },
        { static_cast<int>(IconIndex::VSlider_Rail), "vslider_rail" },
        { static_cast<int>(IconIndex::Checkbox_Empty), "empty_checkbox" },
        { static_cast<int>(IconIndex::Checkbox_Checked), "checked_checkbox" },
        { static_cast<int>(IconIndex::Checkbox_X), "x_checkbox" },
        { static_cast<int>(IconIndex::Radiobox_Unselected), "radiobox_unselected" },
        { static_cast<int>(IconIndex::Radiobox_Selected), "radiobox_selected" },
        { static_cast<int>(IconIndex::HProgress_Left), "hprogress_left" },
        { static_cast<int>(IconIndex::HProgress_Empty), "hprogress_empty" },
        { static_cast<int>(IconIndex::HProgress_Thumb), "hprogress_thumb" },
        { static_cast<int>(IconIndex::HProgress_Right), "hprogress_right" },
        { static_cast<int>(IconIndex::VProgress_Top), "vprogress_top" },
        { static_cast<int>(IconIndex::VProgress_Empty), "vprogress_empty" },
        { static_cast<int>(IconIndex::VProgress_Thumb), "vprogress_thumb" },
        { static_cast<int>(IconIndex::VProgress_Bottom), "vprogress_bottom" }
    }

icon_string_to_index

const std::unordered_map<std::string, int> SDOM::icon_string_to_index

inlinestatic

Initial value:

= []{
        std::unordered_map<std::string,int> m;
        for (auto &p : icon_index_to_string) m.emplace(p.second, p.first);
        return m;
    }()

internal_font_8x12

unsigned char SDOM::internal_font_8x12

internal_font_8x12_len

unsigned int SDOM::internal_font_8x12_len = 3340

internal_font_8x8

unsigned char SDOM::internal_font_8x8

internal_font_8x8_len

unsigned int SDOM::internal_font_8x8_len = 2885

internal_icon_8x8

unsigned char SDOM::internal_icon_8x8

internal_icon_8x8_len

unsigned int SDOM::internal_icon_8x8_len = 1305

internal_ttf

unsigned char SDOM::internal_ttf

internal_ttf_len

unsigned int SDOM::internal_ttf_len = 455188

isDragging

bool SDOM::isDragging = false

static

maxOutlineThickness

constexpr int SDOM::maxOutlineThickness = 3

constexpr

panelBaseIndexToString_

const std::unordered_map<PanelBaseIndex, std::string> SDOM::panelBaseIndexToString_

inlinestatic

Initial value:

= 
    {
        { PanelBaseIndex::ButtonUp,         "button_up" },
        { PanelBaseIndex::ButtonUpSelected, "button_up_selected" },
        { PanelBaseIndex::ButtonDown,       "button_down" },
        { PanelBaseIndex::ButtonDownSelected, "button_down_selected" },
        { PanelBaseIndex::Frame,            "frame" },
        { PanelBaseIndex::Group,            "group" }
    }

panelTileOffsetToString_

const std::unordered_map<PanelTileOffset, std::string> SDOM::panelTileOffsetToString_

inlinestatic

Initial value:

= 
    {
        { PanelTileOffset::TopLeft,      "top_left" },
        { PanelTileOffset::TopCenter,    "top_center" },
        { PanelTileOffset::TopRight,     "top_right" },
        { PanelTileOffset::LeftCenter,   "left_center" },
        { PanelTileOffset::Center,       "center" },
        { PanelTileOffset::RightCenter,  "right_center" },
        { PanelTileOffset::BottomLeft,   "bottom_left" },
        { PanelTileOffset::BottomCenter, "bottom_center" },
        { PanelTileOffset::BottomRight,  "bottom_right" }
    }

stringToAnchorPoint_

const std::unordered_map<std::string, AnchorPoint> SDOM::stringToAnchorPoint_

inlinestatic

Maps string names to AnchorPoint enum values.

Supports multiple naming conventions for flexibility and user convenience:

• Standard names (e.g., "top_left", "center")
• Reversed keys (e.g., "center_middle", "right_top")
• Hyphenated names (e.g., "top-left", "bottom-center")
• Boolean OR style (e.g., "top|left", "center|bottom")

Supported mappings:

String Key	AnchorPoint Value
"default"	DEFAULT
"left"	LEFT
"center"	CENTER
"right"	RIGHT
"top"	TOP
"top_left"	TOP_LEFT
"top_center"	TOP_CENTER
"top_right"	TOP_RIGHT
"middle"	MIDDLE
"middle_left"	MIDDLE_LEFT
"middle_center"	MIDDLE_CENTER
"middle_right"	MIDDLE_RIGHT
"bottom"	BOTTOM
"bottom_left"	BOTTOM_LEFT
"bottom_center"	BOTTOM_CENTER
"bottom_right"	BOTTOM_RIGHT
"center_middle"	MIDDLE_CENTER
"right_middle"	MIDDLE_RIGHT
"left_middle"	MIDDLE_LEFT
"center_top"	TOP_CENTER
"right_top"	TOP_RIGHT
"left_top"	TOP_LEFT
"center_bottom"	BOTTOM_CENTER
"right_bottom"	BOTTOM_RIGHT
"left_bottom"	BOTTOM_LEFT

Example usage: AnchorPoint ap = stringToAnchorPoint_.at("center_middle"); // AnchorPoint::MIDDLE_CENTER

stringToPanelBaseIndex_

const std::unordered_map<std::string, PanelBaseIndex> SDOM::stringToPanelBaseIndex_

inlinestatic

Initial value:

= 
    {
        { "button_up",          PanelBaseIndex::ButtonUp },
        { "button_up_selected", PanelBaseIndex::ButtonUpSelected },
        { "button_down",        PanelBaseIndex::ButtonDown },
        { "button_down_selected", PanelBaseIndex::ButtonDownSelected },
        { "frame",              PanelBaseIndex::Frame },
        { "group",              PanelBaseIndex::Group }
    }

stringToPanelTileOffset_

const std::unordered_map<std::string, PanelTileOffset> SDOM::stringToPanelTileOffset_

inlinestatic

Initial value:

= 
    {
        { "top_left",     PanelTileOffset::TopLeft },
        { "top_center",   PanelTileOffset::TopCenter },
        { "top_right",    PanelTileOffset::TopRight },
        { "left_center",  PanelTileOffset::LeftCenter },
        { "center",       PanelTileOffset::Center },
        { "right_center", PanelTileOffset::RightCenter },
        { "bottom_left",  PanelTileOffset::BottomLeft },
        { "bottom_center",PanelTileOffset::BottomCenter },
        { "bottom_right", PanelTileOffset::BottomRight }
    }

tristate_string_to_index

const std::unordered_map<std::string, int> SDOM::tristate_string_to_index

inlinestatic

Initial value:

= []{
        std::unordered_map<std::string,int> m;
        for (auto &p : tristate_to_string) m.emplace(p.second, p.first);
        return m;
    }()

tristate_to_string

const std::unordered_map<int, std::string> SDOM::tristate_to_string

inlinestatic

Initial value:

= {
        { static_cast<int>(TriState::Unchecked), "unchecked" },
        { static_cast<int>(TriState::Checked), "checked" },
        { static_cast<int>(TriState::Indeterminate), "indeterminate" },
    }