Constructor
new LayoutGroupComponent(system, entity)
Create a new LayoutGroupComponent
Parameters:
Name | Type | Description |
---|---|---|
system |
pc.LayoutGroupComponentSystem | The ComponentSystem that created this Component |
entity |
pc.Entity | The Entity that this Component is attached to. |
Properties:
Name | Type | Description |
---|---|---|
orientation |
pc.ORIENTATION | Whether the layout should run horizontally or vertically. |
reverseX |
Boolean | Reverses the order of children along the x axis. |
reverseY |
Boolean | Reverses the order of children along the y axis. |
alignment |
pc.Vec2 | Specifies the horizontal and vertical alignment of child elements. Values range from 0 to 1 where [0,0] is the bottom left and [1,1] is the top right. |
padding |
pc.Vec4 | Padding to be applied inside the container before positioning any children. Specified as left, bottom, right and top values. |
spacing |
pc.Vec2 | Spacing to be applied between each child element. |
widthFitting |
pc.FITTING | Fitting logic to be applied when positioning and scaling child elements. Can be one of the following:
|
heightFitting |
pc.FITTING | Identical to pc.LayoutGroupComponent#widthFitting but for the Y axis. |
wrap |
Boolean | Whether or not to wrap children onto a new row/column when the size of the container is exceeded. Defaults to false, which means that children will be be rendered in a single row (horizontal orientation) or column (vertical orientation). Note that setting wrap to true makes it impossible for the pc.FITTING_BOTH fitting mode to operate in any logical manner. For this reason, when wrap is true, a pc.LayoutGroupComponent#widthFitting or pc.LayoutGroupComponent#heightFitting mode of pc.FITTING_BOTH will be coerced to pc.FITTING_STRETCH. |