Math.distance

Available since: Gideros 2020.9
Class: math

Description

Returns the distance betwen two points.

(number) = math.distance(x1,y1,z1,x2,y2,z2)
(number) = math.distance({x1,y1,z1},{x2,y2,z2})
(number) = math.distance({x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2})

Note: the number will always be a positive number

Parameters

x1: (number) X component of the first point
y1: (number) Y component of the first point
z1: (number) Z component of the first point optional
x2: (number) X component of the second point
y2: (number) Y component of the second point
z2: (number) Z component of the second point optional

Return values

Returns (number) the distance between the two points (always positive)

Example

local mydist = 256
function LevelX:onEnterFrame(e)
	-- player position
	posx, posy = self.player1.body:getPosition()
	-- for perfs
	for k, v in pairs(self.myobjects) do -- k=sprite, v=box2d body
		local x1, y1 = v:getPosition()
		if math.distance(x1, y1, posx, posy) > mydist then
			k:setVisible(false)
		else
			k:setVisible(true)
		end
	end
end

Alternatives

The math.distance may not be the fastest. Here are some tests:

-- simple function timer by @antix
local x1, y1, x2, y2 = math.random(-100000, 100000), math.random(-100000, 100000), math.random(-100000, 100000), math.random(-100000, 100000)
local dx, dy

-- init
local dist = math.distance(x1, y1, x2, y2)
print("*** POINT A: "..x1, y1, "POINT B: "..x2, y2)
print("*** DISTANCE: "..dist)

-- tests
local data = {
	{
		"sqrt",
		function()
			local sqrt = math.sqrt
			dx, dy = x2-x1, y2-y1
			dist = sqrt(dx*dx + dy*dy)
		end, -- 65ms
	},
	{
		"exponent",
		function()
			dx, dy = x2-x1, y2-y1
			dist = (dx^2 + dy^2)^0.5
		end, -- 32ms
	},
	{
		"multiply/exponent",
		function()
			dx, dy = x2-x1, y2-y1
			dist = (dx*dx + dy*dy)^0.5
		end, -- 35ms
	},
	{
		"multiply/exponent without power",
		function()
			dx, dy = x2-x1, y2-y1
			dist = dx*dx + dy*dy
		end, -- 33ms
	},
	{
		"math.distance",
		function()
			dist = math.distance(x1, y1, x2, y2)
		end, -- 70ms
	},
}
 
-- run all functions
for i = 1, #data do
	local block = data[i]
	local func = block[2]
	local start = os.timer()
	for i = 1, 1000000 do -- 1 million repetitions!
		func()
	end
	local elapsed = math.floor((os.timer() - start) * 1000)
	print(block[1].." ("..elapsed.."ms)", "", "", "", "", "distance: "..dist)
end

--[[ RESULTS
*** POINT A: -83344	-2060	POINT B: 39448	23210
*** DISTANCE: 125365.25899945328
sqrt (73ms)					distance: 125365.25899945328
exponent (40ms)					distance: 125365.25899945328
multiply/exponent (46ms)					distance: 125365.25899945328
multiply/exponent without power (43ms)					distance: 15716448164
math.distance (74ms)					distance: 125365.25899945328
]]

---

• Math
• Math.abs
• Math.acos
• Math.asin
• Math.atan
• Math.atan2
• Math.ceil
• Math.clamp
• Math.cos
• Math.cosh
• Math.cross
• Math.deg
• Math.distance
• Math.distances
• Math.dot
• Math.edge
• Math.exp
• Math.fft
• Math.floor
• Math.fmod
• Math.frexp
• Math.ifft
• Math.inside
• Math.ldexp
• Math.length
• Math.log
• Math.log10
• Math.max
• Math.min
• Math.modf
• Math.nearest
• Math.noise
• Math.normalize
• Math.pow
• Math.rad
• Math.random
• Math.randomseed
• Math.raycast
• Math.round
• Math.sign
• Math.sin
• Math.sinh
• Math.sqrt
• Math.tan
• Math.tanh

• vector
• Pi
• Huge

---

---

• Main Page
• Lua API
• Main API
• Plugins