@quenty/transitionmodel 7.1.1 → 7.2.1-canary.468.ea8a226.0

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.2.1-canary.468.ea8a226.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@7.2.0...@quenty/transitionmodel@7.2.1-canary.468.ea8a226.0) (2024-05-09)
+
+
+### Bug Fixes
+
+* Fix .package-lock.json replicating in packages ([75d0efe](https://github.com/Quenty/NevermoreEngine/commit/75d0efeef239f221d93352af71a5b3e930ec23c5))
+
+
+### Features
+
+* Allow SetShowTarget and SetHideTarget to be set for a SPringTransitionModel ([70bc88d](https://github.com/Quenty/NevermoreEngine/commit/70bc88d750dca1696cf84ff83634c6a0d47c907d))
+
+
+
+
+
+# [7.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@7.1.1...@quenty/transitionmodel@7.2.0) (2024-04-27)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
 ## [7.1.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@7.1.0...@quenty/transitionmodel@7.1.1) (2024-04-23)
 
 **Note:** Version bump only for package @quenty/transitionmodel

package/default.project.json

@@ -1,5 +1,6 @@
 {
   "name": "transitionmodel",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
   "tree": {
     "$path": "src"
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/transitionmodel",
-  "version": "7.1.1",
+  "version": "7.2.1-canary.468.ea8a226.0",
   "description": "Helps with Gui visiblity showing and hiding",
   "keywords": [
     "Roblox",
@@ -25,20 +25,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.1.0",
-    "@quenty/basicpane": "^13.1.0",
-    "@quenty/blend": "^12.1.1",
-    "@quenty/instanceutils": "^13.1.0",
-    "@quenty/loader": "^10.1.0",
-    "@quenty/maid": "^3.1.0",
-    "@quenty/promise": "^10.1.0",
-    "@quenty/rx": "^13.1.0",
-    "@quenty/signal": "^7.1.0",
-    "@quenty/timedtween": "^7.1.1",
-    "@quenty/valueobject": "^13.1.0"
+    "@quenty/baseobject": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/basicpane": "13.2.1-canary.468.ea8a226.0",
+    "@quenty/blend": "12.2.1-canary.468.ea8a226.0",
+    "@quenty/ducktype": "5.2.1-canary.468.ea8a226.0",
+    "@quenty/instanceutils": "13.2.1-canary.468.ea8a226.0",
+    "@quenty/loader": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/maid": "3.1.1-canary.468.ea8a226.0",
+    "@quenty/promise": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/rx": "13.2.1-canary.468.ea8a226.0",
+    "@quenty/signal": "7.2.1-canary.468.ea8a226.0",
+    "@quenty/spring": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/timedtween": "7.2.1-canary.468.ea8a226.0",
+    "@quenty/valueobject": "13.2.1-canary.468.ea8a226.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "cd35ea3858c97294f1f467fe64a731ee4be9babb"
+  "gitHead": "ea8a2260a364aaf6d6c246a93632b789935da134"
 }

package/src/Shared/SpringTransitionModel.lua

@@ -9,6 +9,7 @@ local TransitionModel = require("TransitionModel")
 local SpringObject = require("SpringObject")
 local Promise = require("Promise")
 local Maid = require("Maid")
+local SpringUtils = require("SpringUtils")
 
 local SpringTransitionModel = setmetatable({}, BasicPane)
 SpringTransitionModel.ClassName = "SpringTransitionModel"
@@ -25,20 +26,14 @@ SpringTransitionModel.__index = SpringTransitionModel
 function SpringTransitionModel.new(showTarget, hideTarget)
 	local self = setmetatable(BasicPane.new(), SpringTransitionModel)
 
-	self._transitionModel = TransitionModel.new()
-	self._transitionModel:BindToPaneVisbility(self)
-	self._maid:GiveTask(self._transitionModel)
-
 	self._showTarget = showTarget or 1
-	if hideTarget then
-		self._hideTarget = hideTarget
-	else
-		self._hideTarget = 0*self._showTarget
-	end
+	self._hideTarget = hideTarget
 
-	self._springObject = SpringObject.new(self._hideTarget)
+	self._transitionModel = self._maid:Add(TransitionModel.new())
+	self._transitionModel:BindToPaneVisbility(self)
+
+	self._springObject = self._maid:Add(SpringObject.new(self:_computeHideTarget()))
 	self._springObject.Speed = 30
-	self._maid:GiveTask(self._springObject)
 
 	self._transitionModel:SetPromiseShow(function(maid, doNotAnimate)
 		return self:_promiseShow(maid, doNotAnimate)
@@ -50,6 +45,38 @@ function SpringTransitionModel.new(showTarget, hideTarget)
 	return self
 end
 
+--[=[
+	Sets the show target for the transition model
+
+	@param showTarget T?
+	@param doNotAnimate boolean?
+]=]
+function SpringTransitionModel:SetShowTarget(showTarget, doNotAnimate)
+	self._showTarget = SpringUtils.toLinearIfNeeded(showTarget or 1)
+
+	if self:IsVisible() then
+		self._springObject:SetTarget(self._showTarget, doNotAnimate)
+	else
+		self._springObject:SetTarget(self:_computeHideTarget(), doNotAnimate)
+	end
+end
+
+--[=[
+	Sets the hide target for the transition model
+
+	@param hideTarget T?
+	@param doNotAnimate boolean?
+]=]
+function SpringTransitionModel:SetHideTarget(hideTarget, doNotAnimate)
+	self._hideTarget = hideTarget
+
+	if self:IsVisible() then
+		self._springObject:SetTarget(self._showTarget, doNotAnimate)
+	else
+		self._springObject:SetTarget(self:_computeHideTarget(), doNotAnimate)
+	end
+end
+
 --[=[
 	Returns true if showing is complete
 	@return boolean
@@ -214,7 +241,7 @@ function SpringTransitionModel:_promiseShow(maid, doNotAnimate)
 end
 
 function SpringTransitionModel:_promiseHide(maid, doNotAnimate)
-	self._springObject:SetTarget(self._hideTarget, doNotAnimate)
+	self._springObject:SetTarget(self:_computeHideTarget(), doNotAnimate)
 
 	if doNotAnimate then
 		return Promise.resolved()
@@ -223,4 +250,12 @@ function SpringTransitionModel:_promiseHide(maid, doNotAnimate)
 	end
 end
 
+function SpringTransitionModel:_computeHideTarget()
+	if self._hideTarget then
+		return SpringUtils.toLinearIfNeeded(self._hideTarget)
+	else
+		return 0*SpringUtils.toLinearIfNeeded(self._showTarget)
+	end
+end
+
 return SpringTransitionModel

package/src/Shared/TransitionModel.lua

@@ -11,6 +11,7 @@ local BasicPane = require("BasicPane")
 local Promise = require("Promise")
 local Maid = require("Maid")
 local ValueObject = require("ValueObject")
+local DuckTypeUtils = require("DuckTypeUtils")
 
 local TransitionModel = setmetatable({}, BasicPane)
 TransitionModel.ClassName = "TransitionModel"
@@ -27,11 +28,8 @@ TransitionModel.__index = TransitionModel
 function TransitionModel.new()
 	local self = setmetatable(BasicPane.new(), TransitionModel)
 
-	self._isShowingComplete = ValueObject.new(false, "boolean")
-	self._maid:GiveTask(self._isShowingComplete)
-
-	self._isHidingComplete = ValueObject.new(false, "boolean")
-	self._maid:GiveTask(self._isHidingComplete)
+	self._isShowingComplete = self._maid:Add(ValueObject.new(false, "boolean"))
+	self._isHidingComplete = self._maid:Add(ValueObject.new(false, "boolean"))
 
 	self._showCallback = nil
 	self._hideCallback = nil
@@ -47,6 +45,16 @@ function TransitionModel.new()
 	return self
 end
 
+--[=[
+	Returnes true if it's a transition model
+
+	@param value any
+	@return boolean
+]=]
+function TransitionModel.isTransitionModel(value)
+	return DuckTypeUtils.isImplementation(TransitionModel, value)
+end
+
 --[=[
 	Shows the model and promises when the showing is complete.
 
@@ -54,9 +62,11 @@ end
 	@return Promise
 ]=]
 function TransitionModel:PromiseShow(doNotAnimate)
+	local promise = self:_promiseIsShown()
+
 	self:Show(doNotAnimate)
 
-	return self:_promiseIsShown()
+	return promise
 end
 
 --[=[
@@ -66,9 +76,11 @@ end
 	@return Promise
 ]=]
 function TransitionModel:PromiseHide(doNotAnimate)
+	local promise = self:_promiseIsHidden()
+
 	self:Hide(doNotAnimate)
 
-	return self:_promiseIsHidden()
+	return promise
 end
 
 --[=[
@@ -251,7 +263,11 @@ function TransitionModel:_executeShow(doNotAnimate)
 		self._isShowingComplete.Value = true
 	end)
 
-	self._maid._transition = maid
+	if self.Destroy then
+		self._maid._transition = maid
+	else
+		maid:DoCleaning()
+	end
 end
 
 function TransitionModel:_executeHide(doNotAnimate)
@@ -280,7 +296,11 @@ function TransitionModel:_executeHide(doNotAnimate)
 		self._isHidingComplete.Value = true
 	end)
 
-	self._maid._transition = maid
+	if self.Destroy then
+		self._maid._transition = maid
+	else
+		maid:DoCleaning()
+	end
 end
 
 return TransitionModel