@quenty/transitionmodel 2.0.0-canary.367.e9fdcbc.0 → 2.0.0

package/CHANGELOG.md

@@ -3,7 +3,109 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [2.0.0-canary.367.e9fdcbc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.9.0...@quenty/transitionmodel@2.0.0-canary.367.e9fdcbc.0) (2023-06-05)
+# [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.20.0...@quenty/transitionmodel@2.0.0) (2023-10-11)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.19.0...@quenty/transitionmodel@1.20.0) (2023-09-21)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.18.0...@quenty/transitionmodel@1.19.0) (2023-09-04)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.17.0...@quenty/transitionmodel@1.18.0) (2023-08-23)
+
+
+### Features
+
+* Add TimedTransitionModel.new() ([4d582f0](https://github.com/Quenty/NevermoreEngine/commit/4d582f0b290fca4cf3ef9b65ca4d526f0d8061ab))
+
+
+
+
+
+# [1.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.16.0...@quenty/transitionmodel@1.17.0) (2023-08-01)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.15.0...@quenty/transitionmodel@1.16.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.14.0...@quenty/transitionmodel@1.15.0) (2023-07-25)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.13.0...@quenty/transitionmodel@1.14.0) (2023-07-23)
+
+
+### Features
+
+* Add :Observe() to SpringTransitionModel so it can be passed directly into Blend ([2d9fb45](https://github.com/Quenty/NevermoreEngine/commit/2d9fb45af5f9dfdfeb2b4a2933e553d9efb63a8a))
+
+
+
+
+
+# [1.13.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.12.1...@quenty/transitionmodel@1.13.0) (2023-07-15)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+## [1.12.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.12.0...@quenty/transitionmodel@1.12.1) (2023-07-11)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.12.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.11.0...@quenty/transitionmodel@1.12.0) (2023-07-10)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.10.0...@quenty/transitionmodel@1.11.0) (2023-06-17)
+
+**Note:** Version bump only for package @quenty/transitionmodel
+
+
+
+
+
+# [1.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@1.9.0...@quenty/transitionmodel@1.10.0) (2023-06-05)
 
 **Note:** Version bump only for package @quenty/transitionmodel
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/transitionmodel",
-  "version": "2.0.0-canary.367.e9fdcbc.0",
+  "version": "2.0.0",
   "description": "Helps with Gui visiblity showing and hiding",
   "keywords": [
     "Roblox",
@@ -25,19 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "6.2.1",
-    "@quenty/basicpane": "7.14.0",
-    "@quenty/blend": "7.0.0-canary.367.e9fdcbc.0",
-    "@quenty/instanceutils": "7.14.0",
-    "@quenty/loader": "6.2.1",
-    "@quenty/maid": "2.5.0",
-    "@quenty/promise": "6.5.0",
-    "@quenty/rx": "7.11.0",
-    "@quenty/signal": "2.4.0",
-    "@quenty/valueobject": "8.0.0-canary.367.e9fdcbc.0"
+    "@quenty/baseobject": "^7.0.0",
+    "@quenty/basicpane": "^8.0.0",
+    "@quenty/blend": "^7.0.0",
+    "@quenty/instanceutils": "^8.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/rx": "^8.0.0",
+    "@quenty/signal": "^3.0.0",
+    "@quenty/timedtween": "^2.0.0",
+    "@quenty/valueobject": "^8.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9fdcbc6ea1d46e068bf42a08b833099e9005259"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Shared/SpringTransitionModel.lua

@@ -103,6 +103,10 @@ function SpringTransitionModel:BindToPaneVisbility(pane)
 	self._maid._visibleBinding = maid
 
 	return function()
+		if not self.Destroy then
+			return
+		end
+
 		if self._maid._visibleBinding == maid then
 			self._maid._visibleBinding = nil
 		end
@@ -160,6 +164,15 @@ function SpringTransitionModel:ObserveRenderStepped()
 	return self._springObject:ObserveRenderStepped()
 end
 
+--[=[
+	Alias to spring transition model observation!
+
+	@return Observable<T>
+]=]
+function SpringTransitionModel:Observe()
+	return self._springObject:Observe()
+end
+
 --[=[
 	Shows the model and promises when the showing is complete.
 

package/src/Shared/Timed/TimedTransitionModel.lua

@@ -0,0 +1,180 @@
+--[=[
+	@class TimedTransitionModel
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BasicPane = require("BasicPane")
+local TransitionModel = require("TransitionModel")
+local TimedTween = require("TimedTween")
+local Promise = require("Promise")
+local Maid = require("Maid")
+
+local TimedTransitionModel = setmetatable({}, BasicPane)
+TimedTransitionModel.ClassName = "TimedTransitionModel"
+TimedTransitionModel.__index = TimedTransitionModel
+
+--[=[
+	A transition model that has a spring underlying it. Very useful
+	for animations on tracks that need to be on a spring.
+
+	@return TimedTransitionModel<T>
+]=]
+function TimedTransitionModel.new()
+	local self = setmetatable(BasicPane.new(), TimedTransitionModel)
+
+	self._transitionModel = TransitionModel.new()
+	self._transitionModel:BindToPaneVisbility(self)
+	self._maid:GiveTask(self._transitionModel)
+
+
+	self._timedTween = TimedTween.new(0.15)
+	self._maid:GiveTask(self._timedTween)
+
+	-- State
+	self._transitionModel:SetPromiseShow(function(maid, doNotAnimate)
+		return self:_promiseShow(maid, doNotAnimate)
+	end)
+	self._transitionModel:SetPromiseHide(function(maid, doNotAnimate)
+		return self:_promiseHide(maid, doNotAnimate)
+	end)
+
+	return self
+end
+
+function TimedTransitionModel:SetTransitionTime(transitionTime)
+	self._timedTween:SetTransitionTime(transitionTime)
+end
+
+--[=[
+	Returns true if showing is complete
+	@return boolean
+]=]
+function TimedTransitionModel:IsShowingComplete()
+	return self._transitionModel:IsShowingComplete()
+end
+
+--[=[
+	Returns true if hiding is complete
+	@return boolean
+]=]
+function TimedTransitionModel:IsHidingComplete()
+	return self._transitionModel:IsHidingComplete()
+end
+
+--[=[
+	Observe is showing is complete
+	@return Observable<boolean>
+]=]
+function TimedTransitionModel:ObserveIsShowingComplete()
+	return self._transitionModel:ObserveIsShowingComplete()
+end
+
+--[=[
+	Observe is hiding is complete
+	@return Observable<boolean>
+]=]
+function TimedTransitionModel:ObserveIsHidingComplete()
+	return self._transitionModel:ObserveIsHidingComplete()
+end
+
+--[=[
+	Binds the transition model to the actual visiblity of the pane
+
+	@param pane BasicPane
+	@return function -- Cleanup function
+]=]
+function TimedTransitionModel:BindToPaneVisbility(pane)
+	local maid = Maid.new()
+
+	maid:GiveTask(pane.VisibleChanged:Connect(function(isVisible, doNotAnimate)
+		self:SetVisible(isVisible, doNotAnimate)
+	end))
+	maid:GiveTask(self.VisibleChanged:Connect(function(isVisible, doNotAnimate)
+		pane:SetVisible(isVisible, doNotAnimate)
+	end))
+
+	self:SetVisible(pane:IsVisible())
+
+	self._maid._visibleBinding = maid
+
+	return function()
+		if not self.Destroy then
+			return
+		end
+
+		if self._maid._visibleBinding == maid then
+			self._maid._visibleBinding = nil
+		end
+	end
+end
+
+--[=[
+	Observes the spring animating
+	@return Observable<T>
+]=]
+function TimedTransitionModel:ObserveRenderStepped()
+	return self._timedTween:ObserveRenderStepped()
+end
+
+--[=[
+	Alias to spring transition model observation!
+
+	@return Observable<T>
+]=]
+function TimedTransitionModel:Observe()
+	return self._timedTween:Observe()
+end
+
+--[=[
+	Shows the model and promises when the showing is complete.
+
+	@param doNotAnimate boolean
+	@return Promise
+]=]
+function TimedTransitionModel:PromiseShow(doNotAnimate)
+	return self._transitionModel:PromiseShow(doNotAnimate)
+end
+
+--[=[
+	Hides the model and promises when the showing is complete.
+
+	@param doNotAnimate boolean
+	@return Promise
+]=]
+function TimedTransitionModel:PromiseHide(doNotAnimate)
+	return self._transitionModel:PromiseHide(doNotAnimate)
+end
+
+--[=[
+	Toggles the model and promises when the transition is complete.
+
+	@param doNotAnimate boolean
+	@return Promise
+]=]
+function TimedTransitionModel:PromiseToggle(doNotAnimate)
+	return self._transitionModel:PromiseToggle(doNotAnimate)
+end
+
+function TimedTransitionModel:_promiseShow(maid, doNotAnimate)
+	self._timedTween:Show(doNotAnimate)
+
+	if doNotAnimate then
+		return Promise.resolved()
+	else
+		return maid:GivePromise(self._timedTween:PromiseFinished())
+	end
+end
+
+function TimedTransitionModel:_promiseHide(maid, doNotAnimate)
+	self._timedTween:Hide(doNotAnimate)
+
+	if doNotAnimate then
+		return Promise.resolved()
+	else
+		return maid:GivePromise(self._timedTween:PromiseFinished())
+	end
+end
+
+
+return TimedTransitionModel