@quenty/uiobjectutils 6.10.1 → 6.10.2-canary.513.656b9b5.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.10.2-canary.513.656b9b5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/uiobjectutils@6.10.1...@quenty/uiobjectutils@6.10.2-canary.513.656b9b5.0) (2024-11-06)
+
+
+### Bug Fixes
+
+* clip state computes zero for unparented items ([8d355c1](https://github.com/Quenty/NevermoreEngine/commit/8d355c18fc228290ae2587d62586c0a9fb2f1c78))
+
+
+### Features
+
+* Add RxClippedRectUtils.observeClippedRect(gui) ([26d5933](https://github.com/Quenty/NevermoreEngine/commit/26d593345b0f8f9af90042da826a7cc656c67713))
+
+
+
+
+
 ## [6.10.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/uiobjectutils@6.10.0...@quenty/uiobjectutils@6.10.1) (2024-11-04)
 
 **Note:** Version bump only for package @quenty/uiobjectutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/uiobjectutils",
-  "version": "6.10.1",
+  "version": "6.10.2-canary.513.656b9b5.0",
   "description": "UI object utils library for Roblox",
   "keywords": [
     "Roblox",
@@ -28,11 +28,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/brio": "^14.11.1",
-    "@quenty/enumutils": "^3.3.0",
-    "@quenty/instanceutils": "^13.11.1",
-    "@quenty/loader": "^10.7.1",
-    "@quenty/rx": "^13.11.1"
+    "@quenty/brio": "14.11.2-canary.513.656b9b5.0",
+    "@quenty/enumutils": "3.3.0",
+    "@quenty/instanceutils": "13.11.2-canary.513.656b9b5.0",
+    "@quenty/loader": "10.7.1",
+    "@quenty/rx": "13.11.2-canary.513.656b9b5.0"
   },
-  "gitHead": "01c43a0ddd3c5e0cb2d9027313dbfa9852eedef1"
+  "gitHead": "656b9b54fcaf9beec7a43b5453d3596ee3c550e1"
 }

package/src/Client/RxClippedRectUtils.lua

@@ -0,0 +1,146 @@
+--[=[
+	Helper functions to observe parts of a Gui that are clipped or not
+
+	@class RxClippedRectUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Rx = require("Rx")
+local RxInstanceUtils = require("RxInstanceUtils")
+
+local RxClippedRectUtils = {}
+
+
+--[=[
+	Observes the clipped rect for the given Gui
+
+	@param gui Gui
+	@return Observable<Rect>
+]=]
+function RxClippedRectUtils.observeClippedRect(gui)
+	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad GuiBase2d")
+
+	-- At least use our object's size here...
+	return Rx.combineLatest({
+		absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition");
+		absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize");
+		parentRect = RxClippedRectUtils._observeParentClippedRect(gui);
+	}):Pipe({
+		Rx.map(function(state)
+			if state.parentRect then
+				return RxClippedRectUtils._computeClippedRect(state)
+			else
+				return Rect.new(Vector2.zero, Vector2.zero)
+			end
+		end);
+		Rx.distinct();
+	})
+end
+
+local function clampVector2(value)
+	return Vector2.new(math.clamp(value.x, 0, 1), math.clamp(value.y, 0, 1))
+end
+
+function RxClippedRectUtils.observeClippedRectInScale(gui)
+	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad GuiBase2d")
+
+	return Rx.combineLatest({
+		absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition");
+		absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize");
+		visibleRect = RxClippedRectUtils.observeClippedRect(gui);
+	}):Pipe({
+		Rx.map(function(state)
+			if state.absoluteSize.x == 0 or state.absoluteSize.y == 0 then
+				return Rect.new(Vector2.zero, Vector2.zero)
+			end
+
+			local ourMin = state.absolutePosition
+			local ourSize = state.absoluteSize
+
+			local visibleMin = state.visibleRect.Min
+			local visibleSize = state.visibleRect.Max - visibleMin
+
+			local topLeft = clampVector2((visibleMin - ourMin)/ourSize)
+			local size = clampVector2(visibleSize/ourSize)
+			local bottomRight = topLeft + size
+			return Rect.new(topLeft, bottomRight)
+		end);
+		Rx.distinct();
+	})
+end
+
+function RxClippedRectUtils._observeClippedRectImpl(gui)
+	if gui:IsA("GuiObject") then
+		return RxInstanceUtils.observeProperty(gui, "ClipsDescendants"):Pipe({
+			Rx.switchMap(function(clipDescendants)
+				if not clipDescendants then
+					return RxClippedRectUtils._observeParentClippedRect(gui)
+				end
+
+				return Rx.combineLatest({
+					absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition");
+					absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize");
+					parentRect = RxClippedRectUtils._observeParentClippedRect(gui);
+				}):Pipe({
+					Rx.map(function(state)
+						return RxClippedRectUtils._computeClippedRect(state)
+					end);
+				})
+			end)
+		})
+	else
+		if not gui:IsA("LayerCollector") then
+			warn(string.format("[RxClippedRectUtils._observeClippedRectImpl] - Unknown gui instance type behind GuiBase2d of class %s - treating as layer collector. Please patch this method.", tostring(gui.ClassName)))
+		end
+
+		return Rx.combineLatest({
+			absolutePosition = RxInstanceUtils.observeProperty(gui, "AbsolutePosition");
+			absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize");
+			parentRect = RxClippedRectUtils._observeParentClippedRect(gui);
+		}):Pipe({
+			Rx.map(function(state)
+				return RxClippedRectUtils._computeClippedRect(state)
+			end);
+		})
+	end
+end
+
+function RxClippedRectUtils._computeClippedRect(state)
+	if not state.parentRect then
+		return Rect.new(state.absolutePosition, state.absolutePosition + state.absoluteSize)
+	end
+
+	local topLeft = state.absolutePosition
+	local bottomRight = state.absolutePosition + state.absoluteSize
+
+	local parentMin = state.parentRect.Min
+	local parentMax = state.parentRect.Max
+	local topLeftX = math.max(topLeft.x, parentMin.x)
+	local topLeftY = math.max(topLeft.y, parentMin.y)
+
+	local bottomRightX = math.min(bottomRight.x, parentMax.x)
+	local bottomRightY = math.min(bottomRight.y, parentMax.y)
+
+	-- negative sizes not allowed...
+	local sizeX = math.max(0, bottomRightX - topLeftX)
+	local sizeY = math.max(0, bottomRightY - topLeftY)
+
+	return Rect.new(topLeftX, topLeftY, topLeftX + sizeX, topLeftY + sizeY)
+end
+
+function RxClippedRectUtils._observeParentClippedRect(gui)
+	assert(typeof(gui) == "Instance" and gui:IsA("GuiBase2d"), "Bad GuiBase2d")
+
+	return RxInstanceUtils.observeFirstAncestor(gui, "GuiObject"):Pipe({
+		Rx.switchMap(function(parent)
+			if parent then
+				return RxClippedRectUtils._observeClippedRectImpl(parent)
+			else
+				return Rx.of(nil);
+			end
+		end);
+	});
+end
+
+return RxClippedRectUtils