Tanoda
UnityEngine.UI.Extensions.FlowLayoutGroup Class Reference

Layout Group controller that arranges children in bars, fitting as many on a line until total size exceeds parent bounds More...

Inheritance diagram for UnityEngine.UI.Extensions.FlowLayoutGroup:

Public Types

enum  Axis { Horizontal = 0 , Vertical = 1 }
 

Public Member Functions

override void CalculateLayoutInputHorizontal ()
 
override void SetLayoutHorizontal ()
 
override void SetLayoutVertical ()
 
override void CalculateLayoutInputVertical ()
 
float SetLayout (int axis, bool layoutInput)
 Main layout method More...
 
float GetGreatestMinimumChildWidth ()
 
float GetGreatestMinimumChildHeigth ()
 

Public Attributes

float SpacingX = 0f
 
float SpacingY = 0f
 
bool ExpandHorizontalSpacing = false
 
bool ChildForceExpandWidth = false
 
bool ChildForceExpandHeight = false
 
bool invertOrder = false
 

Protected Member Functions

void LayoutRow (IList< RectTransform > contents, float rowWidth, float rowHeight, float maxWidth, float xOffset, float yOffset, int axis)
 
void LayoutCol (IList< RectTransform > contents, float colWidth, float colHeight, float maxHeight, float xOffset, float yOffset, int axis)
 

Protected Attributes

Axis m_StartAxis = Axis.Horizontal
 

Properties

Axis startAxis [get, set]
 
bool IsCenterAlign [get]
 
bool IsRightAlign [get]
 
bool IsMiddleAlign [get]
 
bool IsLowerAlign [get]
 

Detailed Description

Layout Group controller that arranges children in bars, fitting as many on a line until total size exceeds parent bounds

Definition at line 16 of file FlowLayoutGroup.cs.

Member Enumeration Documentation

◆ Axis

Enumerator
Horizontal 
Vertical 

Definition at line 18 of file FlowLayoutGroup.cs.

Member Function Documentation

◆ CalculateLayoutInputHorizontal()

override void UnityEngine.UI.Extensions.FlowLayoutGroup.CalculateLayoutInputHorizontal ( )

Definition at line 33 of file FlowLayoutGroup.cs.

◆ CalculateLayoutInputVertical()

override void UnityEngine.UI.Extensions.FlowLayoutGroup.CalculateLayoutInputVertical ( )

Definition at line 55 of file FlowLayoutGroup.cs.

◆ GetGreatestMinimumChildHeigth()

float UnityEngine.UI.Extensions.FlowLayoutGroup.GetGreatestMinimumChildHeigth ( )

Definition at line 417 of file FlowLayoutGroup.cs.

◆ GetGreatestMinimumChildWidth()

float UnityEngine.UI.Extensions.FlowLayoutGroup.GetGreatestMinimumChildWidth ( )

Definition at line 406 of file FlowLayoutGroup.cs.

◆ LayoutCol()

void UnityEngine.UI.Extensions.FlowLayoutGroup.LayoutCol ( IList< RectTransform >  contents,
float  colWidth,
float  colHeight,
float  maxHeight,
float  xOffset,
float  yOffset,
int  axis 
)
protected

Definition at line 338 of file FlowLayoutGroup.cs.

◆ LayoutRow()

void UnityEngine.UI.Extensions.FlowLayoutGroup.LayoutRow ( IList< RectTransform >  contents,
float  rowWidth,
float  rowHeight,
float  maxWidth,
float  xOffset,
float  yOffset,
int  axis 
)
protected

Definition at line 272 of file FlowLayoutGroup.cs.

◆ SetLayout()

float UnityEngine.UI.Extensions.FlowLayoutGroup.SetLayout ( int  axis,
bool  layoutInput 
)

Main layout method

Parameters
widthWidth to calculate the layout with
axis0 for horizontal axis, 1 for vertical
layoutInputIf true, sets the layout input for the axis. If false, sets child position for axis

Definition at line 113 of file FlowLayoutGroup.cs.

◆ SetLayoutHorizontal()

override void UnityEngine.UI.Extensions.FlowLayoutGroup.SetLayoutHorizontal ( )

Definition at line 45 of file FlowLayoutGroup.cs.

◆ SetLayoutVertical()

override void UnityEngine.UI.Extensions.FlowLayoutGroup.SetLayoutVertical ( )

Definition at line 50 of file FlowLayoutGroup.cs.

Member Data Documentation

◆ ChildForceExpandHeight

bool UnityEngine.UI.Extensions.FlowLayoutGroup.ChildForceExpandHeight = false

Definition at line 25 of file FlowLayoutGroup.cs.

◆ ChildForceExpandWidth

bool UnityEngine.UI.Extensions.FlowLayoutGroup.ChildForceExpandWidth = false

Definition at line 24 of file FlowLayoutGroup.cs.

◆ ExpandHorizontalSpacing

bool UnityEngine.UI.Extensions.FlowLayoutGroup.ExpandHorizontalSpacing = false

Definition at line 22 of file FlowLayoutGroup.cs.

◆ invertOrder

bool UnityEngine.UI.Extensions.FlowLayoutGroup.invertOrder = false

Definition at line 26 of file FlowLayoutGroup.cs.

◆ m_StartAxis

Axis UnityEngine.UI.Extensions.FlowLayoutGroup.m_StartAxis = Axis.Horizontal
protected

Definition at line 30 of file FlowLayoutGroup.cs.

◆ SpacingX

float UnityEngine.UI.Extensions.FlowLayoutGroup.SpacingX = 0f

Definition at line 20 of file FlowLayoutGroup.cs.

◆ SpacingY

float UnityEngine.UI.Extensions.FlowLayoutGroup.SpacingY = 0f

Definition at line 21 of file FlowLayoutGroup.cs.

Property Documentation

◆ IsCenterAlign

bool UnityEngine.UI.Extensions.FlowLayoutGroup.IsCenterAlign
getprotected

Definition at line 66 of file FlowLayoutGroup.cs.

◆ IsLowerAlign

bool UnityEngine.UI.Extensions.FlowLayoutGroup.IsLowerAlign
getprotected

Definition at line 93 of file FlowLayoutGroup.cs.

◆ IsMiddleAlign

bool UnityEngine.UI.Extensions.FlowLayoutGroup.IsMiddleAlign
getprotected

Definition at line 84 of file FlowLayoutGroup.cs.

◆ IsRightAlign

bool UnityEngine.UI.Extensions.FlowLayoutGroup.IsRightAlign
getprotected

Definition at line 75 of file FlowLayoutGroup.cs.

◆ startAxis

Axis UnityEngine.UI.Extensions.FlowLayoutGroup.startAxis
getset

Definition at line 31 of file FlowLayoutGroup.cs.


The documentation for this class was generated from the following file: