Difference between revisions of "Math.distance"

From GiderosMobile
(Created page with "__NOTOC__ <languages /> '''<translate>Available since</translate>:''' Gideros 2020.9<br/> '''<translate>Class</translate>:''' math<br/> === <transl...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2020.9<br/>
'''<translate>Available since</translate>:''' Gideros 2020.9<br/>
+
'''Class:''' [[math]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/math|math]]<br/>
+
 
=== <translate>Description</translate> ===
+
=== Description ===
<translate>Returns the distance betwwen two points.</translate>
+
Returns the distance betwen two points.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(number) = math.distance(x1,y1,z1,x2,y2,z2)
 
(number) = math.distance(x1,y1,z1,x2,y2,z2)
 
(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})
 
(number) = math.distance({x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2})
</source>
+
</syntaxhighlight>
=== <translate>Parameters</translate> ===
+
 
'''x1''': (number) <translate>X component of the first point</translate> <br/>
+
'''Note''': the number will always be a positive number
'''y1''': (number) <translate>Y component of the first point</translate> <br/>
+
 
'''z1''': (number) <translate>Z component of the first point</translate> '''optional''' <br/>
+
=== Parameters ===
'''x2''': (number) <translate>X component of the second point</translate> <br/>
+
'''x1''': (number) X component of the first point<br/>
'''y2''': (number) <translate>Y component of the second point</translate> <br/>
+
'''y1''': (number) Y component of the first point<br/>
'''z2''': (number) <translate>Z component of the second point</translate> '''optional''' <br/>
+
'''z1''': (number) Z component of the first point '''optional'''<br/>
 +
'''x2''': (number) X component of the second point<br/>
 +
'''y2''': (number) Y component of the second point<br/>
 +
'''z2''': (number) Z component of the second point '''optional'''<br/>
 +
 
 +
=== Return values ===
 +
'''Returns''' (number) the distance between the two points (always positive)<br/>
  
=== <translate>Return values</translate> ===
+
=== Example ===
'''<translate>Returns</translate>''' (number) <translate>the distance between the two points</translate><br/>
+
<syntaxhighlight lang="lua">
 +
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
 +
</syntaxhighlight>
  
 
{{Math}}
 
{{Math}}

Latest revision as of 15:30, 13 July 2023

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