Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

FlipLayoutOnAxis(RectTransform, int, bool, bool)

Flips the alignment of the RectTransform along the horizontal or vertical axis, and optionally its children as well.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.UIModule
public static void FlipLayoutOnAxis(RectTransform rect, int axis, bool keepPositioning, bool recursive)

Parameters

rect

RectTransform
The RectTransform to flip.

axis

int
The axis to flip along. 0 is horizontal and 1 is vertical.

keepPositioning

bool
Flips around the pivot if true. Flips within the parent rect if false.

recursive

bool
Flip the children as well?

Remarks

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.