@quenty/transitionmodel 1.1.0-canary.67644c5.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.1.0-canary.67644c5.0 (2023-03-05)
+
+
+### Features
+
+* Add TransitionModel package ([67644c5](https://github.com/Quenty/NevermoreEngine/commit/67644c5978f4a895d352eb7394c9fcb50f9ec4d4))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2022 Quenty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## TransitionModel
+
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Helps with Gui visiblity showing and hiding
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/TransitionModelUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/transitionmodel --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "transitionmodel",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@quenty/transitionmodel",
+  "version": "1.1.0-canary.67644c5.0",
+  "description": "Helps with Gui visiblity showing and hiding",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "transitionmodel"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/transitionmodel/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "6.2.0-canary.67644c5.0",
+    "@quenty/basicpane": "7.7.0-canary.67644c5.0",
+    "@quenty/blend": "6.10.0-canary.67644c5.0",
+    "@quenty/loader": "6.2.0-canary.67644c5.0",
+    "@quenty/maid": "2.5.0-canary.67644c5.0",
+    "@quenty/promise": "6.3.0-canary.67644c5.0",
+    "@quenty/signal": "2.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "67644c5978f4a895d352eb7394c9fcb50f9ec4d4"
+}

package/src/Shared/SpringTransitionModel.lua

@@ -0,0 +1,105 @@
+--[=[
+	@class SpringTransitionModel
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BasicPane = require("BasicPane")
+local TransitionModel = require("TransitionModel")
+local SpringObject = require("SpringObject")
+local Promise = require("Promise")
+local Maid = require("Maid")
+
+local SpringTransitionModel = setmetatable({}, BasicPane)
+SpringTransitionModel.ClassName = "SpringTransitionModel"
+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._springObject = SpringObject.new(self._hideTarget)
+	self._springObject.Speed = 30
+	self._maid:GiveTask(self._springObject)
+
+	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 SpringTransitionModel:BindToPaneVisbility(pane)
+	local maid = Maid.new()
+
+	maid:GiveTask(pane.VisibleChanged:Connect(function(isVisible, doNotAnimate)
+		self:SetVisible(isVisible, doNotAnimate)
+	end))
+
+	self:SetVisible(pane:IsVisible())
+
+	self._maid._visibleBinding = maid
+
+	return function()
+		if self._maid._visibleBinding == maid then
+			self._maid._visibleBinding = nil
+		end
+	end
+end
+
+function SpringTransitionModel:SetSpeed(speed)
+	self._springObject.Speed = speed
+end
+
+function SpringTransitionModel:SetDamper(damper)
+	self._springObject.Damper = damper
+end
+
+function SpringTransitionModel:ObserveRenderStepped()
+	return self._springObject:ObserveRenderStepped()
+end
+
+function SpringTransitionModel:PromiseShow(doNotAnimate)
+	return self._transitionModel:PromiseShow(doNotAnimate)
+end
+
+function SpringTransitionModel:PromiseHide(doNotAnimate)
+	return self._transitionModel:PromiseHide(doNotAnimate)
+end
+
+function SpringTransitionModel:PromiseToggle(doNotAnimate)
+	return self._transitionModel:PromiseToggle(doNotAnimate)
+end
+
+function SpringTransitionModel:_promiseShow(maid)
+	local promise = Promise.new()
+	maid:GiveTask(promise)
+
+	self._springObject.t = self._showTarget
+
+	return maid:GivePromise(self._springObject:PromiseFinished())
+end
+
+function SpringTransitionModel:_promiseHide(maid)
+	local promise = Promise.new()
+	maid:GiveTask(promise)
+
+	self._springObject.t = self._hideTarget
+
+	return maid:GivePromise(self._springObject:PromiseFinished())
+end
+
+return SpringTransitionModel

package/src/Shared/TransitionModel.lua

@@ -0,0 +1,201 @@
+--[=[
+	This model deduplicates and handles transitions for showing, hiding, and
+	toggling.
+
+	@class TransitionModel
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BasicPane = require("BasicPane")
+local Promise = require("Promise")
+local Maid = require("Maid")
+
+local TransitionModel = setmetatable({}, BasicPane)
+TransitionModel.ClassName = "TransitionModel"
+TransitionModel.__index = TransitionModel
+
+function TransitionModel.new()
+	local self = setmetatable(BasicPane.new(), TransitionModel)
+
+	self._isShowingComplete = Instance.new("BoolValue")
+	self._isShowingComplete.Value = false
+	self._maid:GiveTask(self._isShowingComplete)
+
+	self._isHidingComplete = Instance.new("BoolValue")
+	self._isHidingComplete.Value = false
+	self._maid:GiveTask(self._isHidingComplete)
+
+	self._maid:GiveTask(self.VisibleChanged:Connect(function(visible, doNotAnimate)
+		if visible then
+			self:_executeShow(doNotAnimate)
+		else
+			self:_executeHide(doNotAnimate)
+		end
+	end))
+
+	return self
+end
+
+function TransitionModel:PromiseShow(doNotAnimate)
+	self:Show(doNotAnimate)
+
+	return self:_promiseIsShown()
+end
+
+function TransitionModel:PromiseHide(doNotAnimate)
+	self:Hide(doNotAnimate)
+
+	return self:_promiseIsHidden()
+end
+
+function TransitionModel:PromiseToggle(doNotAnimate)
+	if self:IsVisible() then
+		return self:PromiseShow(doNotAnimate)
+	else
+		return self:PromiseHide(doNotAnimate)
+	end
+end
+
+function TransitionModel:BindToPaneVisbility(pane)
+	local maid = Maid.new()
+
+	maid:GiveTask(pane.VisibleChanged:Connect(function(isVisible, doNotAnimate)
+		self:SetVisible(isVisible, doNotAnimate)
+	end))
+
+	self:SetVisible(pane:IsVisible())
+
+	self._maid._visibleBinding = maid
+
+	return function()
+		if self._maid._visibleBinding == maid then
+			self._maid._visibleBinding = nil
+		end
+	end
+end
+
+function TransitionModel:SetPromiseShow(showCallback)
+	assert(type(showCallback) == "function", "Bad showCallback")
+
+	self._showCallback = showCallback
+end
+
+function TransitionModel:SetPromiseHide(hideCallback)
+	assert(type(hideCallback) == "function", "Bad hideCallback")
+
+	self._hideCallback = hideCallback
+end
+
+function TransitionModel:_promiseIsShown()
+	if self._isShowingComplete.Value then
+		return Promise.resolved()
+	end
+
+	local promise = Promise.new()
+
+	local maid = Maid.new()
+	self._maid[promise] = maid
+
+	maid:GiveTask(self._isShowingComplete.Changed:Connect(function()
+		if self._isShowingComplete.Value then
+			promise:Resolve()
+		end
+	end))
+
+	maid:GiveTask(self.VisibleChanged:Connect(function(isVisible)
+		if not isVisible then
+			promise:Reject()
+		end
+	end))
+
+	promise:Finally(function()
+		self._maid[promise] = nil
+	end)
+
+	return promise
+end
+
+function TransitionModel:_promiseIsHidden()
+	if self._isHidingComplete.Value then
+		return Promise.resolved()
+	end
+
+	local promise = Promise.new()
+
+	local maid = Maid.new()
+	self._maid[promise] = maid
+
+	maid:GiveTask(self._isHidingComplete.Changed:Connect(function()
+		if self._isHidingComplete.Value then
+			promise:Resolve()
+		end
+	end))
+
+	maid:GiveTask(self.VisibleChanged:Connect(function(isVisible)
+		if isVisible then
+			promise:Reject()
+		end
+	end))
+
+	promise:Finally(function()
+		self._maid[promise] = nil
+	end)
+
+	return promise
+end
+
+function TransitionModel:_executeShow(doNotAnimate)
+	local maid = Maid.new()
+
+	local promise = Promise.new()
+	maid:GiveTask(promise)
+
+	self._isHidingComplete.Value = false
+	self._isShowingComplete.Value = false
+
+	if self._showCallback then
+		local result = self._showCallback(maid, doNotAnimate)
+		if Promise.isPromise(result) then
+			promise:Resolve(result)
+		else
+			promise:Reject()
+			error(string.format("[TransitionModel] - Expected promise to be returned from showCallback, got %q", tostring(result)))
+		end
+	end
+
+	promise:Then(function()
+		self._isShowingComplete.Value = true
+	end)
+
+	self._maid._transition = maid
+end
+
+function TransitionModel:_executeHide(doNotAnimate)
+	local maid = Maid.new()
+
+	self._isHidingComplete.Value = false
+	self._isShowingComplete.Value = false
+
+	local promise = Promise.new()
+	maid:GiveTask(promise)
+
+	if self._hideCallback then
+		local result = self._hideCallback(maid, doNotAnimate)
+		if Promise.isPromise(result) then
+			promise:Resolve(result)
+		else
+			promise:Reject()
+			error(string.format("[TransitionModel] - Expected promise to be returned from showCallback, got %q", tostring(result)))
+		end
+	end
+
+	promise:Then(function()
+		self._isHidingComplete.Value = true
+	end)
+
+	self._maid._transition = maid
+end
+
+
+return TransitionModel

package/src/Shared/TransitionUtils.lua

@@ -0,0 +1,18 @@
+--[=[
+	@class TransitionUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BasicPane = require("BasicPane")
+
+local TransitionUtils = {}
+
+function TransitionUtils.isTransition(value)
+	return BasicPane.isBasicPane(value)
+		and type(value.PromiseShow) == "function"
+		and type(value.PromiseHide) == "function"
+		and type(value.PromiseToggle) == "function"
+end
+
+return TransitionUtils

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}