Class FlexalonGridLayout

Namespace

Flexalon

Assembly

Flexalon.dll

Use a grid layout to position children at fixed intervals. Objects are placed in cells in column-row-layer order.

public class FlexalonGridLayout : LayoutBase, Layout

Inheritance

object

FlexalonComponent

LayoutBase

FlexalonGridLayout

Implements

Layout

Inherited Members

LayoutBase.DoOnEnable()

LayoutBase.DoOnDisable()

LayoutBase.ResetProperties()

LayoutBase.Initialize()

LayoutBase.SetChildrenFillShrinkSize(FlexalonNode, Vector3, Vector3)

FlexalonComponent._node

FlexalonComponent.Node

FlexalonComponent.MarkDirty()

FlexalonComponent.ForceUpdate()

FlexalonComponent.UpdateProperties()

FlexalonComponent.DoUpdate()

FlexalonComponent.Upgrade(int)

Properties

CellType

The type of cell to use on the column-row axes.

public FlexalonGridLayout.CellTypes CellType { get; set; }

Property Value

FlexalonGridLayout.CellTypes

ColumnDirection

The direction of the column axis.

public Direction ColumnDirection { get; set; }

Property Value

Direction

Columns

The number of columns in the grid.

public uint Columns { get; set; }

Property Value

uint

ColumnSize

The fixed size of the columns.

public float ColumnSize { get; set; }

Property Value

float

ColumnSizeType

How to determine the size of the columns,

public FlexalonGridLayout.CellSizeTypes ColumnSizeType { get; set; }

Property Value

FlexalonGridLayout.CellSizeTypes

ColumnSpacing

The spacing between columns.

public float ColumnSpacing { get; set; }

Property Value

float

DepthAlign

How to align each child in its cell in depth.

public Align DepthAlign { get; set; }

Property Value

Align

HorizontalAlign

How to align each child in its cell horizontally.

public Align HorizontalAlign { get; set; }

Property Value

Align

LayerDirection

The direction of the layer axis.

public Direction LayerDirection { get; set; }

Property Value

Direction

Layers

The number of layers in the grid.

public uint Layers { get; set; }

Property Value

uint

LayerSizeSize

The fixed size of the layers.

public float LayerSizeSize { get; set; }

Property Value

float

LayerSizeType

How to determine the size of the layers.

public FlexalonGridLayout.CellSizeTypes LayerSizeType { get; set; }

Property Value

FlexalonGridLayout.CellSizeTypes

LayerSpacing

The spacing between layers.

public float LayerSpacing { get; set; }

Property Value

float

RowDirection

The direction of the row axis.

public Direction RowDirection { get; set; }

Property Value

Direction

Rows

The number of rows in the grid.

public uint Rows { get; set; }

Property Value

uint

RowSize

The fixed size of the rows.

public float RowSize { get; set; }

Property Value

float

RowSizeType

How to determine the size of the rows.

public FlexalonGridLayout.CellSizeTypes RowSizeType { get; set; }

Property Value

FlexalonGridLayout.CellSizeTypes

RowSpacing

The spacing between rows.

public float RowSpacing { get; set; }

Property Value

float

VerticalAlign

How to align each child in its cell vertically.

public Align VerticalAlign { get; set; }

Property Value

Align

Methods

Arrange(FlexalonNode, Vector3)

Position the children of node within the available bounds.

public override void Arrange(FlexalonNode node, Vector3 layoutSize)

Parameters

node FlexalonNode

layoutSize Vector3

GetChildAt(int, int, int)

Returns the first child in the cell.

public Transform GetChildAt(int column, int row, int layer = 0)

Parameters

column int

The column of the cell.

row int

The row of the cell.

layer int

The layer of the cell.

Returns

Transform

The first child in the cell.

GetChildrenAt(int, int, int)

Returns all children in the cell.

public Transform[] GetChildrenAt(int column, int row, int layer = 0)

Parameters

column int

The column of the cell.

row int

The row of the cell.

layer int

The layer of the cell.

Returns

Transform[]

A list of children in the cell.

Measure(FlexalonNode, Vector3, Vector3, Vector3)

Perform minimal work to determine what the size of node and available size for node's children.

public override Bounds Measure(FlexalonNode node, Vector3 size, Vector3 min, Vector3 max)

Parameters

node FlexalonNode

size Vector3

min Vector3

max Vector3

Returns

Bounds