Vector3: add limit_to

This commit is contained in:
Starbeamrainbowlabs 2021-06-26 15:32:47 +01:00
parent 6d0447a02f
commit 773e6354ad
No known key found for this signature in database
GPG Key ID: 1BE5172E637709C2
2 changed files with 66 additions and 0 deletions

@ -0,0 +1,52 @@
local Vector3 = require("worldeditadditions.utils.vector3")
describe("Vector3.limit_to", function()
it("should limit_to a positive vector", function()
local a = Vector3.new(801980510, 801980510, 801980510)
assert.are.same(
Vector3.new(80198051, 80198051, 80198051),
a:limit_to(138907099)
)
end)
it("should limit_to a negative vector", function()
local a = Vector3.new(-1897506260, -1897506260, -1897506260)
assert.are.same(
Vector3.new(-189750626, -189750626, -189750626),
a:limit_to(328657725)
)
end)
it("should work if the length is borderline", function()
local a = Vector3.new(80198051, 80198051, 80198051)
assert.are.same(
Vector3.new(80198051, 80198051, 80198051),
a:limit_to(138907099)
)
end)
it("should not change anything if the length is smaller", function()
local a = Vector3.new(3, 4, 5)
assert.are.same(
Vector3.new(3, 4, 5),
a:limit_to(100)
)
end)
it("should return a new Vector3 instance", function()
local a = Vector3.new(801980510, 801980510, 801980510)
local result = a:limit_to(138907099)
assert.are.same(
Vector3.new(80198051, 80198051, 80198051),
result
)
assert.are_not.equal(result, a)
end)
it("should return a new Vector3 instance if the length is smaller", function()
local a = Vector3.new(3, 4, 5)
local result = a:limit_to(101)
assert.are.same(
Vector3.new(3, 4, 5),
result
)
assert.are_not.equal(result, a)
end)
end)

@ -162,6 +162,20 @@ function Vector3.length(a)
return math.sqrt(a:length_squared())
end
--- Returns a new vector whose length clamped to the given length.
-- The direction in which the vector is pointing is not changed.
-- @param a Vector3 The vector to operate on.
-- @returns Vector3 A new Vector3 instance limited to the specified length.
function Vector3.limit_to(a, length)
if type(length) ~= "number" then error("Error: Expected number, but found "..type(length)..".") end
if a:length() > length then
return (a / a:length()) * length
end
return a:clone()
end
-- ██████ ██████ ███████ ██████ █████ ████████ ██████ ██████
-- ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
-- ██ ██ ██████ █████ ██████ ███████ ██ ██ ██ ██████