@quenty/highlight 1.0.1-canary.288.c2f64f9.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.288.c2f64f9.0 (2022-09-26)
+
+
+### Features
+
+* Add animated highlight package ([fa70218](https://github.com/Quenty/NevermoreEngine/commit/fa702186b2cae6919fb925d5050d68c35ce6939b))

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,21 @@
+## Highlight
+<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>
+
+Animated highlight system for the Roblox highlight object
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/AnimatedHighlight">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/highlight --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@quenty/highlight",
+  "version": "1.0.1-canary.288.c2f64f9.0",
+  "description": "Animated highlight system for the Roblox highlight object",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "Highlight",
+    "Blend"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/highlight/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "5.1.2-canary.288.c2f64f9.0",
+    "@quenty/basicpane": "6.1.1-canary.288.c2f64f9.0",
+    "@quenty/blend": "5.1.1-canary.288.c2f64f9.0",
+    "@quenty/enumutils": "2.0.1-canary.288.c2f64f9.0",
+    "@quenty/instanceutils": "6.1.1-canary.288.c2f64f9.0",
+    "@quenty/loader": "5.0.2-canary.288.c2f64f9.0",
+    "@quenty/maid": "2.4.0",
+    "@quenty/math": "2.2.0",
+    "@quenty/selectionutils": "1.0.1-canary.288.c2f64f9.0",
+    "@quenty/signal": "2.3.0",
+    "@quenty/table": "3.1.0",
+    "@quenty/valueobject": "6.1.1-canary.288.c2f64f9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "c2f64f9bb90b0e5f0e4f4bc04a58af852bac6460"
+}

package/src/Client/AnimatedHighlight.lua

@@ -0,0 +1,187 @@
+--[=[
+	@class AnimatedHighlight
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BasicPane = require("BasicPane")
+local BasicPaneUtils = require("BasicPaneUtils")
+local Blend = require("Blend")
+local SpringObject = require("SpringObject")
+local Math = require("Math")
+local ValueObject = require("ValueObject")
+local EnumUtils = require("EnumUtils")
+local Maid = require("Maid")
+local Signal = require("Signal")
+
+local AnimatedHighlight = setmetatable({}, BasicPane)
+AnimatedHighlight.ClassName = "AnimatedHighlight"
+AnimatedHighlight.__index = AnimatedHighlight
+
+function AnimatedHighlight.new()
+	local self = setmetatable(BasicPane.new(), AnimatedHighlight)
+
+	self._adornee = Instance.new("ObjectValue")
+	self._adornee.Value = nil
+	self._maid:GiveTask(self._adornee)
+
+	self._highlightDepthMode = ValueObject.new(Enum.HighlightDepthMode.AlwaysOnTop)
+	self._maid:GiveTask(self._highlightDepthMode)
+
+	self._fillColor = Instance.new("Color3Value")
+	self._fillColor.Value = Color3.new(1, 1, 1)
+	self._maid:GiveTask(self._fillColor)
+
+	self._outlineColor = Instance.new("Color3Value")
+	self._outlineColor.Value = Color3.new(1, 1, 1)
+	self._maid:GiveTask(self._outlineColor)
+
+	self._fillTransparencySpring = SpringObject.new(0.5, 40)
+	self._maid:GiveTask(self._fillTransparencySpring)
+
+	self._outlineTransparencySpring = SpringObject.new(0, 40)
+	self._maid:GiveTask(self._outlineTransparencySpring)
+
+	self._percentVisible = SpringObject.new(BasicPaneUtils.observePercentVisible(self), 20)
+	self._maid:GiveTask(self._percentVisible)
+
+	self.Destroying = Signal.new()
+	self._maid:GiveTask(function()
+		self.Destroying:Fire()
+		self.Destroying:Destroy()
+	end)
+
+	self._maid:GiveTask(self:_render():Subscribe(function(highlight)
+		self.Gui = highlight
+	end))
+
+	return self
+end
+
+--[=[
+	Sets the depth mode. Either can be:
+
+	* Enum.HighlightDepthMode.AlwaysOnTop
+	* Enum.HighlightDepthMode.Occluded
+
+	@param depthMode Enum.HighlightDepthMode
+]=]
+function AnimatedHighlight:SetHighlightDepthMode(depthMode)
+	assert(EnumUtils.isOfType(Enum.HighlightDepthMode, depthMode))
+
+	self._highlightDepthMode.Value = depthMode
+end
+
+function AnimatedHighlight:SetTransparencySpeed(speed)
+	assert(type(speed) == "number", "Bad speed")
+
+	self._fillTransparencySpring.Speed = speed
+	self._outlineTransparencySpring.Speed = speed
+end
+
+function AnimatedHighlight:SetSpeed(speed)
+	assert(type(speed) == "number", "Bad speed")
+
+	self._percentVisible.Speed = speed
+end
+
+function AnimatedHighlight:Finish(doNotAnimate, callback)
+	if self._percentVisible.p == 0 and self._percentVisible.v == 0 then
+		callback()
+
+		return
+	end
+
+	local maid = Maid.new()
+	local done = false
+	maid:GiveTask(self._percentVisible:ObserveRenderStepped():Subscribe(function(position)
+		if position == 0 then
+			done = true
+			callback()
+		end
+	end))
+
+	self:Hide(doNotAnimate)
+
+	maid:GiveTask(function()
+		self._maid[maid] = nil
+	end)
+	self._maid[maid] = maid
+
+	if not done then
+		maid:GiveTask(self.VisibleChanged:Connect(function(isVisible)
+			if isVisible then
+				-- cancel
+				self._maid[maid]:DoCleaning()
+			end
+		end))
+	end
+end
+
+function AnimatedHighlight:SetFillColor(color)
+	assert(typeof(color) == "Color3", "Bad color")
+
+	self._fillColor.Value = color
+end
+
+function AnimatedHighlight:SetOutlineColor(color)
+	assert(typeof(color) == "Color3", "Bad color")
+
+	self._outlineColor.Value = color
+end
+
+function AnimatedHighlight:SetAdornee(adornee)
+	assert(typeof(adornee) == "Instance" or adornee == nil, "Bad adornee")
+
+	self._adornee.Value = adornee
+end
+
+function AnimatedHighlight:GetAdornee()
+	return self._adornee.Value
+end
+
+function AnimatedHighlight:SetOutlineTransparency(outlineTransparency, doNotAnimate)
+	assert(type(outlineTransparency) == "number", "Bad outlineTransparency")
+
+	self._outlineTransparencySpring.Target = outlineTransparency
+	if doNotAnimate then
+		self._outlineTransparencySpring.Position = outlineTransparency
+		self._outlineTransparencySpring.Velocity = 0
+	end
+end
+
+function AnimatedHighlight:SetFillTransparency(fillTransparency, doNotAnimate)
+	assert(type(fillTransparency) == "number", "Bad fillTransparency")
+
+	self._fillTransparencySpring.Target = fillTransparency
+	if doNotAnimate then
+		self._fillTransparencySpring.Position = fillTransparency
+		self._fillTransparencySpring.Velocity = 0
+	end
+end
+
+function AnimatedHighlight:_render()
+	return Blend.New "Highlight" {
+		Name = "AnimatedHighlight";
+		Archivable = false;
+		DepthMode = self._highlightDepthMode;
+		FillColor = self._fillColor;
+		OutlineColor = self._outlineColor;
+		FillTransparency = Blend.Computed(
+			self._fillTransparencySpring:ObserveRenderStepped(),
+			self._percentVisible:ObserveRenderStepped(),
+			function(transparency, visible)
+				return Math.map(visible, 0, 1, 1, transparency);
+			end);
+		OutlineTransparency = Blend.Computed(
+			self._outlineTransparencySpring:ObserveRenderStepped(),
+			self._percentVisible:ObserveRenderStepped(),
+			function(transparency, visible)
+				return Math.map(visible, 0, 1, 1, transparency);
+			end);
+		Adornee = self._adornee;
+		Parent = self._adornee;
+	}
+end
+
+return AnimatedHighlight

package/src/Client/AnimatedHighlight.story.lua

@@ -0,0 +1,38 @@
+--[[
+	@class AnimatedHighlight.story
+]]
+
+local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).load(script)
+
+local Maid = require("Maid")
+local AnimatedHighlight = require("AnimatedHighlight")
+local RxSelectionUtils = require("RxSelectionUtils")
+
+return function(_target)
+	local maid = Maid.new()
+
+	maid:GiveTask(RxSelectionUtils.observeFirstAdornee():Subscribe(function(adornee)
+		if adornee then
+			local renderMaid = Maid.new()
+
+			local animatedHighlight = AnimatedHighlight.new()
+			animatedHighlight:SetFillColor(Color3.new(1, 0.5, 0.5))
+			animatedHighlight:SetAdornee(adornee)
+			animatedHighlight:Show()
+
+			renderMaid:GiveTask(function()
+				animatedHighlight:Finish(false, function()
+					animatedHighlight:Destroy()
+				end)
+			end)
+
+			maid._current = renderMaid
+		else
+			maid._current = nil
+		end
+	end))
+
+	return function()
+		maid:DoCleaning()
+	end
+end

package/src/Client/AnimatedHighlightGroup.lua

@@ -0,0 +1,213 @@
+--[=[
+	@class AnimatedHighlightGroup
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local AnimatedHighlight = require("AnimatedHighlight")
+local Maid = require("Maid")
+local ValueObject = require("ValueObject")
+local EnumUtils = require("EnumUtils")
+local Set = require("Set")
+
+local AnimatedHighlightGroup = setmetatable({}, BaseObject)
+AnimatedHighlightGroup.ClassName = "AnimatedHighlightGroup"
+AnimatedHighlightGroup.__index = AnimatedHighlightGroup
+
+function AnimatedHighlightGroup.new()
+	local self = setmetatable(BaseObject.new(), AnimatedHighlightGroup)
+
+	self._highlightDepthMode = ValueObject.new(Enum.HighlightDepthMode.AlwaysOnTop)
+	self._maid:GiveTask(self._highlightDepthMode)
+
+	self._defaultFillColor = Instance.new("Color3Value")
+	self._defaultFillColor.Value = Color3.new(1, 1, 1)
+	self._maid:GiveTask(self._defaultFillColor)
+
+	self._defaultTransparencySpeed = Instance.new("NumberValue")
+	self._defaultTransparencySpeed.Value = 40
+	self._maid:GiveTask(self._defaultTransparencySpeed)
+
+	self._defaultFillTransparency = Instance.new("NumberValue")
+	self._defaultFillTransparency.Value = 0.5
+	self._maid:GiveTask(self._defaultFillTransparency)
+
+	self._defaultOutlineTransparency = Instance.new("NumberValue")
+	self._defaultOutlineTransparency.Value = 0
+	self._maid:GiveTask(self._defaultOutlineTransparency)
+
+	self._defaultSpeed = Instance.new("NumberValue")
+	self._defaultSpeed.Value = 20
+	self._maid:GiveTask(self._defaultSpeed)
+
+	self._defaultOutlineColor = Instance.new("Color3Value")
+	self._defaultOutlineColor.Value = Color3.new(1, 1, 1)
+	self._maid:GiveTask(self._defaultOutlineColor)
+
+	self._highlights = {}
+
+	return self
+end
+
+--[=[
+	Sets the depth mode. Either can be:
+
+	* Enum.HighlightDepthMode.AlwaysOnTop
+	* Enum.HighlightDepthMode.Occluded
+
+	@param depthMode Enum.HighlightDepthMode
+]=]
+function AnimatedHighlightGroup:SetDefaultHighlightDepthMode(depthMode)
+	assert(EnumUtils.isOfType(Enum.HighlightDepthMode, depthMode))
+
+	self._highlightDepthMode.Value = depthMode
+end
+
+function AnimatedHighlightGroup:SetDefaultFillTransparency(transparency)
+	assert(type(transparency) == "number", "Bad transparency")
+
+	self._defaultFillTransparency.Value = transparency
+end
+
+function AnimatedHighlightGroup:SetDefaultOutlineTransparency(outlineTransparency)
+	assert(type(outlineTransparency) == "number", "Bad outlineTransparency")
+
+	self._defaultFillTransparency.Value = outlineTransparency
+end
+
+function AnimatedHighlightGroup:SetDefaultFillColor(color)
+	assert(typeof(color) == "Color3", "Bad color")
+
+	self._defaultFillColor.Value = color
+end
+
+function AnimatedHighlightGroup:GetDefaultFillColor()
+	return self._defaultFillColor.Value
+end
+
+function AnimatedHighlightGroup:SetDefaultOutlineColor(color)
+	assert(typeof(color) == "Color3", "Bad color")
+
+	self._defaultOutlineColor.Value = color
+end
+
+function AnimatedHighlightGroup:SetDefaultTransparencySpeed(speed)
+	assert(type(speed) == "number", "Bad speed")
+
+	self._defaultTransparencySpeed.Value = speed
+end
+
+function AnimatedHighlightGroup:SetDefaultSpeed(speed)
+	assert(type(speed) == "number", "Bad speed")
+
+	self._defaultSpeed.Value = speed
+end
+
+function AnimatedHighlightGroup:GetDefaultOutlineColor()
+	return self._defaultOutlineColor.Value
+end
+
+function AnimatedHighlightGroup:Highlight(adornee, doNotAnimate)
+	assert(typeof(adornee) == "Instance", "Bad adornee")
+
+	local highlight = self:_getOrCreateHighlight(adornee)
+	highlight:Show(doNotAnimate)
+	return highlight
+end
+
+function AnimatedHighlightGroup:EraseAllBut(adorneeList, doNotAnimate)
+	assert(type(adorneeList) == "table", "Bad adorneeList")
+
+	local set = Set.fromList(adorneeList)
+
+	for adornee, highlight in pairs(self._highlights) do
+		if not set[adornee] then
+			highlight:Hide(doNotAnimate)
+		end
+	end
+end
+
+function AnimatedHighlightGroup:EraseAll()
+	for _, highlight in pairs(self._highlights) do
+		highlight:Hide()
+	end
+end
+
+function AnimatedHighlightGroup:FindHighlight(adornee)
+	return self._highlights[adornee]
+end
+
+function AnimatedHighlightGroup:Erase(adornee)
+	assert(typeof(adornee) == "Instance", "Bad adornee")
+
+	local highlight = self:FindHighlight(adornee)
+	if highlight then
+		highlight:Hide()
+	end
+end
+
+function AnimatedHighlightGroup:ResetHighlightProperties(adornee, doNotAnimate)
+	local highlight = self:FindHighlight(adornee)
+	if highlight then
+		self:_setDefaultValues(highlight, doNotAnimate)
+	end
+end
+
+function AnimatedHighlightGroup:_setDefaultValues(highlight, doNotAnimate)
+	highlight:SetHighlightDepthMode(self._highlightDepthMode.Value)
+	highlight:SetTransparencySpeed(self._defaultTransparencySpeed.Value)
+	highlight:SetSpeed(self._defaultSpeed.Value)
+
+	highlight:SetFillTransparency(self._defaultFillTransparency.Value, doNotAnimate)
+	highlight:SetOutlineTransparency(self._defaultOutlineTransparency.Value, doNotAnimate)
+	highlight:SetFillColor(self._defaultFillColor.Value)
+	highlight:SetOutlineColor(self._defaultOutlineColor.Value)
+end
+
+function AnimatedHighlightGroup:_getOrCreateHighlight(adornee)
+	local foundHighlight = self._highlights[adornee]
+	if foundHighlight then
+		return foundHighlight
+	end
+
+	local maid = Maid.new()
+
+	local highlight = AnimatedHighlight.new()
+	self:_setDefaultValues(highlight, true)
+	highlight:SetAdornee(adornee)
+	maid:GiveTask(highlight)
+
+	maid:GiveTask(highlight.Destroying:Connect(function()
+		self:_removeHighlight(highlight)
+	end))
+
+	maid:GiveTask(highlight.VisibleChanged:Connect(function(isVisible, doNotAnimate)
+		if not isVisible then
+			highlight:Finish(doNotAnimate, function()
+				self:_removeHighlight(highlight)
+			end)
+		end
+	end))
+
+	self._highlights[adornee] = highlight
+	maid:GiveTask(function()
+		if self._highlights[adornee] == highlight then
+			self._highlights[adornee] = nil
+		end
+	end)
+
+	self._maid[highlight] = maid
+
+	return highlight
+end
+
+function AnimatedHighlightGroup:_removeHighlight(highlight)
+	self._maid[highlight] = nil
+end
+
+function AnimatedHighlightGroup:_findHighlightAdornee(adornee)
+	return self._highlights[adornee]
+end
+
+return AnimatedHighlightGroup

package/src/Client/AnimatedHighlightGroup.story.lua

@@ -0,0 +1,40 @@
+--[[
+	@class AnimatedHighlight.story
+]]
+
+local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).load(script)
+
+local Maid = require("Maid")
+local AnimatedHighlightGroup = require("AnimatedHighlightGroup")
+local RxSelectionUtils = require("RxSelectionUtils")
+
+return function(_target)
+	local maid = Maid.new()
+
+	local animatedHighlightGroup = AnimatedHighlightGroup.new()
+	animatedHighlightGroup:SetDefaultFillColor(Color3.new(0.5, 1, 0.5))
+	animatedHighlightGroup:SetDefaultSpeed(20)
+	animatedHighlightGroup:SetDefaultHighlightDepthMode(Enum.HighlightDepthMode.Occluded)
+	maid:GiveTask(animatedHighlightGroup)
+
+	maid:GiveTask(RxSelectionUtils.observeAdorneesBrio():Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local adorneeMaid = brio:ToMaid()
+		local adornee = brio:GetValue()
+
+		animatedHighlightGroup:Highlight(adornee)
+
+		adorneeMaid:GiveTask(function()
+			if animatedHighlightGroup.Destroy then
+				animatedHighlightGroup:Erase(adornee)
+			end
+		end)
+	end))
+
+	return function()
+		maid:DoCleaning()
+	end
+end

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,11 @@
+{
+  "name": "HighlightTest",
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "highlight": {
+        "$path": ".."
+      }
+    }
+  }
+}