@quenty/buttondragmodel 1.0.1-canary.468.ea8a226.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.0.1-canary.468.ea8a226.0 (2024-05-09)
+
+
+### Features
+
+* Add ButtonDragModel ([401a108](https://github.com/Quenty/NevermoreEngine/commit/401a108c422e5582298ac69a6d50a34a771492b4))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2024 James Onnen (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 @@
+## ButtonDragModel
+
+<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>
+
+Model for dragging buttons around
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ButtonDragModelUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/buttondragmodel --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@quenty/buttondragmodel",
+  "version": "1.0.1-canary.468.ea8a226.0",
+  "description": "Model for dragging buttons around",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "buttondragmodel"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/buttondragmodel/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/inputobjectutils": "4.3.1-canary.468.ea8a226.0",
+    "@quenty/loader": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/maid": "3.1.1-canary.468.ea8a226.0",
+    "@quenty/rx": "13.2.1-canary.468.ea8a226.0",
+    "@quenty/valueobject": "13.2.1-canary.468.ea8a226.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "ea8a2260a364aaf6d6c246a93632b789935da134"
+}

package/src/Client/ButtonDragModel.lua

@@ -0,0 +1,342 @@
+--[=[
+	Computes the position of a user dragging a button around
+
+	@class ButtonDragModel
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local UserInputService = game:GetService("UserInputService")
+
+local BaseObject = require("BaseObject")
+local Maid = require("Maid")
+local InputObjectUtils = require("InputObjectUtils")
+local ValueObject = require("ValueObject")
+
+local ButtonDragModel = setmetatable({}, BaseObject)
+ButtonDragModel.ClassName = "ButtonDragModel"
+ButtonDragModel.__index = ButtonDragModel
+
+--[=[
+	Construst a new drag model for the button
+
+	@param initialButton GuiButton? -- Optional
+	@return ButtonDragModel
+]=]
+function ButtonDragModel.new(initialButton)
+	local self = setmetatable(BaseObject.new(), ButtonDragModel)
+
+	self._isMouseDown = self._maid:Add(ValueObject.new(false, "boolean"))
+	self._dragPosition = self._maid:Add(ValueObject.new(nil))
+	self._dragDelta = self._maid:Add(ValueObject.new(nil))
+	self._button = self._maid:Add(ValueObject.new(nil))
+
+	self._absoluteSize = self._maid:Add(ValueObject.new(Vector2.zero, "Vector2"))
+	self._isDragging = self._maid:Add(ValueObject.new(false, "boolean"))
+	self._clampWithinButton = self._maid:Add(ValueObject.new(false, "boolean"))
+
+	self._activePositions = {}
+
+	self._maid:GiveTask(self._dragPosition.Changed:Connect(function()
+		self._isDragging.Value = self._dragPosition.Value ~= nil
+	end))
+
+	self.DragPositionChanged = self._dragPosition.Changed
+	self.IsDraggingChanged = self._isDragging.Changed
+
+	if initialButton then
+		self:SetButton(initialButton)
+	end
+
+	self._maid:GiveTask(self._button:ObserveBrio(function(button)
+		return button ~= nil
+	end):Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid, button = brio:ToMaidAndValue()
+		self:_setupDragging(maid, button)
+	end))
+
+	return self
+end
+
+--[=[
+	Observes if anything is pressing down on the button itself
+
+	@return Observable<boolean>
+]=]
+function ButtonDragModel:ObserveIsDragging()
+	return self._isDragging:Observe()
+end
+
+--[=[
+	@return Observable<Brio<true>>
+]=]
+function ButtonDragModel:ObserveIsDraggingBrio()
+	return self._isDragging:ObserveBrio(function(value)
+		return value
+	end)
+end
+
+--[=[
+	@return Observable<Vector2 | nil>
+]=]
+function ButtonDragModel:ObserveDragDelta()
+	return self._dragDelta:Observe()
+end
+
+--[=[
+	@return Vector2 | nil
+]=]
+function ButtonDragModel:GetDragDelta()
+	return self._dragDelta.Value
+end
+
+--[=[
+	Returns true if pressed
+
+	@return boolean
+]=]
+function ButtonDragModel:GetIsPressed()
+	return self._isDragging.Value
+end
+
+--[=[
+	Returns the scale position on the Gui from 0 to 1
+
+	This is reletive to the GUI, so top left is 0, 0
+
+	@return Vector2 | nil
+]=]
+function ButtonDragModel:GetDragPosition()
+	return self._dragPosition.Value
+end
+
+--[=[
+	Observes the scale position on the Gui from 0 to 1
+
+	This is reletive to the GUI, so top left is 0, 0
+
+	@return Observable<Vector2 | nil>
+]=]
+function ButtonDragModel:ObserveDragPosition()
+	return self._dragPosition:Observe()
+end
+
+--[=[
+	Sets whether to clamp the results within the button bounds
+	@param clampWithinButton boolean
+]=]
+function ButtonDragModel:SetClampWithinButton(clampWithinButton)
+	self._clampWithinButton.Value = clampWithinButton
+end
+
+--[=[
+	Sets the current button for the model
+
+	@param button GuiButton
+	@return () -> () -- Cleanup function
+]=]
+function ButtonDragModel:SetButton(button)
+	assert(typeof(button) == "Instance" or button == nil, "Bad button")
+
+	self._button.Value = button
+
+	return function()
+		if self._button.Value == button then
+			self._button.Value = nil
+		end
+	end
+end
+
+function ButtonDragModel:_setupDragging(maid, button)
+	maid:GiveTask(self._clampWithinButton.Changed:Connect(function()
+		self:_updateCurrentPosition()
+	end))
+
+	maid:GiveTask(button.InputBegan:Connect(function(inputObject)
+		if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
+			self._activePositions.mouse = self:_toButtonSpace(button, inputObject.Position)
+			self._isMouseDown.Value = true
+			self:_updateCurrentPosition()
+		end
+
+		if inputObject.UserInputType == Enum.UserInputType.Touch then
+			self:_trackTouch(maid, button, inputObject)
+		end
+	end))
+
+	maid:GiveTask(button.InputEnded:Connect(function(inputObject)
+		if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
+			self._activePositions.mouse = nil
+			self._isMouseDown.Value = false
+		end
+
+		if inputObject.UserInputType == Enum.UserInputType.Touch then
+			self:_stopTouchTrack(maid, inputObject)
+		end
+	end))
+
+	maid:GiveTask(UserInputService.InputEnded:Connect(function(inputObject)
+		if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
+			self._activePositions.mouse = nil
+			self._isMouseDown.Value = false
+		end
+	end))
+
+	maid:GiveTask(function()
+		self._activePositions.mouse = nil
+		self._isMouseDown.Value = false
+	end)
+
+	maid:GiveTask(self._isMouseDown.Changed:Connect(function()
+		if self._isMouseDown.Value then
+			maid._mouse = self:_updateMouseTracking(button)
+		else
+			maid._mouse = nil
+		end
+	end))
+end
+
+function ButtonDragModel:_updateMouseTracking(button)
+	local maid = Maid.new()
+
+	local lastMousePosition = nil
+
+	local function setMousePosition(inputObject)
+		local previous = lastMousePosition
+		local current = inputObject.Position
+
+		lastMousePosition = current
+
+		if previous then
+			local delta = current - previous
+			self:_incrementDragDelta(delta)
+		end
+
+		self._activePositions.mouse = self:_toButtonSpace(button, current)
+		self:_updateCurrentPosition()
+	end
+
+	maid:GiveTask(UserInputService.InputChanged:Connect(function(inputObject)
+		if not InputObjectUtils.isMouseUserInputType(inputObject.UserInputType) then
+			return
+		end
+
+		local screenGui = button:FindFirstAncestorWhichIsA("ScreenGui")
+		if not screenGui then
+			self._activePositions.mouse = nil
+			self:_updateCurrentPosition()
+			return
+		end
+
+		if not (screenGui:FindFirstAncestorWhichIsA("PlayerGui") or screenGui:FindFirstAncestorWhichIsA("CoreGui")) then
+			-- TODO: Handle billboard guis
+			self._activePositions.mouse = nil
+			self:_updateCurrentPosition()
+			return
+		end
+
+		setMousePosition(inputObject)
+	end))
+
+	maid:GiveTask(button.InputChanged:Connect(function(inputObject)
+		if InputObjectUtils.isMouseUserInputType(inputObject.UserInputType) then
+			setMousePosition(inputObject)
+		end
+	end))
+
+	maid:GiveTask(function()
+		self._activePositions.mouse = nil
+		self:_updateCurrentPosition()
+	end)
+
+	return maid
+end
+
+function ButtonDragModel:_trackTouch(buttonMaid, button, inputObject)
+	buttonMaid[inputObject] = nil
+
+	if inputObject.UserInputState == Enum.UserInputState.End then
+		return
+	end
+
+	local maid = Maid.new()
+
+	self._activePositions[inputObject] = self:_toButtonSpace(button, inputObject.Position)
+	self:_incrementDragDelta(inputObject.Delta)
+
+	maid:GiveTask(inputObject:GetPropertyChangedSignal("Delta"):Connect(function()
+		self:_incrementDragDelta(inputObject.Delta)
+	end))
+
+	maid:GiveTask(inputObject:GetPropertyChangedSignal("Position"):Connect(function()
+		self._activePositions[inputObject] = self:_toButtonSpace(button, inputObject.Position)
+		self:_updateCurrentPosition()
+	end))
+	maid:GiveTask(inputObject:GetPropertyChangedSignal("UserInputState"):Connect(function()
+		if inputObject.UserInputState == Enum.UserInputState.End then
+			maid[inputObject] = nil
+		end
+	end))
+
+	maid:GiveTask(function()
+		self._activePositions[inputObject] = nil
+		self:_updateCurrentPosition()
+	end)
+
+	self:_updateCurrentPosition()
+
+	maid[inputObject] = maid
+end
+
+function ButtonDragModel:_stopTouchTrack(buttonMaid, inputObject)
+	-- Clears the input tracking as we slide off the button
+	buttonMaid[inputObject] = nil
+end
+
+function ButtonDragModel:_toButtonSpace(button, position)
+	local pos = button.AbsolutePosition
+	local size = button.AbsoluteSize
+
+	return (Vector2.new(position.x, position.y) - pos)/size
+end
+
+function ButtonDragModel:_updateCurrentPosition()
+	local current = Vector2.zero
+	local count = 0
+	for _, item in pairs(self._activePositions) do
+		current = current + item
+		count = count + 1
+	end
+	if count == 0 then
+		self._dragPosition.Value = nil
+		self._dragDelta.Value = nil
+		return
+	end
+
+	current = current/count
+	local x = current.x
+	local y = current.y
+
+	if self._clampWithinButton.Value then
+		x = math.clamp(x, 0, 1)
+		y = math.clamp(x, 0, 1)
+	end
+
+	local position = Vector2.new(x, y)
+	self._dragPosition.Value = position
+
+	if not self._dragDelta.Value then
+		self._dragDelta.Value = Vector2.zero
+	end
+end
+
+function ButtonDragModel:_incrementDragDelta(delta)
+	local current = self._dragDelta.Value or Vector2.zero
+	self._dragDelta.Value = current + Vector2.new(delta.x, delta.y)
+end
+
+return ButtonDragModel

package/src/node_modules.project.json

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

package/test/default.project.json

@@ -0,0 +1,12 @@
+{
+  "name": "ButtonDragModelTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "buttondragmodel": {
+        "$path": ".."
+      }
+    }
+  }
+}