API Reference

Class List

pc.LayoutChildComponent

Extends: pc.Component

A LayoutChildComponent enables the Entity to control the sizing applied to it by its parent pc.LayoutGroupComponent.

Summary

Properties

excludeFromLayoutIf set to true, the child will be excluded from all layout calculations.
fitHeightProportionThe amount of additional vertical space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation.
fitWidthProportionThe amount of additional horizontal space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation.
maxHeightThe maximum height the element should be rendered at.
maxWidthThe maximum width the element should be rendered at.
minHeightThe minimum height the element should be rendered at.
minWidthThe minimum width the element should be rendered at.

Inherited

Properties

enabledEnables or disables the component.

Details

Constructor

LayoutChildComponent(system, entity)

Create a new LayoutChildComponent

Parameters

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

Properties

NumberexcludeFromLayout

If set to true, the child will be excluded from all layout calculations.

NumberfitHeightProportion

The amount of additional vertical space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation. This is specified as a proportion, taking into account the proportion values of other siblings.

NumberfitWidthProportion

The amount of additional horizontal space that the element should take up, if necessary to satisfy a Stretch/Shrink fitting calculation. This is specified as a proportion, taking into account the proportion values of other siblings.

NumbermaxHeight

The maximum height the element should be rendered at.

NumbermaxWidth

The maximum width the element should be rendered at.

NumberminHeight

The minimum height the element should be rendered at.

NumberminWidth

The minimum width the element should be rendered at.

Inherited

Properties

Booleanenabled

Enables or disables the component.