@quenty/spring 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/spring@2.1.0...@quenty/spring@2.2.0) (2021-12-18)
+
+
+### Features
+
+* Allow transformation of Color3 into a linear value for interpolation ([a770697](https://github.com/Quenty/NevermoreEngine/commit/a7706970e4de8969bdd0f5a8b54e1803c89f9e87))
+
+
+
+
+
 # [2.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/spring@2.0.0...@quenty/spring@2.1.0) (2021-09-22)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/spring",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Spring implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -28,5 +28,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6288c63115f31544fce6663d018826e81ef01c7f"
+  "dependencies": {
+    "@quenty/loader": "^3.1.1"
+  },
+  "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
 }

package/src/Shared/LinearValue.lua

@@ -0,0 +1,96 @@
+---
+-- @classmod LinearValue
+-- @author Quenty
+
+local LinearValue = {}
+LinearValue.ClassName = "LinearValue"
+LinearValue.__index = LinearValue
+
+function LinearValue.new(constructor, values)
+	return setmetatable({
+		_constructor = constructor;
+		_values = values;
+	}, LinearValue)
+end
+
+function LinearValue.isLinear(value)
+	return type(value) == "table" and getmetatable(value) == LinearValue
+end
+
+function LinearValue:ToBaseValue()
+	return self._constructor(unpack(self._values))
+end
+
+local function operation(func)
+	return function(a, b)
+		if LinearValue.isLinear(a) and LinearValue.isLinear(b) then
+			assert(a._constructor == b._constructor, "a is not the same type of linearValue as b")
+
+			local values = {}
+			for i=1, #a._values do
+				values[i] = func(a._values[i], b._values[i])
+			end
+			return LinearValue.new(a._constructor, values)
+		elseif LinearValue.isLinear(a) then
+			if type(b) == "number" then
+				local values = {}
+				for i=1, #a._values do
+					values[i] = func(a._values[i], b)
+				end
+				return LinearValue.new(a._constructor, values)
+			else
+				error("Bad type (b)")
+			end
+		elseif LinearValue.isLinear(b) then
+			if type(a) == "number" then
+				local values = {}
+				for i=1, #b._values do
+					values[i] = func(a, b._values[i])
+				end
+				return LinearValue.new(b._constructor, values)
+			else
+				error("Bad type (a)")
+			end
+		else
+			error("Neither value is a linearValue")
+		end
+	end
+end
+
+function LinearValue:GetMagnitude()
+	local dot = 0
+	for i=1, #self._values do
+		local value = self._values[i]
+		dot = dot + value*value
+	end
+	return math.sqrt(dot)
+end
+
+function LinearValue:__index(key)
+	if LinearValue[key] then
+		return LinearValue[key]
+	elseif key == "magnitude" then
+		return self:GetMagnitude()
+	else
+		return nil
+	end
+end
+
+LinearValue.__add = operation(function(a, b)
+	return a + b
+end)
+
+LinearValue.__sub = operation(function(a, b)
+	return a - b
+end)
+
+LinearValue.__mul = operation(function(a, b)
+	return a * b
+end)
+
+LinearValue.__div = operation(function(a, b)
+	return a / b
+end)
+
+
+return LinearValue

package/src/Shared/SpringUtils.lua

@@ -4,6 +4,9 @@
 
 local EPSILON = 1e-6
 
+local require = require(script.Parent.loader).load(script)
+local LinearValue = require("LinearValue")
+
 local SpringUtils = {}
 
 function SpringUtils.animating(spring, epsilon)
@@ -16,7 +19,7 @@ function SpringUtils.animating(spring, epsilon)
 	if type(target) == "number" then
 		animating = math.abs(spring.Position - spring.Target) > epsilon
 			or math.abs(spring.Velocity) > epsilon
-	elseif typeof(target) == "Vector3" then
+	elseif typeof(target) == "Vector3" or LinearValue.isLinear(target) then
 		animating = (spring.Position - spring.Target).magnitude > epsilon
 			or spring.Velocity.magnitude > epsilon
 	else
@@ -40,4 +43,20 @@ function SpringUtils.getVelocityAdjustment(velocity, dampen, speed)
 	return velocity*(2*dampen/speed)
 end
 
+function SpringUtils.toLinearIfNeeded(value)
+	if typeof(value) == "Color3" then
+		return LinearValue.new(Color3.new, {value.r, value.g, value.b})
+	else
+		return value
+	end
+end
+
+function SpringUtils.fromLinearIfNeeded(value)
+	if LinearValue.isLinear(value) then
+		return value:ToBaseValue()
+	else
+		return value
+	end
+end
+
 return SpringUtils

package/src/node_modules.project.json

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