Difference between revisions of "Sprite:setLayoutParameters"

From GiderosMobile
m (formatting)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
  
<languages />
+
'''<translate>Available since</translate>:''' Gideros 2018.9<br/>
 +
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
  
'''<translate>Available since</translate>:''' Gideros 2018.9
+
=== Description ===
<br/>
 
 
 
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]
 
<br/>
 
 
 
=== <translate>Description</translate> ===
 
<translate>
 
 
Gideros Layout arranges a sprite's children into cells of a grid. With this method, you tell the parent's sprite how the rows and columns of the layout grid should be sized.
 
Gideros Layout arranges a sprite's children into cells of a grid. With this method, you tell the parent's sprite how the rows and columns of the layout grid should be sized.
<br/>
 
  
 
If there is extra space available after applying minimum widths and heights, it is distributed according to relative weights of each row/column.
 
If there is extra space available after applying minimum widths and heights, it is distributed according to relative weights of each row/column.
<br/>
 
  
 
Gideros layout system is heavily based on Java GridBagLayout principle. See here for more explanation:
 
Gideros layout system is heavily based on Java GridBagLayout principle. See here for more explanation:
 
https://www.math.uni-hamburg.de/doc/java/tutorial/uiswing/layout/gridbag.html
 
https://www.math.uni-hamburg.de/doc/java/tutorial/uiswing/layout/gridbag.html
<br/>
 
  
 
The following parameters apply:
 
The following parameters apply:
Line 35: Line 26:
 
* '''cellSpacingX''': horizontal margin between cells. '''since 2020.7'''
 
* '''cellSpacingX''': horizontal margin between cells. '''since 2020.7'''
 
* '''cellSpacingY''': vertical margin between cells. '''since 2020.7'''
 
* '''cellSpacingY''': vertical margin between cells. '''since 2020.7'''
 
<br/>
 
  
 
Specifying a '''nil''' table will clear layout parameters.
 
Specifying a '''nil''' table will clear layout parameters.
</translate>
 
  
 
<source lang="lua">
 
<source lang="lua">
Line 45: Line 33:
 
</source>
 
</source>
  
=== <translate>Parameters</translate> ===
+
=== Parameters ===
 
'''layout''': (table) <translate>Table of layout parameters.</translate>
 
'''layout''': (table) <translate>Table of layout parameters.</translate>
<br/>
 
  
=== <translate>Examples</translate> ===
+
=== Examples ===
 
'''Example 1''': center an image inside another image
 
'''Example 1''': center an image inside another image
<br/>
 
 
 
<source lang="lua">
 
<source lang="lua">
 
-- LAYOUT CONSTRAINTS 01 @hgy29
 
-- LAYOUT CONSTRAINTS 01 @hgy29
Line 65: Line 50:
 
stage:addChild(ticket)
 
stage:addChild(ticket)
 
</source>
 
</source>
<br/>
 
  
 
'''Example 2''': pixels
 
'''Example 2''': pixels
<br/>
 
 
 
<gallery widths=136px heights=240px>
 
<gallery widths=136px heights=240px>
 
Layout parameters example.png
 
Layout parameters example.png
 
</gallery>
 
</gallery>
<br/>
 
 
 
<source lang="lua">
 
<source lang="lua">
 
-- LAYOUT CONSTRAINTS 02 @Nanocore
 
-- LAYOUT CONSTRAINTS 02 @Nanocore
Line 122: Line 102:
 
stage:addChild(myholder)
 
stage:addChild(myholder)
 
</source>
 
</source>
<br/>
 
  
 
{{Sprite}}
 
{{Sprite}}

Revision as of 00:08, 20 August 2020


Available since: Gideros 2018.9
Class: Sprite

Description

Gideros Layout arranges a sprite's children into cells of a grid. With this method, you tell the parent's sprite how the rows and columns of the layout grid should be sized.

If there is extra space available after applying minimum widths and heights, it is distributed according to relative weights of each row/column.

Gideros layout system is heavily based on Java GridBagLayout principle. See here for more explanation: https://www.math.uni-hamburg.de/doc/java/tutorial/uiswing/layout/gridbag.html

The following parameters apply:

  • columnWidths: an array of minimum width for each column
  • rowHeights: an array of minimum height for each row
  • columnWeights: an array of relative weights for each column
  • rowWeights: an array of relative weights for each row
  • insetTop: the top margin
  • insetLeft: the left margin
  • insetBottom: the bottom margin
  • insetRight: the right margin
  • insets: sets the above four margins to the same value at once. since 2020.7
  • equalizeCells: distribute extra spaces so that cells have a size proportional to their weights. since 2020.7
  • resizeContainer: allow the parent sprite to be resized if children content is too large. since 2020.5
  • cellSpacingX: horizontal margin between cells. since 2020.7
  • cellSpacingY: vertical margin between cells. since 2020.7

Specifying a nil table will clear layout parameters.

Sprite:setLayoutParameters(layout)

Parameters

layout: (table) Table of layout parameters.

Examples

Example 1: center an image inside another image

-- LAYOUT CONSTRAINTS 01 @hgy29
local ticket = Bitmap.new(Texture.new("gfx/vip/ticket.png"))
local text = Bitmap.new(Texture.new("gfx/vip/text.png"))
 
-- Use auto layout on ticket to center text automatically
ticket:setLayoutParameters{ rowWeights = {1}, columnWeights = {1} }
text:setLayoutConstraints{}

ticket:addChild(text)
stage:addChild(ticket)

Example 2: pixels

-- LAYOUT CONSTRAINTS 02 @Nanocore
-- BUTTONS HOLDER
local myholder = Pixel.new(0x0, 0.5, 256, 256)
myholder:setPosition(8, 8)
myholder:setLayoutParameters({
	columnWeights = {1, 1, 1}, -- 3 columns
	rowWeights = {1, 1, 1, 1}, -- 4 rows
	columnWidths = {32, 32, 32}, -- min columns width
	rowHeights = {32, 32, 32, 32}, -- min rows width
})

-- BUTTONS
local mybtn1 = Pixel.new(0xff0000, 1, 32, 32)
mybtn1:setLayoutConstraints({
	gridx = 0,
	gridy = 0,
	gridwidth = 2,
	gridheight = 2,
	anchor = Sprite.LAYOUT_ANCHOR_NORTHWEST,
	fill = Sprite.LAYOUT_FILL_BOTH,
})
myholder:addChild(mybtn1)

local mybtn2 = Pixel.new(0x00ff00, 1, 32, 32)
mybtn2:setLayoutConstraints({
	gridx = 1,
	gridy = 2,
	gridwidth = 1,
	anchor = Sprite.LAYOUT_ANCHOR_NORTHWEST,
	fill = Sprite.LAYOUT_FILL_VERTICAL,
})
myholder:addChild(mybtn2)

local mybtn3 = Pixel.new(0x0000ff, 1, 32, 32)
mybtn3:setLayoutConstraints({
	gridx = 2,
	gridy = 3,
	gridwidth = 1,
	anchor = Sprite.LAYOUT_ANCHOR_NORTHWEST,
	fill = Sprite.LAYOUT_FILL_BOTH,
})
myholder:addChild(mybtn3)

-- ADD TO STAGE
stage:addChild(myholder)