Implement runtime UI workflow and editor integration

Dependencies/clay/LICENSE.md

@@ -0,0 +1,22 @@
+zlib/libpng license
+
+Copyright (c) 2024 Nic Barker
+
+This software is provided 'as-is', without any express or implied warranty.
+In no event will the authors be held liable for any damages arising from the
+use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+    1. The origin of this software must not be misrepresented; you must not
+    claim that you wrote the original software. If you use this software in a
+    product, an acknowledgment in the product documentation would be
+    appreciated but is not required.
+
+    2. Altered source versions must be plainly marked as such, and must not
+    be misrepresented as being the original software.
+
+    3. This notice may not be removed or altered from any source
+    distribution.

Resources/Engine/Lua/Components/Canvas.lua

@@ -0,0 +1,48 @@
+---@meta
+
+--- Defines how a Canvas scales UI elements
+---@enum CanvasScalerMode
+CanvasScalerMode = {
+	CONSTANT_PIXEL_SIZE = 0,
+	SCALE_WITH_SCREEN_SIZE = 1
+}
+
+--- Represents a root canvas for in-game user interface elements
+---@class Canvas : Component
+Canvas = {}
+
+--- Returns the actor that owns this component
+---@return Actor
+function Canvas:GetOwner() end
+
+--- Returns the reference resolution used by the canvas
+---@return Vector2
+function Canvas:GetReferenceResolution() end
+
+--- Defines the reference resolution used by the canvas
+---@param referenceResolution Vector2
+function Canvas:SetReferenceResolution(referenceResolution) end
+
+--- Returns the canvas scale factor
+---@return number
+function Canvas:GetScaleFactor() end
+
+--- Defines the canvas scale factor
+---@param scaleFactor number
+function Canvas:SetScaleFactor(scaleFactor) end
+
+--- Returns the number of UI pixels represented by one world unit
+---@return number
+function Canvas:GetPixelsPerUnit() end
+
+--- Defines the number of UI pixels represented by one world unit
+---@param pixelsPerUnit number
+function Canvas:SetPixelsPerUnit(pixelsPerUnit) end
+
+--- Returns the canvas scaler mode
+---@return CanvasScalerMode
+function Canvas:GetScalerMode() end
+
+--- Defines the canvas scaler mode
+---@param scalerMode CanvasScalerMode
+function Canvas:SetScalerMode(scalerMode) end

Resources/Engine/Lua/Components/Image.lua

@@ -0,0 +1,33 @@
+---@meta
+
+--- Represents a renderable user interface image
+---@class Image : Component
+Image = {}
+
+--- Returns the actor that owns this component
+---@return Actor
+function Image:GetOwner() end
+
+--- Returns the texture rendered by the image
+---@return Texture|nil
+function Image:GetTexture() end
+
+--- Defines the texture rendered by the image
+---@param texture Texture|nil
+function Image:SetTexture(texture) end
+
+--- Returns the image size
+---@return Vector2
+function Image:GetSize() end
+
+--- Defines the image size
+---@param size Vector2
+function Image:SetSize(size) end
+
+--- Returns the image tint
+---@return Vector4
+function Image:GetTint() end
+
+--- Defines the image tint
+---@param tint Vector4
+function Image:SetTint(tint) end

Resources/Engine/Lua/Components/LayoutGroup.lua

@@ -0,0 +1,78 @@
+---@meta
+
+--- Defines how a LayoutGroup arranges direct UI children
+---@enum LayoutDirection
+LayoutDirection = {
+	HORIZONTAL = 0,
+	VERTICAL = 1
+}
+
+---@enum LayoutHorizontalAlignment
+LayoutHorizontalAlignment = {
+	LEFT = 0,
+	CENTER = 1,
+	RIGHT = 2
+}
+
+---@enum LayoutVerticalAlignment
+LayoutVerticalAlignment = {
+	TOP = 0,
+	CENTER = 1,
+	BOTTOM = 2
+}
+
+--- Arranges direct user interface children along an axis
+---@class LayoutGroup : Component
+LayoutGroup = {}
+
+--- Returns the actor that owns this component
+---@return Actor
+function LayoutGroup:GetOwner() end
+
+--- Returns the layout direction
+---@return LayoutDirection
+function LayoutGroup:GetDirection() end
+
+--- Defines the layout direction
+---@param direction LayoutDirection
+function LayoutGroup:SetDirection(direction) end
+
+--- Returns the spacing between children
+---@return number
+function LayoutGroup:GetSpacing() end
+
+--- Defines the non-negative spacing between children
+---@param spacing number
+function LayoutGroup:SetSpacing(spacing) end
+
+--- Returns the minimum layout container size
+---@return Vector2
+function LayoutGroup:GetSize() end
+
+--- Defines the minimum layout container size
+---@param size Vector2
+function LayoutGroup:SetSize(size) end
+
+--- Returns the layout padding as left, right, top, bottom
+---@return Vector4
+function LayoutGroup:GetPadding() end
+
+--- Defines the layout padding as left, right, top, bottom
+---@param padding Vector4
+function LayoutGroup:SetPadding(padding) end
+
+--- Returns the horizontal children alignment
+---@return LayoutHorizontalAlignment
+function LayoutGroup:GetHorizontalAlignment() end
+
+--- Defines the horizontal children alignment
+---@param alignment LayoutHorizontalAlignment
+function LayoutGroup:SetHorizontalAlignment(alignment) end
+
+--- Returns the vertical children alignment
+---@return LayoutVerticalAlignment
+function LayoutGroup:GetVerticalAlignment() end
+
+--- Defines the vertical children alignment
+---@param alignment LayoutVerticalAlignment
+function LayoutGroup:SetVerticalAlignment(alignment) end

Resources/Engine/Lua/Components/Text.lua

@@ -0,0 +1,79 @@
+---@meta
+
+---@enum TextHorizontalAlignment
+TextHorizontalAlignment = {
+	LEFT = 0,
+	CENTER = 1,
+	RIGHT = 2
+}
+
+---@enum TextVerticalAlignment
+TextVerticalAlignment = {
+	TOP = 0,
+	CENTER = 1,
+	BOTTOM = 2
+}
+
+--- Represents a renderable user interface text
+---@class Text : Component
+Text = {}
+
+--- Returns the actor that owns this component
+---@return Actor
+function Text:GetOwner() end
+
+--- Returns the text content
+---@return string
+function Text:GetText() end
+
+--- Defines the text content
+---@param text string
+function Text:SetText(text) end
+
+--- Returns the font resource path
+---@return string
+function Text:GetFontPath() end
+
+--- Defines the font resource path
+---@param fontPath string
+function Text:SetFontPath(fontPath) end
+
+--- Returns the font size in canvas pixels
+---@return number
+function Text:GetFontSize() end
+
+--- Defines the font size in canvas pixels
+---@param fontSize number
+function Text:SetFontSize(fontSize) end
+
+--- Returns the text color
+---@return Vector4
+function Text:GetColor() end
+
+--- Defines the text color
+---@param color Vector4
+function Text:SetColor(color) end
+
+--- Returns the text extents in canvas pixels
+---@return Vector2
+function Text:GetExtents() end
+
+--- Defines the text extents in canvas pixels
+---@param extents Vector2
+function Text:SetExtents(extents) end
+
+--- Returns the horizontal text alignment
+---@return TextHorizontalAlignment
+function Text:GetHorizontalAlignment() end
+
+--- Defines the horizontal text alignment
+---@param alignment TextHorizontalAlignment
+function Text:SetHorizontalAlignment(alignment) end
+
+--- Returns the vertical text alignment
+---@return TextVerticalAlignment
+function Text:GetVerticalAlignment() end
+
+--- Defines the vertical text alignment
+---@param alignment TextVerticalAlignment
+function Text:SetVerticalAlignment(alignment) end

Resources/Engine/Lua/Components/Transform2D.lua

@@ -0,0 +1,55 @@
+---@meta
+
+--- Represents 2D transformations applied to a user interface actor
+---@class Transform2D : Component
+Transform2D = {}
+
+--- Defines the anchor preset used by Transform2D
+---@enum AnchorPreset
+AnchorPreset = {
+	TOP_LEFT = 0,
+	TOP_CENTER = 1,
+	TOP_RIGHT = 2,
+	MIDDLE_LEFT = 3,
+	CENTER = 4,
+	MIDDLE_RIGHT = 5,
+	BOTTOM_LEFT = 6,
+	BOTTOM_CENTER = 7,
+	BOTTOM_RIGHT = 8
+}
+
+--- Returns the actor that owns this component
+---@return Actor
+function Transform2D:GetOwner() end
+
+--- Returns the 2D position
+---@return Vector2
+function Transform2D:GetPosition() end
+
+--- Defines the 2D position
+---@param position Vector2
+function Transform2D:SetPosition(position) end
+
+--- Returns the 2D rotation in degrees
+---@return number
+function Transform2D:GetRotation() end
+
+--- Defines the 2D rotation in degrees
+---@param rotation number
+function Transform2D:SetRotation(rotation) end
+
+--- Returns the 2D scale
+---@return Vector2
+function Transform2D:GetScale() end
+
+--- Defines the 2D scale
+---@param scale Vector2
+function Transform2D:SetScale(scale) end
+
+--- Returns the anchor preset
+---@return AnchorPreset
+function Transform2D:GetAnchorPreset() end
+
+--- Defines the anchor preset
+---@param anchorPreset AnchorPreset
+function Transform2D:SetAnchorPreset(anchorPreset) end

Resources/Engine/Lua/Scene/Actor.lua

@@ -146,6 +146,26 @@ function Actor:GetPostProcessStack() end
 ---@return ReflectionProbe|nil
 function Actor:GetReflectionProbe() end
 
+--- Returns the Canvas attached to this actor (If any)
+---@return Canvas|nil
+function Actor:GetCanvas() end
+
+--- Returns the Image attached to this actor (If any)
+---@return Image|nil
+function Actor:GetImage() end
+
+--- Returns the LayoutGroup attached to this actor (If any)
+---@return LayoutGroup|nil
+function Actor:GetLayoutGroup() end
+
+--- Returns the Text attached to this actor (If any)
+---@return Text|nil
+function Actor:GetText() end
+
+--- Returns the Transform2D attached to this actor (If any)
+---@return Transform2D|nil
+function Actor:GetTransform2D() end
+
 --- Returns the Behaviour of the given type attached to this actor (If any)
 ---@param name string
 ---@return table|nil
@@ -219,6 +239,26 @@ function Actor:AddPostProcessStack() end
 ---@return ReflectionProbe
 function Actor:AddReflectionProbe() end
 
+--- Adds a Canvas component to the actor and returns it
+---@return Canvas
+function Actor:AddCanvas() end
+
+--- Adds an Image component to the actor and returns it
+---@return Image
+function Actor:AddImage() end
+
+--- Adds a LayoutGroup component to the actor and returns it
+---@return LayoutGroup
+function Actor:AddLayoutGroup() end
+
+--- Adds a Text component to the actor and returns it
+---@return Text
+function Actor:AddText() end
+
+--- Adds a Transform2D component to the actor and returns it
+---@return Transform2D
+function Actor:AddTransform2D() end
+
 --- Removes the ModelRenderer component from the actor
 function Actor:RemoveModelRenderer() end
 --- Removes the PhysicalBox component from the actor
@@ -251,6 +291,16 @@ function Actor:RemoveAudioListener() end
 function Actor:RemovePostProcessStack() end
 --- Removes the ReflectionProbe component from the actor
 function Actor:RemoveReflectionProbe() end
+--- Removes the Canvas component from the actor
+function Actor:RemoveCanvas() end
+--- Removes the Image component from the actor
+function Actor:RemoveImage() end
+--- Removes the LayoutGroup component from the actor
+function Actor:RemoveLayoutGroup() end
+--- Removes the Text component from the actor
+function Actor:RemoveText() end
+--- Removes the Transform2D component from the actor
+function Actor:RemoveTransform2D() end
 
 --- Adds a behaviour of given type to the actor and returns it
 ---@param name string