@quenty/qframe 10.10.0 → 10.10.1-canary.542.7609692.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.10.1-canary.542.7609692.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/qframe@10.10.0...@quenty/qframe@10.10.1-canary.542.7609692.0) (2025-03-13)
+
+**Note:** Version bump only for package @quenty/qframe
+
+
+
+
+
 # [10.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/qframe@10.9.0...@quenty/qframe@10.10.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/qframe

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/qframe",
-  "version": "10.10.0",
+  "version": "10.10.1-canary.542.7609692.0",
   "description": "CFrame representation as a quaternion for Roblox",
   "keywords": [
     "Roblox",
@@ -27,15 +27,15 @@
     "AxisAngles"
   ],
   "dependencies": {
-    "@quenty/loader": "^10.8.0"
+    "@quenty/loader": "10.8.0"
   },
   "devDependencies": {
-    "@quenty/camerastoryutils": "^10.10.0",
-    "@quenty/cubicspline": "^10.8.0",
-    "@quenty/maid": "^3.4.0"
+    "@quenty/camerastoryutils": "10.10.1-canary.542.7609692.0",
+    "@quenty/cubicspline": "10.8.0",
+    "@quenty/maid": "3.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "76096921c6c965e5c4f9c796f97642d16d628c6b"
 }

package/src/Shared/QFrame.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	CFrame representation as a quaternion. Alternative representation of a [CFrame].
 	@class QFrame
@@ -6,19 +7,24 @@
 local QFrame = {}
 QFrame.__index = QFrame
 
+export type QFrame = typeof(setmetatable(
+	{} :: {
+		x: number,
+		y: number,
+		z: number,
+		W: number,
+		X: number,
+		Y: number,
+		Z: number,
+	},
+	QFrame
+))
+
 --[=[
 	Constructs a new QFrame
-
-	@param x number?
-	@param y number?
-	@param z number?
-	@param W number?
-	@param X number?
-	@param Y number?
-	@param Z number?
 	@return QFrame
 ]=]
-function QFrame.new(x, y, z, W, X, Y, Z)
+function QFrame.new(x: number?, y: number?, z: number?, W: number?, X: number?, Y: number?, Z: number?): QFrame
 	local self = setmetatable({}, QFrame)
 	self.x = x or 0
 	self.y = y or 0
@@ -36,7 +42,7 @@ end
 	@param value any
 	@return boolean
 ]=]
-function QFrame.isQFrame(value)
+function QFrame.isQFrame(value: any): boolean
 	return getmetatable(value) == QFrame
 end
 
@@ -46,23 +52,23 @@ end
 	@param closestTo QFrame
 	@return QFrame
 ]=]
-function QFrame.fromCFrameClosestTo(cframe, closestTo)
+function QFrame.fromCFrameClosestTo(cframe: CFrame, closestTo: QFrame)
 	assert(typeof(cframe) == "CFrame", "Bad cframe")
 	assert(QFrame.isQFrame(closestTo), "Bad closestTo")
 
-	local axis, angle = cframe:toAxisAngle()
-	local W = math.cos(angle/2)
-	local X = math.sin(angle/2)*axis.x
-	local Y = math.sin(angle/2)*axis.y
-	local Z = math.sin(angle/2)*axis.z
+	local axis, angle = cframe:ToAxisAngle()
+	local W = math.cos(angle / 2)
+	local X = math.sin(angle / 2) * axis.X
+	local Y = math.sin(angle / 2) * axis.Y
+	local Z = math.sin(angle / 2) * axis.Z
 
-	local dot = W*closestTo.W + X*closestTo.X + Y*closestTo.Y + Z*closestTo.Z
+	local dot = W * closestTo.W + X * closestTo.X + Y * closestTo.Y + Z * closestTo.Z
 
 	if dot < 0 then
-		return QFrame.new(cframe.x, cframe.y, cframe.z, -W, -X, -Y, -Z)
+		return QFrame.new(cframe.X, cframe.Y, cframe.Z, -W, -X, -Y, -Z)
 	end
 
-	return QFrame.new(cframe.x, cframe.y, cframe.z, W, X, Y, Z)
+	return QFrame.new(cframe.X, cframe.Y, cframe.Z, W, X, Y, Z)
 end
 
 --[=[
@@ -71,19 +77,20 @@ end
 	@param qFrame QFrame
 	@return QFrame
 ]=]
-function QFrame.fromVector3(vector, qFrame)
+function QFrame.fromVector3(vector: Vector3, qFrame: QFrame): QFrame
 	assert(typeof(vector) == "Vector3", "Bad vector")
-	assert(QFrame.isQFrame(qFrame))
+	assert(QFrame.isQFrame(qFrame), "Bad qFrame")
 
-	return QFrame.new(vector.x, vector.y, vector.z, qFrame.W, qFrame.X, qFrame.Y, qFrame.Z)
+	return QFrame.new(vector.X, vector.Y, vector.Z, qFrame.W, qFrame.X, qFrame.Y, qFrame.Z)
 end
 
 --[=[
 	Converts the QFrame to a [CFrame]
+
 	@param self QFrame
-	@return CFrame
+	@return CFrame?
 ]=]
-function QFrame.toCFrame(self)
+function QFrame.toCFrame(self): CFrame?
 	local cframe = CFrame.new(self.x, self.y, self.z, self.X, self.Y, self.Z, self.W)
 	if cframe == cframe then
 		return cframe
@@ -97,7 +104,7 @@ end
 	@param self QFrame
 	@return Vector3
 ]=]
-function QFrame.toPosition(self)
+function QFrame.toPosition(self: QFrame): Vector3
 	return Vector3.new(self.x, self.y, self.z)
 end
 
@@ -106,9 +113,8 @@ end
 	@param a QFrame
 	@return boolean
 ]=]
-function QFrame.isNAN(a)
-	return a.x ~= a.x or a.y ~= a.y or a.z ~= a.z
-		or a.W ~= a.W or a.X ~= a.X or a.Y ~= a.Y or a.Z ~= a.Z
+function QFrame.isNAN(a: QFrame): boolean
+	return a.x ~= a.x or a.y ~= a.y or a.z ~= a.z or a.W ~= a.W or a.X ~= a.X or a.Y ~= a.Y or a.Z ~= a.Z
 end
 
 --[=[
@@ -116,7 +122,7 @@ end
 	@param a QFrame
 	@return QFrame
 ]=]
-function QFrame.__unm(a)
+function QFrame.__unm(a: QFrame): QFrame
 	return QFrame.new(-a.x, -a.y, -a.z, -a.W, -a.X, -a.Y, -a.Z)
 end
 
@@ -126,9 +132,8 @@ end
 	@param b QFrame
 	@return QFrame
 ]=]
-function QFrame.__add(a, b)
-	assert(QFrame.isQFrame(a) and QFrame.isQFrame(b),
-		"QFrame + non-QFrame attempted")
+function QFrame.__add(a: QFrame, b: QFrame): QFrame
+	assert(QFrame.isQFrame(a) and QFrame.isQFrame(b), "QFrame + non-QFrame attempted")
 
 	return QFrame.new(a.x + b.x, a.y + b.y, a.z + b.z, a.W + b.W, a.X + b.X, a.Y + b.Y, a.Z + b.Z)
 end
@@ -139,9 +144,8 @@ end
 	@param b QFrame
 	@return QFrame
 ]=]
-function QFrame.__sub(a, b)
-	assert(QFrame.isQFrame(a) and QFrame.isQFrame(b),
-		"QFrame - non-QFrame attempted")
+function QFrame.__sub(a: QFrame, b: QFrame): QFrame
+	assert(QFrame.isQFrame(a) and QFrame.isQFrame(b), "QFrame - non-QFrame attempted")
 
 	return QFrame.new(a.x - b.x, a.y - b.y, a.z - b.z, a.W - b.W, a.X - b.X, a.Y - b.Y, a.Z - b.Z)
 end
@@ -152,7 +156,7 @@ end
 	@param b number
 	@return QFrame
 ]=]
-function QFrame.__pow(a, b)
+function QFrame.__pow(a: QFrame, b: QFrame): QF
 	assert(QFrame.isQFrame(a) and type(b) == "number", "Bad a or b")
 
 	-- Center of mass agnostic power formula
@@ -163,38 +167,38 @@ function QFrame.__pow(a, b)
 	local aW, aX, aY, aZ = a.W, a.X, a.Y, a.Z
 
 	-- first let's power the quaternion
-	local aMag = math.sqrt(aW*aW + aX*aX + aY*aY + aZ*aZ)
-	local aIm = math.sqrt(aX*aX + aY*aY + aZ*aZ)
-	local cMag = aMag^b
+	local aMag = math.sqrt(aW * aW + aX * aX + aY * aY + aZ * aZ)
+	local aIm = math.sqrt(aX * aX + aY * aY + aZ * aZ)
+	local cMag = aMag ^ b
 
-	if aIm <= 1e-8*aMag then
-		return QFrame.new(b*ax, b*ay, b*az, cMag, 0, 0, 0)
+	if aIm <= 1e-8 * aMag then
+		return QFrame.new(b * ax, b * ay, b * az, cMag, 0, 0, 0)
 	end
 
-	local rx = aX/aIm
-	local ry = aY/aIm
-	local rz = aZ/aIm
+	local rx = aX / aIm
+	local ry = aY / aIm
+	local rz = aZ / aIm
 
-	local cAng = b*math.atan2(aIm, aW)
+	local cAng = b * math.atan2(aIm, aW)
 	local cCos = math.cos(cAng)
 	local cSin = math.sin(cAng)
 
-	local cW = cMag*cCos
-	local cX = cMag*cSin*rx
-	local cY = cMag*cSin*ry
-	local cZ = cMag*cSin*rz
+	local cW = cMag * cCos
+	local cX = cMag * cSin * rx
+	local cY = cMag * cSin * ry
+	local cZ = cMag * cSin * rz
 
 	-- now we power the position
-	local k = ax*rx + ay*ry + az*rz
-	local wx, wy, wz = k*rx, k*ry, k*rz
+	local k = ax * rx + ay * ry + az * rz
+	local wx, wy, wz = k * rx, k * ry, k * rz
 	local ux, uy, uz = ax - wx, ay - wy, az - wz
-	local vx, vy, vz = ry*az - rz*ay, rz*ax - rx*az, rx*ay - ry*ax
-	local re = cSin*(aW/aIm*cCos + cSin)
-	local im = cSin*(aW/aIm*cSin - cCos)
+	local vx, vy, vz = ry * az - rz * ay, rz * ax - rx * az, rx * ay - ry * ax
+	local re = cSin * (aW / aIm * cCos + cSin)
+	local im = cSin * (aW / aIm * cSin - cCos)
 
-	local cx = re*ux + im*vx + b*wx
-	local cy = re*uy + im*vy + b*wy
-	local cz = re*uz + im*vz + b*wz
+	local cx = re * ux + im * vx + b * wx
+	local cy = re * uy + im * vy + b * wy
+	local cz = re * uz + im * vz + b * wz
 
 	return QFrame.new(cx, cy, cz, cW, cX, cY, cZ)
 end
@@ -207,12 +211,13 @@ end
 ]=]
 function QFrame.__mul(a, b)
 	if type(a) == "number" and QFrame.isQFrame(b) then
-		return QFrame.new(a*b.x, a*b.y, a*b.z, a*b.W, a*b.X, a*b.Y, a*b.Z)
+		return QFrame.new(a * b.x, a * b.y, a * b.z, a * b.W, a * b.X, a * b.Y, a * b.Z)
 	elseif QFrame.isQFrame(a) and type(b) == "number" then
-		return QFrame.new(a.x*b, a.y*b, a.z*b, a.W*b, a.X*b, a.Y*b, a.Z*b)
+		return QFrame.new(a.x * b, a.y * b, a.z * b, a.W * b, a.X * b, a.Y * b, a.Z * b)
 	elseif QFrame.isQFrame(a) and QFrame.isQFrame(b) then
-		local A2 = a.W*a.W + a.X*a.X + a.Y*a.Y + a.Z*a.Z
+		local A2 = a.W * a.W + a.X * a.X + a.Y * a.Y + a.Z * a.Z
 
+		-- stylua: ignore
 		return QFrame.new(
 			a.x + ((a.W*a.W + a.X*a.X - a.Y*a.Y - a.Z*a.Z)*b.x + 2*(a.X*a.Y - a.W*a.Z)*b.y + 2*(a.W*a.Y + a.X*a.Z)*b.z)
 				/A2,
@@ -235,9 +240,9 @@ end
 	@param b number
 	@return QFrame
 ]=]
-function QFrame.__div(a, b)
+function QFrame.__div(a: QFrame, b: number): QFrame
 	if type(b) == "number" then
-		return QFrame.new(a.x/b, a.y/b, a.z/b, a.W/b, a.X/b, a.Y/b, a.Z/b)
+		return QFrame.new(a.x / b, a.y / b, a.z / b, a.W / b, a.X / b, a.Y / b, a.Z / b)
 	else
 		error("QFrame / non-QFrame attempted")
 	end
@@ -249,9 +254,8 @@ end
 	@param b QFrame
 	@return boolean
 ]=]
-function QFrame.__eq(a, b)
-	return a.x == b.x and a.y == b.y and a.z == b.z
-		and a.W == b.W and a.X == b.X and a.Y == b.Y and a.Z == b.Z
+function QFrame.__eq(a: QFrame, b: QFrame)
+	return a.x == b.x and a.y == b.y and a.z == b.z and a.W == b.W and a.X == b.X and a.Y == b.Y and a.Z == b.Z
 end
 
-return QFrame
+return QFrame