Sprite:getBounds: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
Line 8: Line 8:
(number), (number), (number), (number) = Sprite:getBounds(targetSprite)
(number), (number), (number), (number) = Sprite:getBounds(targetSprite)
</source>
</source>
'''targetSprite''': (Sprite) the sprite that defines the other coordinate system to transform ''''''<br/>
=== Parameters ===
'''targetSprite''': (Sprite) the sprite that defines the other coordinate system to transform <br/>
=== Return values ===
'''Returns''' (number) x coordinate<br/>
'''Returns''' (number) x coordinate<br/>
'''Returns''' (number) y coordinate<br/>
'''Returns''' (number) y coordinate<br/>
'''Returns''' (number) width of Sprite<br/>
'''Returns''' (number) width of Sprite<br/>
'''Returns''' (number) height of Sprite<br/>
'''Returns''' (number) height of Sprite<br/>
=== Examples ===
'''Example'''<br/>
<source lang="lua">local x, y, width, height = sprite:getBounds(sprite) -- returns local (untransformed) bounds<br />
local x, y, width, height = sprite:getBounds(stage) -- returns bounds as transformed to stage&#039;s coordinate system<br /></source>

Revision as of 09:46, 23 August 2018

Available since: Gideros 2011.6

Description


Returns a rectangle (as x, y, width and height) that encloses the sprite as it appears in another sprite's coordinate system.

(number), (number), (number), (number) = Sprite:getBounds(targetSprite)

Parameters

targetSprite: (Sprite) the sprite that defines the other coordinate system to transform

Return values

Returns (number) x coordinate
Returns (number) y coordinate
Returns (number) width of Sprite
Returns (number) height of Sprite

Examples

Example

local x, y, width, height = sprite:getBounds(sprite) -- returns local (untransformed) bounds<br />
local x, y, width, height = sprite:getBounds(stage) -- returns bounds as transformed to stage&#039;s coordinate system<br />