@quenty/vector3utils 4.1.0 → 4.1.1-canary.256.3cf0683.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.1.1-canary.256.3cf0683.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@4.1.0...@quenty/vector3utils@4.1.1-canary.256.3cf0683.0) (2022-03-27)
+
+
+### Bug Fixes
+
+* Add types to core libraries ([6e685b3](https://github.com/Quenty/NevermoreEngine/commit/6e685b3cfbcd3816d15962769a4310a1ec57fb7e))
+
+
+### Features
+
+* Add RandomVector3Utils.getDirectedRandomUnitVector(direction: Vector3, angleRad: number): Vector3 ([8c5e03a](https://github.com/Quenty/NevermoreEngine/commit/8c5e03a0917b2fdf978890dd508dfdcceca7643b))
+
+
+
+
+
 # [4.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@4.0.0...@quenty/vector3utils@4.1.0) (2022-03-20)
 
 **Note:** Version bump only for package @quenty/vector3utils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/vector3utils",
-  "version": "4.1.0",
+  "version": "4.1.1-canary.256.3cf0683.0",
   "description": "Utilities involving Vector3 objects in Roblox",
   "keywords": [
     "Roblox",
@@ -25,11 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^4.0.0",
-    "@quenty/math": "^2.1.0"
+    "@quenty/loader": "4.0.1-canary.256.3cf0683.0",
+    "@quenty/math": "2.1.1-canary.256.3cf0683.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "126c7a7e01245332b3e7622600b3528c5e0e97ae"
+  "gitHead": "3cf06830affe1e6a6ca452a87969520cd941ccaa"
 }

package/src/Shared/RandomVector3Utils.lua

@@ -9,7 +9,7 @@ local RandomVector3Utils = {}
 	Equal distribution unit vectors around a sphere
 	@return Vector3
 ]=]
-function RandomVector3Utils.getRandomUnitVector()
+function RandomVector3Utils.getRandomUnitVector(): Vector3
 	local s = 2*(math.random()-0.5)
 	local t = 6.2831853071796*math.random()
 	local rx = s
@@ -19,4 +19,40 @@ function RandomVector3Utils.getRandomUnitVector()
 	return Vector3.new(rx, ry, rz)
 end
 
+--[=[
+	Gets a uniformally distributed random unit vector3 in the direction
+	specified.
+
+	@param direction Vector3
+	@param angleRad number -- Angle in radians
+	@return Vector3
+]=]
+function RandomVector3Utils.getDirectedRandomUnitVector(direction: Vector3, angleRad: number): Vector3
+	assert(typeof(direction) == "Vector3", "Bad direction")
+	assert(type(angleRad) == "number", "Bad angleRad")
+
+	local s = 1 - (1 - math.cos(angleRad))*math.random()
+	local t = 6.2831853071796*math.random()
+	local rx = s
+	local m = (1-s*s)^0.5
+	local ry = m*math.cos(t)
+	local rz = m*math.sin(t)
+
+	local dx, dy, dz = direction.x, direction.y, direction.z
+	local d = (dx*dx+dy*dy+dz*dz)^0.5
+
+	if dx/d < -0.9999 then
+		return Vector3.new(-rx, ry, rz)
+	elseif dx/d < 0.9999 then
+		local coef1 = (rx- dx*(dy*ry+dz*rz)/(dy*dy+dz*dz))/d
+		local coef2 = (dz*ry-dy*rz)/(dy*dy+dz*dz)
+		return Vector3.new(
+			(dx*rx+dy*ry+dz*rz)/d,
+			dy*coef1+dz*coef2,
+			dz*coef1-dy*coef2)
+	else
+		return Vector3.new(rx, ry, rz)
+	end
+end
+
 return RandomVector3Utils

package/src/Shared/Vector3Utils.lua

@@ -1,5 +1,5 @@
 --[=[
-	Utilities involving Vector3 objects in Roblox
+	Utilities involving Vector3 objects in Roblox.
 	@class Vector3Utils
 ]=]
 
@@ -14,7 +14,7 @@ local Vector3Utils = {}
 	@param vector2 Vector2
 	@return Vector3
 ]=]
-function Vector3Utils.fromVector2XY(vector2)
+function Vector3Utils.fromVector2XY(vector2: Vector2): Vector3
 	return Vector3.new(vector2.x, vector2.y, 0)
 end
 
@@ -23,7 +23,7 @@ end
 	@param vector2 Vector2
 	@return Vector3
 ]=]
-function Vector3Utils.fromVector2XZ(vector2)
+function Vector3Utils.fromVector2XZ(vector2: Vector2): Vector3
 	return Vector3.new(vector2.x, 0, vector2.y)
 end
 
@@ -33,7 +33,7 @@ end
 	@param b Vector3
 	@return number?
 ]=]
-function Vector3Utils.getAngleRad(a, b)
+function Vector3Utils.getAngleRad(a: Vector3, b: Vector3): number
 	if a.magnitude == 0 then
 		return nil
 	end
@@ -47,7 +47,7 @@ end
 	@param b Vector3
 	@return number
 ]=]
-function Vector3Utils.angleBetweenVectors(a, b)
+function Vector3Utils.angleBetweenVectors(a: Vector3, b: Vector3): number
 	local u = b.magnitude*a
 	local v = a.magnitude*b
 	return 2*math.atan2((v - u).magnitude, (u + v).magnitude)
@@ -55,11 +55,17 @@ end
 
 --[=[
 	Rounds the vector to the nearest number
+
+	```lua
+	-- Snaps to a grid!
+	local snapped = Vector3Utils.round(position, 4)
+	```
+
 	@param vector3 Vector3
 	@param amount number
 	@return Vector3
 ]=]
-function Vector3Utils.round(vector3, amount)
+function Vector3Utils.round(vector3: Vector3, amount: number): number
 	return Vector3.new(Math.round(vector3.x, amount), Math.round(vector3.y, amount), Math.round(vector3.z, amount))
 end