Difference between revisions of "Sprite:getLayoutInfo"
From GiderosMobile
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2018.9<br/> | |
| − | ''' | + | '''Class:''' [[Sprite]]<br/> |
| − | ''' | + | |
| − | === | + | === Description === |
| − | |||
| − | |||
Returns computed placement value according to Gideros layout system. | Returns computed placement value according to Gideros layout system. | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | (table) = Sprite:getLayoutInfo() | ||
| + | </syntaxhighlight> | ||
| + | |||
The returned table can contain the following fields: | The returned table can contain the following fields: | ||
| − | * '''startx''': | + | * '''startx''' (number): the 0-based index of the column the child was placed into |
| − | * '''starty''': | + | * '''starty''' (number): the 0-based index of the row the child was placed into |
| − | * '''width''': | + | * '''width''' (number): the width of the child (number of columns) |
| − | * '''height''': | + | * '''height''' (number): the height of the child (number of rows) |
| − | * ''' | + | * '''weightX''' (table): the horizontal weight of the child |
| − | * ''' | + | * '''weightY''' (table): the vertical weight of the child |
| − | * '''minWidth''': | + | * '''minWidth''' (table): minimum width |
| − | * '''minHeight''': | + | * '''minHeight''' (table): minimum height |
| − | + | ||
| − | ( | + | * '''reqWidth''' (number): total grid width in pixels |
| − | + | * '''reqHeight''' (number): total grid height in pixels | |
| − | === | + | * '''cellSpacingX''' (number): cell spacing x |
| − | ''' | + | * '''cellSpacingY''' (number): cell spacing y |
| + | |||
| + | === Return values === | ||
| + | '''Returns''' (table) table of layout information<br/> | ||
| + | |||
| + | === Example === | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | local lp3 = myholder:getLayoutInfo() | ||
| + | for k, v in pairs(lp3) do | ||
| + | print(k, v) | ||
| + | end | ||
| + | print(lp3.width) | ||
| + | </syntaxhighlight> | ||
{{Sprite}} | {{Sprite}} | ||
Latest revision as of 16:25, 20 October 2025
Available since: Gideros 2018.9
Class: Sprite
Description
Returns computed placement value according to Gideros layout system.
(table) = Sprite:getLayoutInfo()
The returned table can contain the following fields:
- startx (number): the 0-based index of the column the child was placed into
- starty (number): the 0-based index of the row the child was placed into
- width (number): the width of the child (number of columns)
- height (number): the height of the child (number of rows)
- weightX (table): the horizontal weight of the child
- weightY (table): the vertical weight of the child
- minWidth (table): minimum width
- minHeight (table): minimum height
- reqWidth (number): total grid width in pixels
- reqHeight (number): total grid height in pixels
- cellSpacingX (number): cell spacing x
- cellSpacingY (number): cell spacing y
Return values
Returns (table) table of layout information
Example
local lp3 = myholder:getLayoutInfo()
for k, v in pairs(lp3) do
print(k, v)
end
print(lp3.width)
- Sprite:addChild
- Sprite:addChildAt
- Sprite:addChildrenAt
- 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:isOnStage
- Sprite:isVisible
- Sprite:localToGlobal
- Sprite:redrawEffects
- Sprite:removeChild
- Sprite:removeChildAt
- Sprite:removeFromParent
- Sprite:resolveStyle
- Sprite:set
- Sprite:setAlpha
- Sprite:setAnchorPoint
- Sprite:setAnchorPosition
- Sprite:setBlendMode
- Sprite:setClip
- Sprite:setColorTransform
- Sprite:setEffectConstant
- Sprite:setEffectStack
- Sprite:setGhosts
- Sprite:setHiddenChildren
- 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:setStyle
- Sprite:setVisible
- Sprite:setWorldAlign
- Sprite:setX
- Sprite:setY
- Sprite:setZ
- Sprite:spriteToLocal
- Sprite:spriteToLocalMatrix
- Sprite:swapChildren
- Sprite:swapChildrenAt
- Sprite:updateStyle
- 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
