Difference between revisions of "Sprite:getBounds"
From GiderosMobile
m (fixed typo in comment) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2011.6<br/> | |
| − | ''' | + | '''Class:''' [[Sprite]]<br/> |
| − | ''' | + | |
| − | === | + | === Description === |
| − | + | Returns a rectangle (as x, y, width and height) that encloses the sprite as it appears in another sprite coordinate system. | |
| − | Returns a rectangle (as x, y, width and height) that encloses the sprite as it appears in another sprite | + | <syntaxhighlight lang="lua"> |
| − | + | (number), (number), (number), (number) = Sprite:getBounds(targetSprite,constrain) | |
| − | < | + | </syntaxhighlight> |
| − | (number), (number), (number), (number) = Sprite:getBounds(targetSprite) | + | |
| − | </ | + | === Parameters === |
| − | === | + | '''targetSprite''': (Sprite) the sprite that defines the other coordinate system to transform<br/> |
| − | '''targetSprite''': (Sprite) | + | '''constrain''': (bool) constrains the bounds to the base sprite layout '''default = false'''<br/> |
| − | === | + | |
| − | ''' | + | === Return values === |
| − | ''' | + | '''Returns''' (number) x coordinate<br/> |
| − | ''' | + | '''Returns''' (number) y coordinate<br/> |
| − | ''' | + | '''Returns''' (number) width of Sprite<br/> |
| − | === | + | '''Returns''' (number) height of Sprite<br/> |
| − | + | ||
| − | + | === Examples === | |
| − | local x, y, width, height = sprite:getBounds(stage) -- returns bounds as transformed to the stage coordinate system</ | + | <syntaxhighlight lang="lua"> |
| + | 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 | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | {{Sprite}} | ||
Latest revision as of 04:01, 18 November 2023
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
- Sprite:addChild
- Sprite:addChildAt
- Sprite:clearBlendMode
- Sprite:clone
- Sprite:contains
- Sprite:get
- Sprite:getAlpha
- Sprite:getAnchorPoint
- Sprite:getAnchorPosition
- Sprite:getBounds
- Sprite:getChildAt
- Sprite:getChildIndex
- Sprite:getChildrenAtPoint
- Sprite:getClip
- Sprite:getColorTransform
- Sprite:getDrawCount
- Sprite:getHeight
- Sprite:getLayoutConstraints
- Sprite:getLayoutInfo
- Sprite:getLayoutParameters
- Sprite:getMatrix
- Sprite:getNumChildren
- Sprite:getParent
- Sprite:getPosition
- Sprite:getRotation
- Sprite:getRotationX
- Sprite:getRotationY
- Sprite:getScale
- Sprite:getScaleX
- Sprite:getScaleY
- Sprite:getScaleZ
- Sprite:getSize
- Sprite:getSkew
- Sprite:getSkewX
- Sprite:getSkewY
- Sprite:getWidth
- Sprite:getX
- Sprite:getY
- Sprite:getZ
- Sprite:globalToLocal
- Sprite:hitTestPoint
- Sprite:isVisible
- Sprite:localToGlobal
- Sprite:redrawEffects
- Sprite:removeChild
- Sprite:removeChildAt
- Sprite:removeFromParent
- Sprite:set
- Sprite:setAlpha
- Sprite:setAnchorPoint
- Sprite:setAnchorPosition
- Sprite:setBlendMode
- Sprite:setClip
- Sprite:setColorTransform
- Sprite:setEffectConstant
- Sprite:setEffectStack
- Sprite:setGhosts
- Sprite:setLayoutConstraints
- Sprite:setLayoutParameters
- Sprite:setMatrix
- Sprite:setPosition
- Sprite:setRotation
- Sprite:setRotationX
- Sprite:setRotationY
- Sprite:setScale
- Sprite:setScaleX
- Sprite:setScaleY
- Sprite:setScaleZ
- Sprite:setShader
- Sprite:setShaderConstant
- Sprite:setSkew
- Sprite:setSkewX
- Sprite:setSkewY
- Sprite:setStencilOperation
- Sprite:setStopEventPropagation
- Sprite:setVisible
- Sprite:setX
- Sprite:setY
- Sprite:setZ
- Sprite:spriteToLocal
- Sprite:swapChildren
- Sprite:swapChildrenAt
- Sprite.ADD
- Sprite.ALPHA
- Sprite.EFFECT MODE AUTOMATIC
- Sprite.EFFECT MODE CONTINUOUS
- Sprite.EFFECT MODE TRIGGERED
- Sprite.LAYOUT ANCHOR CENTER
- Sprite.LAYOUT ANCHOR EAST
- Sprite.LAYOUT ANCHOR NORTH
- Sprite.LAYOUT ANCHOR NORTHEAST
- Sprite.LAYOUT ANCHOR NORTHWEST
- Sprite.LAYOUT ANCHOR SOUTH
- Sprite.LAYOUT ANCHOR SOUTHEAST
- Sprite.LAYOUT ANCHOR SOUTHWEST
- Sprite.LAYOUT ANCHOR WEST
- Sprite.LAYOUT FILL BOTH
- Sprite.LAYOUT FILL HORIZONTAL
- Sprite.LAYOUT FILL NONE
- Sprite.LAYOUT FILL VERTICAL
- Sprite.MULTIPLY
- Sprite.NO ALPHA
- Sprite.SCREEN
- Sprite.new
- Event.ADDED_TO_STAGE
- Event.ENTER_FRAME
- Event.KEY_CHAR
- Event.KEY_DOWN
- Event.KEY_UP
- Event.LAYOUT_RESIZED
- Event.MOUSE_DOWN
- Event.MOUSE_ENTER
- Event.MOUSE_HOVER
- Event.MOUSE_LEAVE
- Event.MOUSE_MOVE
- Event.MOUSE_UP
- Event.MOUSE_WHEEL
- Event.REMOVED_FROM_STAGE
- Event.TOUCHES_BEGIN
- Event.TOUCHES_CANCEL
- Event.TOUCHES_END
- Event.TOUCHES_MOVE
