Sprite:getBounds

From GiderosMobile
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Available since: Gideros 2011.6
Class: Sprite

Description

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

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

Parameters

targetSprite: (Sprite) the sprite that defines the other coordinate system to transform
constrain: (bool) constrains the bounds to the base sprite layout default = false

Return values

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

Examples

local x, y, width, height = sprite:getBounds(sprite) -- returns local (untransformed) bounds
local x, y, width, height = sprite:getBounds(stage) -- returns bounds as transformed to the stage coordinate system