API Reference

Class List

pc.LayoutGroupComponent

Extends: pc.Component

A LayoutGroupComponent enables the Entity to position and scale child pc.ElementComponents according to configurable layout rules.

Summary

Properties

alignmentSpecifies the horizontal and vertical alignment of child elements.
heightFittingIdentical to pc.LayoutGroupComponent#widthFitting but for the Y axis.
orientationWhether the layout should run horizontally or vertically.
paddingPadding to be applied inside the container before positioning any children.
reverseXReverses the order of children along the x axis.
reverseYReverses the order of children along the y axis.
spacingSpacing to be applied between each child element.
widthFittingFitting logic to be applied when positioning and scaling child elements.
wrapWhether or not to wrap children onto a new row/column when the size of the container is exceeded.

Inherited

Properties

enabledEnables or disables the component.

Details

Constructor

LayoutGroupComponent(system, entity)

Create a new LayoutGroupComponent

Parameters

systempc.LayoutGroupComponentSystemThe ComponentSystem that created this Component
entitypc.EntityThe Entity that this Component is attached to.

Properties

pc.Vec2alignment

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.

pc.FITTINGheightFitting

Identical to pc.LayoutGroupComponent#widthFitting but for the Y axis.

pc.ORIENTATIONorientation

Whether the layout should run horizontally or vertically.

pc.Vec4padding

Padding to be applied inside the container before positioning any children. Specified as left, bottom, right and top values.

BooleanreverseX

Reverses the order of children along the x axis.

BooleanreverseY

Reverses the order of children along the y axis.

pc.Vec2spacing

Spacing to be applied between each child element.

pc.FITTINGwidthFitting

Fitting logic to be applied when positioning and scaling child elements. Can be one of the following:

  • pc.FITTING_NONE: Child elements will be rendered at their natural size.
  • pc.FITTING_STRETCH: When the natural size of all child elements does not fill the width of the container, children will be stretched to fit. The rules for how each child will be stretched are outlined below:
    1. Sum the pc.LayoutChildComponent#fitWidthProportion values of each child and normalize so that all values sum to 1.
    2. Apply the natural width of each child.
    3. If there is space remaining in the container, distribute it to each child based on the normalized pc.LayoutChildComponent#fitWidthProportion values, but do not exceed the pc.LayoutChildComponent#maxWidth of each child.
  • pc.FITTING_SHRINK: When the natural size of all child elements overflows the width of the container, children will be shrunk to fit. The rules for how each child will be stretched are outlined below:
    1. Sum the pc.LayoutChildComponent#fitWidthProportion values of each child and normalize so that all values sum to 1.
    2. Apply the natural width of each child.
    3. If the new total width of all children exceeds the available space of the container, reduce each child's width proportionally based on the normalized pc.LayoutChildComponent#fitWidthProportion values, but do not exceed the pc.LayoutChildComponent#minWidth of each child.
  • pc.FITTING_BOTH: Applies both STRETCH and SHRINK logic as necessary.

Booleanwrap

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.

Inherited

Properties

Booleanenabled

Enables or disables the component.