@quenty/uiobjectutils 3.3.0 → 3.4.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/uiobjectutils@3.3.0...@quenty/uiobjectutils@3.4.0) (2023-05-26)
+
+
+### Bug Fixes
+
+* Better error message with radius ([c4952fb](https://github.com/Quenty/NevermoreEngine/commit/c4952fbe364847051f82173dca4631df0ff137c7))
+
+
+### Features
+
+* Add UIAlignmentUtils.toNumber(alignment) and UIAlignmentUtils.toBias(alignment) ([8092aba](https://github.com/Quenty/NevermoreEngine/commit/8092aba1cc564daaf5c775cb23f3c2131005da80))
+* Add UIAlignmentUtils.verticalAlignmentToBias(verticalAlignment) and UIAlignmentUtils.horizontalAlignmentToBias(horizontalAlignment) ([fb98622](https://github.com/Quenty/NevermoreEngine/commit/fb98622dad4ca05bf28ecf90b55521c6d48f9b38))
+
+
+
+
+
 # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/uiobjectutils@3.2.0...@quenty/uiobjectutils@3.3.0) (2023-04-24)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/uiobjectutils",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "UI object utils library for Roblox",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a8a760988c8fd88c2581c5c496a8bad845de104c"
+  "gitHead": "11058e90e51ea83d3dad6ae9abe59cc19c36b94b"
 }

package/src/Client/UIAlignmentUtils.lua

@@ -1,39 +1,132 @@
 --[=[
+	Utility methods for working with horizontal and vertical alignment
 	@class UIAlignmentUtils
 ]=]
 
 local UIAlignmentUtils = {}
 
+local HORIZONTAL_ALIGNMENT = {
+	[Enum.HorizontalAlignment.Left] = 0;
+	[Enum.HorizontalAlignment.Center] = 0.5;
+	[Enum.HorizontalAlignment.Right] = 1;
+}
+
+local HORIZONTAL_BIAS = {
+	[Enum.HorizontalAlignment.Left] = -1;
+	[Enum.HorizontalAlignment.Center] = 0;
+	[Enum.HorizontalAlignment.Right] = 1;
+}
+
+local VERTICAL_ALIGNMENT = {
+	[Enum.VerticalAlignment.Top] = 0;
+	[Enum.VerticalAlignment.Center] = 0.5;
+	[Enum.VerticalAlignment.Bottom] = 1;
+}
+
+local VERTICAL_BIAS = {
+	[Enum.VerticalAlignment.Top] = -1;
+	[Enum.VerticalAlignment.Center] = 0;
+	[Enum.VerticalAlignment.Bottom] = 1;
+}
+
+--[=[
+	Converts alignment to 0, 0.5 or 1
+
+	@param alignment HorizontalAlignment | VertialAlignment
+	@return number
+]=]
+function UIAlignmentUtils.toNumber(alignment)
+	assert(alignment, "Bad alignment")
+
+	if HORIZONTAL_ALIGNMENT[alignment] then
+		return HORIZONTAL_ALIGNMENT[alignment]
+	elseif VERTICAL_ALIGNMENT[alignment] then
+		return VERTICAL_ALIGNMENT[alignment]
+	else
+		error(("[UIAlignmentUtils.toNumber] - Bad alignment %q"):format(tostring(alignment)))
+	end
+end
+
+--[=[
+	Converts alignment to bias, as -1, 0, or 1
+
+	@param alignment HorizontalAlignment | VertialAlignment
+	@return number
+]=]
+function UIAlignmentUtils.toBias(alignment)
+	assert(alignment, "Bad alignment")
+
+	if HORIZONTAL_BIAS[alignment] then
+		return HORIZONTAL_BIAS[alignment]
+	elseif VERTICAL_BIAS[alignment] then
+		return VERTICAL_BIAS[alignment]
+	else
+		error(("[UIAlignmentUtils.toBias] - Bad alignment %q"):format(tostring(alignment)))
+	end
+end
+
+--[=[
+	Converts alignment to a number from 0 to 1
+
+	@param horizontalAlignment HorizontalAlignment
+	@return number
+]=]
 function UIAlignmentUtils.horizontalAlignmentToNumber(horizontalAlignment)
 	assert(horizontalAlignment, "Bad horizontalAlignment")
 
-	local x
-	if horizontalAlignment == Enum.HorizontalAlignment.Left then
-		x = 0
-	elseif horizontalAlignment == Enum.HorizontalAlignment.Center then
-		x = 0.5
-	elseif horizontalAlignment == Enum.HorizontalAlignment.Right then
-		x = 1
+	if HORIZONTAL_ALIGNMENT[horizontalAlignment] then
+		return HORIZONTAL_ALIGNMENT[horizontalAlignment]
 	else
 		error(("[UIAlignmentUtils] - Bad horizontalAlignment %q"):format(tostring(horizontalAlignment)))
 	end
+end
+
+--[=[
+	Converts alignment to a number from -1 to 1
+
+	@param horizontalAlignment HorizontalAlignment
+	@return number
+]=]
+function UIAlignmentUtils.horizontalAlignmentToBias(horizontalAlignment)
+	assert(horizontalAlignment, "Bad horizontalAlignment")
 
-	return x
+	if HORIZONTAL_BIAS[horizontalAlignment] then
+		return HORIZONTAL_BIAS[horizontalAlignment]
+	else
+		error(("[UIAlignmentUtils] - Bad horizontalAlignment %q"):format(tostring(horizontalAlignment)))
+	end
 end
 
+--[=[
+	Converts alignment to a number from 0 to 1
+
+	@param verticalAlignment VerticalAlignment
+	@return number
+]=]
 function UIAlignmentUtils.verticalAlignmentToNumber(verticalAlignment)
 	assert(verticalAlignment, "Bad verticalAlignment")
-	local y
-	if verticalAlignment == Enum.VerticalAlignment.Top then
-		y = 0
-	elseif verticalAlignment == Enum.VerticalAlignment.Center then
-		y = 0.5
-	elseif verticalAlignment == Enum.VerticalAlignment.Bottom then
-		y = 1
+
+	if VERTICAL_ALIGNMENT[verticalAlignment] then
+		return VERTICAL_ALIGNMENT[verticalAlignment]
+	else
+		error(("[UIAlignmentUtils] - Bad verticalAlignment %q"):format(tostring(verticalAlignment)))
+	end
+end
+
+--[=[
+	Converts alignment to a number from -1 to 1
+
+	@param verticalAlignment VerticalAlignment
+	@return number
+]=]
+function UIAlignmentUtils.verticalAlignmentToBias(verticalAlignment)
+	assert(verticalAlignment, "Bad verticalAlignment")
+
+	if VERTICAL_BIAS[verticalAlignment] then
+		return VERTICAL_BIAS[verticalAlignment]
 	else
 		error(("[UIAlignmentUtils] - Bad verticalAlignment %q"):format(tostring(verticalAlignment)))
 	end
-	return y
 end
 
 return UIAlignmentUtils

package/src/Client/UICornerUtils.lua

@@ -33,7 +33,7 @@ end
 -- framePosition is top left corner
 -- returns position, relativePosition, normal
 function UICornerUtils.clampPositionToFrame(framePosition, frameSize, radius, point)
-	assert(radius > 0, "Bad radius")
+	assert(radius >= 0, "Bad radius")
 	assert(point, "Bad point")
 
 	local px, py = point.x, point.y