@quenty/blend 12.4.0 → 12.5.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.
 
+# [12.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/blend@12.4.0...@quenty/blend@12.5.0) (2024-09-12)
+
+
+### Bug Fixes
+
+* Blend spring uses a default spring object, fixing any errors ([d468636](https://github.com/Quenty/NevermoreEngine/commit/d468636dc58f951fbfc565d4a6b68c79483e379a))
+* Fix some spring object stuff ([34e8ede](https://github.com/Quenty/NevermoreEngine/commit/34e8edee97fa93a0a5bd84442b85826082444f2a))
+
+
+### Features
+
+* Update Blend.Spring to use SpringObject underneath ([b5d41f5](https://github.com/Quenty/NevermoreEngine/commit/b5d41f5b6955fc77bd37d9ec97b9704410c7c3f5))
+
+
+
+
+
 # [12.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/blend@12.3.0...@quenty/blend@12.4.0) (2024-08-09)
 
 **Note:** Version bump only for package @quenty/blend

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/blend",
-  "version": "12.4.0",
+  "version": "12.5.0",
   "description": "Declarative UI system.",
   "keywords": [
     "Roblox",
@@ -27,24 +27,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/acceltween": "^2.4.0",
-    "@quenty/brio": "^14.4.0",
-    "@quenty/ducktype": "^5.3.0",
-    "@quenty/instanceutils": "^13.4.0",
-    "@quenty/loader": "^10.3.0",
-    "@quenty/maid": "^3.2.0",
-    "@quenty/promise": "^10.3.0",
-    "@quenty/rx": "^13.4.0",
-    "@quenty/signal": "^7.3.0",
-    "@quenty/spring": "^10.3.0",
+    "@quenty/acceltween": "^2.5.0",
+    "@quenty/brio": "^14.5.0",
+    "@quenty/ducktype": "^5.4.0",
+    "@quenty/instanceutils": "^13.5.0",
+    "@quenty/loader": "^10.4.0",
+    "@quenty/maid": "^3.3.0",
+    "@quenty/promise": "^10.4.0",
+    "@quenty/rx": "^13.5.0",
+    "@quenty/signal": "^7.4.0",
+    "@quenty/spring": "^10.4.0",
     "@quenty/steputils": "^3.4.0",
     "@quenty/string": "^3.2.0",
-    "@quenty/valuebaseutils": "^13.4.0",
-    "@quenty/valueobject": "^13.4.0"
+    "@quenty/valuebaseutils": "^13.5.0",
+    "@quenty/valueobject": "^13.5.0"
   },
   "devDependencies": {
-    "@quenty/contentproviderutils": "^12.4.0",
-    "@quenty/playerthumbnailutils": "^10.3.0"
+    "@quenty/contentproviderutils": "^12.5.0",
+    "@quenty/playerthumbnailutils": "^10.4.0"
   },
-  "gitHead": "ba466bdbc05c42fb607cf5e228c16339201d21d7"
+  "gitHead": "fb172906f3ee725269ec1e5f4daf9dca227e729d"
 }

package/src/Shared/Blend/Blend.lua

@@ -17,13 +17,12 @@ local BrioUtils = require("BrioUtils")
 local RxInstanceUtils = require("RxInstanceUtils")
 local RxValueBaseUtils = require("RxValueBaseUtils")
 local Signal = require("Signal")
-local Spring = require("Spring")
-local SpringUtils = require("SpringUtils")
 local StepUtils = require("StepUtils")
 local ValueBaseUtils = require("ValueBaseUtils")
 local ValueObject = require("ValueObject")
 local ValueObjectUtils = require("ValueObjectUtils")
 local RxBrioUtils = require("RxBrioUtils")
+local SpringObject
 
 local Blend = {}
 
@@ -410,53 +409,17 @@ end
 	@return Observable?
 ]=]
 function Blend.Spring(source, speed, damper)
-	local sourceObservable = Blend.toPropertyObservable(source) or Rx.of(source)
-	local speedObservable = Blend.toNumberObservable(speed)
-	local damperObservable = Blend.toNumberObservable(damper)
-
-	local function createSpring(maid, initialValue)
-		local spring = Spring.new(initialValue)
-
-		if speedObservable then
-			maid:GiveTask(speedObservable:Subscribe(function(value)
-				assert(type(value) == "number", "Bad value")
-				spring.Speed = value
-			end))
-		end
-
-		if damperObservable then
-			maid:GiveTask(damperObservable:Subscribe(function(value)
-				assert(type(value) == "number", "Bad value")
-
-				spring.Damper = value
-			end))
-		end
-
-		return spring
+	if not SpringObject then
+		SpringObject = require("SpringObject")
 	end
 
-	-- TODO: Centralize and cache
 	return Observable.new(function(sub)
-		local spring
 		local maid = Maid.new()
 
-		local startAnimate, stopAnimate = StepUtils.bindToRenderStep(function()
-			local animating, position = SpringUtils.animating(spring)
-			sub:Fire(SpringUtils.fromLinearIfNeeded(position))
-			return animating
-		end)
+		local spring = maid:Add(SpringObject.new(source, speed, damper))
+		spring.Epsilon = 1e-3
 
-		maid:GiveTask(stopAnimate)
-		maid:GiveTask(sourceObservable:Subscribe(function(value)
-			if value then
-				local linearValue = SpringUtils.toLinearIfNeeded(value)
-				spring = spring or createSpring(maid, linearValue)
-				spring.t = SpringUtils.toLinearIfNeeded(value)
-				startAnimate()
-			else
-				warn("Got nil value from emitted source")
-			end
-		end))
+		maid:GiveTask(spring:Observe():Subscribe(sub:GetFireFailComplete()))
 
 		return maid
 	end)

package/src/Shared/Blend/SpringObject.lua

@@ -45,9 +45,7 @@ function SpringObject.new(target, speed, damper)
 	self._maid:GiveTask(self.Changed)
 
 	if target then
-		self.Target = target
-	else
-		self:_getSpringForType(0)
+		self:SetTarget(target)
 	end
 
 	if speed then
@@ -287,8 +285,17 @@ function SpringObject:__index(index)
 		return self._epsilon
 	elseif SpringObject[index] then
 		return SpringObject[index]
+	elseif index == "_currentSpring" then
+		local found = rawget(self, "_currentSpring")
+		if found then
+			return found
+		end
+
+		-- Note that sometimes the current spring isn't loaded yet as a type so
+		-- we use a number for this.
+		return self:_getSpringForType(0)
 	else
-		error(("%q is not a member of SpringObject"):format(tostring(index)))
+		error(string.format("%q is not a member of SpringObject", tostring(index)))
 	end
 end
 
@@ -323,6 +330,7 @@ function SpringObject:__newindex(index, value)
 		end)
 	elseif index == "Speed" or index == "s" then
 		local observable = assert(Blend.toNumberObservable(value), "Invalid speed")
+		assert(self._currentSpring, "No self._currentSpring")
 
 		self._maid._speedSub = observable:Subscribe(function(unconverted)
 			assert(type(unconverted) == "number", "Bad damper")
@@ -337,16 +345,19 @@ function SpringObject:__newindex(index, value)
 		assert(type(value) == "function", "Bad clock value")
 		self._currentSpring.Clock = value
 		self.Changed:Fire()
+	elseif index == "_currentSpring" then
+		rawset(self, "_currentSpring", value)
 	else
-		error(("%q is not a member of SpringObject"):format(tostring(index)))
+		error(string.format("%q is not a member of SpringObject", tostring(index)))
 	end
 end
 
 function SpringObject:_getSpringForType(converted)
 	if rawget(self, "_currentSpring") == nil then
 		-- only happens on init
-		rawset(self, "_currentSpring", Spring.new(converted))
-		return self._currentSpring
+		local created = Spring.new(converted)
+		rawset(self, "_currentSpring", created)
+		return created
 	else
 		local currentType = typeof(SpringUtils.fromLinearIfNeeded(self._currentSpring.Value))
 		if currentType == typeof(SpringUtils.fromLinearIfNeeded(converted)) then
@@ -356,11 +367,12 @@ function SpringObject:_getSpringForType(converted)
 			local oldSpeed = self._currentSpring.s
 			local clock = self._currentSpring.Clock
 
-			self._currentSpring = Spring.new(converted)
-			self._currentSpring.Clock = clock
-			self._currentSpring.Speed = oldSpeed
-			self._currentSpring.Damper = oldDamper
-			return self._currentSpring
+			local newSpring = Spring.new(converted)
+			newSpring.Clock = clock
+			newSpring.Speed = oldSpeed
+			newSpring.Damper = oldDamper
+			rawset(self, "_currentSpring", newSpring)
+			return newSpring
 		end
 	end
 end