Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#

ILayoutController

interface in UnityEngine.UI

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Base interface to implement by componets that control the layout of RectTransforms.

If a component is driving its own RectTransform it should implement the interface ILayoutSelfController. If a component is driving the RectTransforms of its children, it should implement ILayoutGroup.

The layout system will first invoke SetLayoutHorizontal and then SetLayoutVertical.

In the SetLayoutHorizontal call it is valid to call LayoutUtility.GetMinWidth, LayoutUtility.GetPreferredWidth, and LayoutUtility.GetFlexibleWidth on the RectTransform of itself or any of its children. In the SetLayoutVertical call it is valid to call LayoutUtility.GetMinHeight, LayoutUtility.GetPreferredHeight, and LayoutUtility.GetFlexibleHeight on the RectTransform of itself or any of its children.

The component may use this information to determine the width and height to use for its own RectTransform or the RectTransforms of its children.

Public Methods

SetLayoutHorizontalCallback invoked by the auto layout system which handles horizontal aspects of the layout.
SetLayoutVerticalCallback invoked by the auto layout system which handles vertical aspects of the layout.

Did you find this page useful? Please give it a rating: