Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

RectTransformUtility.FlipLayoutOnAxis

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

Sumbission failed

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

Close

Cancel

public static function FlipLayoutOnAxis(rect: RectTransform, axis: int, keepPositioning: bool, recursive: bool): void;
public static void FlipLayoutOnAxis(RectTransform rect, int axis, bool keepPositioning, bool recursive);

Parameters

rect The RectTransform to flip.
keepPositioning Flips around the pivot if true. Flips within the parent rect if false.
recursive Flip the children as well?
axis The axis to flip along. 0 is horizontal and 1 is vertical.

Description

Flips the alignment of the RectTransform along the horizontal or vertical axis, and optionally its children as well.

This flips the alignment of the RectTransform. Any actual content such as images or text will not be flipped but may aligned differently. An example usage is to instantiate a control designed in a left to right manner (like a horizontal slider where 0 is to the left) and flip it horizontally so the layout becomes suitable for use in the opposite direction (like a horizontal slider where 0 is to the right).

When used with the recursive argument set to true, the children are always flipped with the keepPositioning option set to false so that they properly follow the flip of the parent.