@quenty/geometryutils 6.8.1 → 6.8.2

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.
 
+## [6.8.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/geometryutils@6.8.1...@quenty/geometryutils@6.8.2) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 ## [6.8.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/geometryutils@6.8.0...@quenty/geometryutils@6.8.1) (2025-03-21)
 
 **Note:** Version bump only for package @quenty/geometryutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/geometryutils",
-  "version": "6.8.1",
+  "version": "6.8.2",
   "description": "Utility functions involving 3D and 2D geometry",
   "keywords": [
     "Roblox",
@@ -28,8 +28,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/draw": "^7.8.1",
-    "@quenty/loader": "^10.8.0"
+    "@quenty/draw": "^7.8.2",
+    "@quenty/loader": "^10.8.1"
   },
-  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/CameraPyramidUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class CameraPyramidUtils
 ]=]
@@ -9,7 +10,10 @@ local Draw = require("Draw")
 
 local CameraPyramidUtils = {}
 
-
+type InBoundIntersection = {
+	point: Vector3,
+	dist: number,
+}
 
 --[=[
 	Treating the camera like a pyramid, compute points on the screen that the ray intersects with the
@@ -25,23 +29,28 @@ local CameraPyramidUtils = {}
 	@return Vector3? -- Screen point1
 	@return Vector3? -- Screen point2
 ]=]
-function CameraPyramidUtils.rayIntersection(camera, rayOrigin, unitRayDirection, debugMaid)
+function CameraPyramidUtils.rayIntersection(
+	camera: Camera,
+	rayOrigin: Vector3,
+	unitRayDirection: Vector3,
+	debugMaid: any?
+): (Vector3?, Vector3?)
 	assert(typeof(rayOrigin) == "Vector3", "Bad rayOrigin")
 	assert(typeof(unitRayDirection) == "Vector3", "Bad unitRayDirection")
 
-	unitRayDirection = unitRayDirection.unit
+	unitRayDirection = unitRayDirection.Unit
 	local camCFrame = camera.CFrame
 	local viewportSize = camera.ViewportSize
-	if viewportSize.x <= 0 or viewportSize.y <= 0 then
+	if viewportSize.X <= 0 or viewportSize.Y <= 0 then
 		return nil, nil
 	end
 
-	local aspectRatio = viewportSize.x/viewportSize.y
-	local halfVerticalFov = math.rad(camera.FieldOfView/2)
-	local halfHorizontalFov = math.atan(math.tan(halfVerticalFov)*aspectRatio)
+	local aspectRatio = viewportSize.X / viewportSize.Y
+	local halfVerticalFov = math.rad(camera.FieldOfView / 2)
+	local halfHorizontalFov = math.atan(math.tan(halfVerticalFov) * aspectRatio)
 
 	-- Construct pyramid with normals facing out
-	local origin = camCFrame.p
+	local origin = camCFrame.Position
 	local cframeTop = (camCFrame * CFrame.Angles(halfVerticalFov, 0, 0))
 	local cframeBottom = (camCFrame * CFrame.Angles(-halfVerticalFov, 0, 0))
 	local cframeLeft = (camCFrame * CFrame.Angles(0, halfHorizontalFov, 0))
@@ -62,42 +71,44 @@ function CameraPyramidUtils.rayIntersection(camera, rayOrigin, unitRayDirection,
 	local leftInBounds = CameraPyramidUtils._isInBounds(camCFrame, intersectionLeft, halfVerticalFov, false)
 	local rightInBounds = CameraPyramidUtils._isInBounds(camCFrame, intersectionRight, halfVerticalFov, false)
 
-	local inBoundsIntersections = {}
-	if topInBounds then
+	local inBoundsIntersections: { InBoundIntersection } = {}
+	if topInBounds and intersectionTop and distTop then
 		table.insert(inBoundsIntersections, {
-			point = intersectionTop;
-			dist = distTop;
+			point = intersectionTop,
+			dist = distTop,
 		})
 	end
-	if bottomInBounds then
+	if bottomInBounds and intersectionBottom and distBottom then
 		table.insert(inBoundsIntersections, {
-			point = intersectionBottom;
-			dist = distBottom;
+			point = intersectionBottom,
+			dist = distBottom,
 		})
 	end
-	if leftInBounds then
+	if leftInBounds and intersectionLeft and distLeft then
 		table.insert(inBoundsIntersections, {
-			point = intersectionLeft;
-			dist = distLeft;
+			point = intersectionLeft,
+			dist = distLeft,
 		})
 	end
-	if rightInBounds then
+	if rightInBounds and intersectionRight and distRight then
 		table.insert(inBoundsIntersections, {
-			point = intersectionRight;
-			dist = distRight;
+			point = intersectionRight,
+			dist = distRight,
 		})
 	end
 
 	if debugMaid then
 		debugMaid._top = CameraPyramidUtils._drawIntersection(camera, unitRayDirection, intersectionTop, topInBounds)
-		debugMaid._bottom = CameraPyramidUtils._drawIntersection(camera, unitRayDirection, intersectionBottom, bottomInBounds)
+		debugMaid._bottom =
+			CameraPyramidUtils._drawIntersection(camera, unitRayDirection, intersectionBottom, bottomInBounds)
 		debugMaid._left = CameraPyramidUtils._drawIntersection(camera, unitRayDirection, intersectionLeft, leftInBounds)
-		debugMaid._right = CameraPyramidUtils._drawIntersection(camera, unitRayDirection, intersectionRight, rightInBounds)
+		debugMaid._right =
+			CameraPyramidUtils._drawIntersection(camera, unitRayDirection, intersectionRight, rightInBounds)
 	end
 
 	if #inBoundsIntersections == 0 then
 		return nil, nil
- 	elseif #inBoundsIntersections == 1 then
+	elseif #inBoundsIntersections == 1 then
 		-- Happens when the other point fades off into the distance on this one screen such that it never ends
 		local data = inBoundsIntersections[1]
 		local intersection = data.point
@@ -136,44 +147,49 @@ function CameraPyramidUtils.rayIntersection(camera, rayOrigin, unitRayDirection,
 	end
 end
 
-function CameraPyramidUtils._drawIntersection(camera, unitRayDirection, intersection, inBounds)
-	if not inBounds then
+function CameraPyramidUtils._drawIntersection(
+	camera: Camera,
+	unitRayDirection: Vector3,
+	intersection: Vector3?,
+	inBounds: boolean
+): Instance?
+	if not inBounds or not intersection then
 		return nil
 	end
 
-	local halfVerticalFov = math.rad(camera.FieldOfView/2)
+	local halfVerticalFov = math.rad(camera.FieldOfView / 2)
 	local viewportSize = camera.ViewportSize
 	local PIXELS_DIAMETER = 40
-	local PIXELS_OFFSET = 5 + PIXELS_DIAMETER/2
+	local PIXELS_OFFSET = 5 + PIXELS_DIAMETER / 2
 
 	local position = camera:WorldToViewportPoint(intersection)
-	local dist = position.z
-	local worldHeight = 2*math.tan(halfVerticalFov)*dist
-	local scale = worldHeight/viewportSize.y
+	local dist = position.Z
+	local worldHeight = 2 * math.tan(halfVerticalFov) * dist
+	local scale = worldHeight / viewportSize.Y
 
-	local firstPoint = intersection + PIXELS_OFFSET*unitRayDirection*scale
-	local secondPoint = intersection - PIXELS_OFFSET*unitRayDirection*scale
+	local firstPoint = intersection + PIXELS_OFFSET * unitRayDirection * scale
+	local secondPoint = intersection - PIXELS_OFFSET * unitRayDirection * scale
 
 	local _, onScreen1 = camera:WorldToViewportPoint(firstPoint)
 	local _, onScreen2 = camera:WorldToViewportPoint(secondPoint)
 
 	local color = Color3.new(1, 1, 0)
 	if onScreen1 then
-		return Draw.point(firstPoint, color, nil, PIXELS_DIAMETER*scale)
+		return Draw.point(firstPoint, color, nil, PIXELS_DIAMETER * scale)
 	elseif onScreen2 then
-		return Draw.point(secondPoint, color, nil, PIXELS_DIAMETER*scale)
+		return Draw.point(secondPoint, color, nil, PIXELS_DIAMETER * scale)
 	else
 		return nil
 	end
 end
 
-function CameraPyramidUtils._isInBounds(camCFrame, intersection, halfFov, isVertical)
+function CameraPyramidUtils._isInBounds(camCFrame: CFrame, intersection: Vector3?, halfFov: number, isVertical: boolean): boolean
 	if not intersection then
 		return false
 	end
 
-	local relative = camCFrame:pointToObjectSpace(intersection)
-	local dist = -relative.z
+	local relative = camCFrame:PointToObjectSpace(intersection)
+	local dist = -relative.Z
 
 	if dist < 0 then
 		return false
@@ -182,9 +198,9 @@ function CameraPyramidUtils._isInBounds(camCFrame, intersection, halfFov, isVert
 	-- Discard the other information (we're projecting onto the flat camera plane)
 	local horizontalDist
 	if isVertical then
-		horizontalDist = math.abs(relative.x)
+		horizontalDist = math.abs(relative.X)
 	else
-		horizontalDist = math.abs(relative.y)
+		horizontalDist = math.abs(relative.Y)
 	end
 
 	local angle = math.atan2(horizontalDist, dist)

package/src/Shared/CircleUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class CircleUtils
 ]=]
@@ -13,7 +14,7 @@ local CircleUtils = {}
 	@param circumference number
 	@return number
 ]=]
-function CircleUtils.updatePositionToSmallestDistOnCircle(position, target, circumference)
+function CircleUtils.updatePositionToSmallestDistOnCircle(position: number, target: number, circumference: number): number
 	assert(target >= 0 and target <= circumference, "Target must be between 0 and circumference")
 
 	if math.abs(position - target) <= circumference/2 then

package/src/Shared/Line.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class Line
 ]=]
@@ -10,25 +11,27 @@ local Line = {}
 	@param r Vector3 -- Offset from a
 	@param b Vector3
 	@param s Vector3
+	@return Vector3
+	@return Vector3
 ]=]
-function Line.intersection(a, r, b, s)
-	local q = a - b;
+function Line.intersection(a: Vector3, r: Vector3, b: Vector3, s: Vector3): (Vector3, Vector3)
+	local q = a - b
 
-	local dotqr = q:Dot(r); -- same as: r:Dot(q)
-	local dotqs = q:Dot(s); -- same as: s:Dot(q)
-	local dotrs = r:Dot(s); -- same as: s:Dot(r)
-	local dotrr = r:Dot(r);
-	local dotss = s:Dot(s);
+	local dotqr = q:Dot(r) -- same as: r:Dot(q)
+	local dotqs = q:Dot(s) -- same as: s:Dot(q)
+	local dotrs = r:Dot(s) -- same as: s:Dot(r)
+	local dotrr = r:Dot(r)
+	local dotss = s:Dot(s)
 
-	local denom = dotrr * dotss - dotrs * dotrs;
-	local numer = dotqs * dotrs - dotqr * dotss;
+	local denom = dotrr * dotss - dotrs * dotrs
+	local numer = dotqs * dotrs - dotqr * dotss
 
-	local t = numer / denom;
-	local u = (dotqs + t * dotrs) / dotss;
+	local t = numer / denom
+	local u = (dotqs + t * dotrs) / dotss
 
 	-- return the two points on each line that make up the shortest line
-	local p0, p1 = a + t * r, b + u * s;
-	return p0, p1;
+	local p0, p1 = a + t * r, b + u * s
+	return p0, p1
 end
 
 return Line

package/src/Shared/OrthogonalUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utilities involving orthogonal Vector3s
 	@class OrthogonalUtils
@@ -10,8 +11,8 @@ local OrthogonalUtils = {}
 	@param cframe CFrame
 	return { Vector3 }
 ]=]
-function OrthogonalUtils.decomposeCFrameToVectors(cframe)
-	return  {
+function OrthogonalUtils.decomposeCFrameToVectors(cframe: CFrame): { Vector3 }
+	return {
 		cframe.LookVector, -- front
 		-cframe.LookVector,
 		cframe.RightVector,
@@ -28,10 +29,10 @@ end
 	@param unitVector Vector3
 	return Vector3?
 ]=]
-function OrthogonalUtils.getClosestVector(options, unitVector)
+function OrthogonalUtils.getClosestVector(options: { Vector3 }, unitVector: Vector3): Vector3?
 	local best = nil
 	local bestAngle = -math.huge
-	for _, option in pairs(options) do
+	for _, option in options do
 		local dotAngle = option:Dot(unitVector)
 		if dotAngle > bestAngle then
 			bestAngle = dotAngle
@@ -49,7 +50,7 @@ end
 	@param snapToCFrame CFrame
 	return CFrame
 ]=]
-function OrthogonalUtils.snapCFrameTo(cframe, snapToCFrame)
+function OrthogonalUtils.snapCFrameTo(cframe: CFrame, snapToCFrame: CFrame): CFrame
 	local options = OrthogonalUtils.decomposeCFrameToVectors(snapToCFrame)
 	local rightVector = OrthogonalUtils.getClosestVector(options, cframe.RightVector)
 	local upVector = OrthogonalUtils.getClosestVector(options, cframe.UpVector)

package/src/Shared/PlaneUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions involving planes!
 	@class PlaneUtils
@@ -16,13 +17,14 @@ local PlaneUtils = {}
 	@param rayOrigin Vector3
 	@param unitRayDirection Vector3
 	@return Vector3? -- Intersection point
+	@return number? -- Distance to intersection point
 ]=]
-function PlaneUtils.rayIntersection(origin, normal, rayOrigin, unitRayDirection)
+function PlaneUtils.rayIntersection(origin: Vector3, normal: Vector3, rayOrigin: Vector3, unitRayDirection: Vector3): (Vector3?, number?)
 	local rpoint = rayOrigin - origin
 	local dot = unitRayDirection:Dot(normal)
 	if dot == 0 then
 		-- Parallel
-		return nil
+		return nil, nil
 	end
 
 	local t = -rpoint:Dot(normal) / dot

package/src/Shared/ScaleModelUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility methods to scale a model
 	@class ScaleModelUtils
@@ -6,8 +7,8 @@
 local ScaleModelUtils = {}
 
 local CLASS_NAME_TO_MIN_SIZE = {
-	["TrussPart"] = Vector3.new(2, 2, 2);
-	["UnionOperation"]  = Vector3.zero;
+	["TrussPart"] = Vector3.new(2, 2, 2),
+	["UnionOperation"] = Vector3.zero,
 }
 
 local MIN_PART_SIZE = Vector3.new(0.05, 0.05, 0.05)
@@ -17,7 +18,7 @@ local MIN_PART_SIZE = Vector3.new(0.05, 0.05, 0.05)
 	@param part BasePart
 	@param scale number
 ]=]
-function ScaleModelUtils.scalePartSize(part, scale)
+function ScaleModelUtils.scalePartSize(part: BasePart, scale: Vector3 | number)
 	local partSize = part.Size
 
 	local mesh = part:FindFirstChildWhichIsA("DataModelMesh")
@@ -33,14 +34,12 @@ function ScaleModelUtils.scalePartSize(part, scale)
 
 	local minSize = CLASS_NAME_TO_MIN_SIZE[part.ClassName] or MIN_PART_SIZE
 
-	if newPartSize.X < minSize.X
-		or newPartSize.Y < minSize.Y
-		or newPartSize.Z < minSize.Z then
-
+	if newPartSize.X < minSize.X or newPartSize.Y < minSize.Y or newPartSize.Z < minSize.Z then
 		newPartSize = Vector3.new(
 			math.max(newPartSize.X, minSize.X),
 			math.max(newPartSize.Y, minSize.Y),
-			math.max(newPartSize.Z, minSize.Z))
+			math.max(newPartSize.Z, minSize.Z)
+		)
 
 		-- We need a mesh for scaling (hopefully)
 		mesh = ScaleModelUtils.createMeshFromPart(part)
@@ -49,7 +48,7 @@ function ScaleModelUtils.scalePartSize(part, scale)
 	part.Size = newPartSize
 
 	if mesh then
-		mesh.Scale = newRenderSize/newPartSize
+		mesh.Scale = newRenderSize / newPartSize
 		mesh.Offset = mesh.Offset * scale
 	end
 end
@@ -61,7 +60,7 @@ end
 	@param scale number
 	@param centroid Vector3
 ]=]
-function ScaleModelUtils.scalePart(part, scale, centroid)
+function ScaleModelUtils.scalePart(part: BasePart, scale: Vector3 | number, centroid: Vector3)
 	assert(typeof(part) == "Instance" and part:IsA("BasePart"), "Bad part")
 
 	local partPosition = part.Position
@@ -80,8 +79,8 @@ end
 	@param scale number -- The scale to scale by
 	@param centroid Vector3 -- the center to scale by
 ]=]
-function ScaleModelUtils.scale(parts, scale, centroid)
-	for _, part in pairs(parts) do
+function ScaleModelUtils.scale(parts: { BasePart }, scale: number, centroid: Vector3)
+	for _, part in parts do
 		ScaleModelUtils.scalePart(part, scale, centroid)
 	end
 end
@@ -92,7 +91,7 @@ end
 	@param part BasePart
 	@return Mesh?
 ]=]
-function ScaleModelUtils.createMeshFromPart(part)
+function ScaleModelUtils.createMeshFromPart(part: BasePart): FileMesh?
 	if part:IsA("WedgePart") then
 		local mesh = Instance.new("SpecialMesh")
 		mesh.MeshType = Enum.MeshType.Wedge

package/src/Shared/SphereUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions involving spheres
 	@class SphereUtils
@@ -15,9 +16,9 @@ local SphereUtils = {}
 	@return boolean
 ]=]
 function SphereUtils.intersectsRay(
-	sphereCenter, sphereRadius,
-	rayOrigin, rayDirection
-)
+	sphereCenter: Vector3, sphereRadius: number,
+	rayOrigin: Vector3, rayDirection: Vector3
+): boolean
 	local relOrigin = rayOrigin - sphereCenter
 	local rr = relOrigin:Dot(relOrigin)
 	local dr = rayDirection:Dot(relOrigin)

package/src/Shared/SurfaceUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions for surfaces
 	@class SurfaceUtils
@@ -7,9 +8,9 @@ local SurfaceUtils = {}
 
 local UP = Vector3.new(0, 1, 0)
 local BACK = Vector3.new(0, 0, 1)
-local EXTRASPIN = CFrame.fromEulerAnglesXYZ(math.pi/2, 0, 0)
+local EXTRASPIN = CFrame.fromEulerAnglesXYZ(math.pi / 2, 0, 0)
 
-local function getTranstionBetween(v1, v2, pitchAxis)
+local function getTranstionBetween(v1: Vector3, v2: Vector3, pitchAxis: Vector3): CFrame
 	local dot = v1:Dot(v2)
 	if dot > 0.99999 then
 		return CFrame.new()
@@ -30,7 +31,7 @@ end
 	@param lnormal Vector3
 	@return CFrame
 ]=]
-function SurfaceUtils.getSurfaceCFrame(part, lnormal)
+function SurfaceUtils.getSurfaceCFrame(part: BasePart, lnormal: Vector3): CFrame
 	local transition = getTranstionBetween(UP, lnormal, BACK)
 	return part.CFrame * transition * EXTRASPIN
 end

package/src/Shared/SwingTwistUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Authored by Egomoose, modified by Quenty
 
@@ -10,16 +11,16 @@ local SwingTwistUtils = {}
 	Decomposes a CFrame into a swing and a twist.
 	@param cf CFrame
 	@param direction Vector3
-	@return Vector3 -- swing
-	@return Vector3 -- twist
+	@return CFrame -- swing
+	@return CFrame -- twist
 ]=]
-function SwingTwistUtils.swingTwist(cf, direction)
+function SwingTwistUtils.swingTwist(cf: CFrame, direction: Vector3): (CFrame, CFrame)
 	local axis, theta = cf:ToAxisAngle()
 	-- convert to quaternion
-	local w, v = math.cos(theta/2),  math.sin(theta/2)*axis
+	local w, v = math.cos(theta / 2), math.sin(theta / 2) * axis
 
 	-- (v . d)*d, plug into CFrame quaternion constructor with w it will solve rest for us
-	local proj = v:Dot(direction)*direction
+	local proj = v:Dot(direction) * direction
 	local twist = CFrame.new(0, 0, 0, proj.X, proj.Y, proj.Z, w)
 
 	-- cf = swing * twist, thus...
@@ -33,7 +34,7 @@ end
 	@param direction Vector3
 	@return number
 ]=]
-function SwingTwistUtils.twistAngle(cf, direction)
+function SwingTwistUtils.twistAngle(cf: CFrame, direction: Vector3): number
 	local axis, theta = cf:ToAxisAngle()
 	local w, v = math.cos(theta/2),  math.sin(theta/2)*axis
 	local proj = v:Dot(direction)*direction