Class GridLayoutGroup

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

UIBehaviour

LayoutGroup

GridLayoutGroup

Implements

ILayoutElement

ILayoutGroup

ILayoutController

Inherited Members

LayoutGroup.m_Padding

LayoutGroup.padding

LayoutGroup.m_ChildAlignment

LayoutGroup.childAlignment

LayoutGroup.rectTransform

LayoutGroup.m_Tracker

LayoutGroup.rectChildren

LayoutGroup.minWidth

LayoutGroup.preferredWidth

LayoutGroup.flexibleWidth

LayoutGroup.minHeight

LayoutGroup.preferredHeight

LayoutGroup.flexibleHeight

LayoutGroup.layoutPriority

LayoutGroup.OnEnable()

LayoutGroup.OnDisable()

LayoutGroup.OnDidApplyAnimationProperties()

LayoutGroup.GetTotalMinSize(int)

LayoutGroup.GetTotalPreferredSize(int)

LayoutGroup.GetTotalFlexibleSize(int)

LayoutGroup.GetStartOffset(int, float)

LayoutGroup.GetAlignmentOnAxis(int)

LayoutGroup.SetLayoutInputForAxis(float, float, float, int)

LayoutGroup.SetChildAlongAxis(RectTransform, int, float)

LayoutGroup.SetChildAlongAxisWithScale(RectTransform, int, float, float)

LayoutGroup.SetChildAlongAxis(RectTransform, int, float, float)

LayoutGroup.SetChildAlongAxisWithScale(RectTransform, int, float, float, float)

LayoutGroup.OnRectTransformDimensionsChange()

LayoutGroup.OnTransformChildrenChanged()

LayoutGroup.SetProperty<T>(ref T, T)

LayoutGroup.SetDirty()

UIBehaviour.Awake()

UIBehaviour.Start()

UIBehaviour.OnDestroy()

UIBehaviour.IsActive()

UIBehaviour.Reset()

UIBehaviour.OnBeforeTransformParentChanged()

UIBehaviour.OnTransformParentChanged()

UIBehaviour.OnCanvasGroupChanged()

UIBehaviour.OnCanvasHierarchyChanged()

UIBehaviour.IsDestroyed()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.UI

Assembly: UnityEngine.UI.dll

Syntax

[AddComponentMenu("Layout/Grid Layout Group", 152)]
public class GridLayoutGroup : LayoutGroup, ILayoutElement, ILayoutGroup, ILayoutController

Constructors

GridLayoutGroup()

Declaration

protected GridLayoutGroup()

Fields

m_CellSize

Declaration

[SerializeField]
protected Vector2 m_CellSize

Field Value

Type	Description
Vector2

m_Constraint

Declaration

[SerializeField]
protected GridLayoutGroup.Constraint m_Constraint

Field Value

Type	Description
GridLayoutGroup.Constraint

m_ConstraintCount

Declaration

[SerializeField]
protected int m_ConstraintCount

Field Value

Type	Description
int

m_Spacing

Declaration

[SerializeField]
protected Vector2 m_Spacing

Field Value

Type	Description
Vector2

m_StartAxis

Declaration

[SerializeField]
protected GridLayoutGroup.Axis m_StartAxis

Field Value

Type	Description
GridLayoutGroup.Axis

m_StartCorner

Declaration

[SerializeField]
protected GridLayoutGroup.Corner m_StartCorner

Field Value

Type	Description
GridLayoutGroup.Corner

Properties

cellSize

The size to use for each cell in the grid.

Declaration

public Vector2 cellSize { get; set; }

Property Value

Type	Description
Vector2

constraint

Which constraint to use for the GridLayoutGroup.

Declaration

public GridLayoutGroup.Constraint constraint { get; set; }

Property Value

Type	Description
GridLayoutGroup.Constraint

Remarks

Specifying a constraint can make the GridLayoutGroup work better in conjunction with a [[ContentSizeFitter]] component. When GridLayoutGroup is used on a RectTransform with a manually specified size, there's no need to specify a constraint.

constraintCount

How many cells there should be along the constrained axis.

Declaration

public int constraintCount { get; set; }

Property Value

Type	Description
int

spacing

The spacing to use between layout elements in the grid on both axises.

Declaration

public Vector2 spacing { get; set; }

Property Value

Type	Description
Vector2

startAxis

Which axis should cells be placed along first

Declaration

public GridLayoutGroup.Axis startAxis { get; set; }

Property Value

Type	Description
GridLayoutGroup.Axis

Remarks

When startAxis is set to horizontal, an entire row will be filled out before proceeding to the next row. When set to vertical, an entire column will be filled out before proceeding to the next column.

startCorner

Which corner should the first cell be placed in?

Declaration

public GridLayoutGroup.Corner startCorner { get; set; }

Property Value

Type	Description
GridLayoutGroup.Corner

Methods

CalculateLayoutInputHorizontal()

Called by the layout system to calculate the horizontal layout size. Also see ILayoutElement

Declaration

public override void CalculateLayoutInputHorizontal()

Overrides

LayoutGroup.CalculateLayoutInputHorizontal()

CalculateLayoutInputVertical()

Called by the layout system to calculate the vertical layout size. Also see ILayoutElement

Declaration

public override void CalculateLayoutInputVertical()

Overrides

LayoutGroup.CalculateLayoutInputVertical()

OnValidate()

Declaration

protected override void OnValidate()

Overrides

LayoutGroup.OnValidate()

SetLayoutHorizontal()

Called by the layout system Also see ILayoutElement

Declaration

public override void SetLayoutHorizontal()

Overrides

LayoutGroup.SetLayoutHorizontal()

SetLayoutVertical()

Called by the layout system Also see ILayoutElement

Declaration

public override void SetLayoutVertical()

Overrides

LayoutGroup.SetLayoutVertical()

Implements

ILayoutElement

ILayoutGroup

ILayoutController