Sprite:hitTestPoint: Difference between revisions

From GiderosMobile
No edit summary
mNo edit summary
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
'''Class:''' [[Sprite]]<br/>
=== <translate>Description</translate> ===
 
<translate><br />
=== Description ===
Checks whether the given coordinates (in global coordinate system) is in bounds of the sprite.<br />
Checks whether the given coordinates (in global coordinate system) is in bounds of the sprite.
<br />
<syntaxhighlight lang="lua">
<br /></translate>
(bool) = Sprite:hitTestPoint(x,y,onlyvisible,ref)
<source lang="lua">
</syntaxhighlight>
(bool) = Sprite:hitTestPoint(x,y,shapeFlag)
 
</source>
=== Parameters ===
=== <translate>Parameters</translate> ===
'''x''': (number) the x coordinate to test<br/>
'''x''': (number) <translate></translate> <br/>
'''y''': (number) the y coordinate to test<br/>
'''y''': (number) <translate></translate> <br/>
'''onlyvisible''': (bool) hit test only for visible sprite (clipping/masking) '''optional, default = false'''<br/>
'''shapeFlag''': (bool) <translate>Take clipping/masking into consideration when testing hit point</translate> '''optional'''<br/>
'''ref''': (Sprite) specifies which sprite is the reference of x,y coordinates. If nil global coordinates are assumed '''optional, default = nil''', '''new Gideros 2023.2'''<br/>
=== <translate>Return values</translate> ===
 
'''<translate>Returns</translate>''' (bool) <translate>''true'' if the given global coordinates are in bounds of the sprite, ''false'' otherwise.</translate><br/>
=== Return values ===
'''Returns''' (bool) ''true'' if the given global coordinates are in bounds of the sprite, ''false'' otherwise<br/>
 
=== Example ===
'''Moves a pixel with the mouse'''
<syntaxhighlight lang="lua">
local pixel = Pixel.new(0xff0000, 1, 32, 32)
local x0, y0, focus
pixel:addEventListener(Event.MOUSE_DOWN, function(e)
if pixel:hitTestPoint(e.x, e.y) then
focus = true
x0, y0 = e.x, e.y
e:stopPropagation()
end
end)
pixel:addEventListener(Event.MOUSE_MOVE, function(e)
if focus then
local dx = e.x - x0
local dy = e.y - y0
pixel:setX(self.camera:getX() + dx)
pixel:setY(self.camera:getY() + dy)
x0 = e.x
y0 = e.y
e:stopPropagation()
end
end)
pixel:addEventListener(Event.MOUSE_UP, function(e)
if focus then
focus = false
e:stopPropagation()
end
end)
</syntaxhighlight>
 
{{Sprite}}

Latest revision as of 04:28, 23 April 2024

Available since: Gideros 2011.6
Class: Sprite

Description

Checks whether the given coordinates (in global coordinate system) is in bounds of the sprite.

(bool) = Sprite:hitTestPoint(x,y,onlyvisible,ref)

Parameters

x: (number) the x coordinate to test
y: (number) the y coordinate to test
onlyvisible: (bool) hit test only for visible sprite (clipping/masking) optional, default = false
ref: (Sprite) specifies which sprite is the reference of x,y coordinates. If nil global coordinates are assumed optional, default = nil, new Gideros 2023.2

Return values

Returns (bool) true if the given global coordinates are in bounds of the sprite, false otherwise

Example

Moves a pixel with the mouse

local pixel = Pixel.new(0xff0000, 1, 32, 32)
local x0, y0, focus
pixel:addEventListener(Event.MOUSE_DOWN, function(e)
	if pixel:hitTestPoint(e.x, e.y) then
		focus = true
		x0, y0 = e.x, e.y
		e:stopPropagation()
	end
end)
pixel:addEventListener(Event.MOUSE_MOVE, function(e)
	if focus then
		local dx = e.x - x0
		local dy = e.y - y0
		pixel:setX(self.camera:getX() + dx)
		pixel:setY(self.camera:getY() + dy)
		x0 = e.x
		y0 = e.y
		e:stopPropagation()
	end
end)
pixel:addEventListener(Event.MOUSE_UP, function(e)
	if focus then
		focus = false
		e:stopPropagation()
	end
end)