Class RectTransformExtensions

Inheritance

RectTransformExtensions

Namespace: GGL.Extensions

Assembly: GGL.dll

Syntax

public static class RectTransformExtensions

Methods

| Edit this page View Source

ConvertLocalPointToPosition(RectTransform, Vector3)

Extracts from a local point in a UnityEngine.RectTransform's rect its local position in the parent.

Declaration

public static Vector2 ConvertLocalPointToPosition(this RectTransform rectTransform, Vector3 localPoint)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector3	localPoint

Returns

Type	Description
Vector2

| Edit this page View Source

ConvertPositionToLocalPoint(RectTransform, Vector3)

Extracts from a local position its local point in a UnityEngine.RectTransform's rect.

Declaration

public static Vector2 ConvertPositionToLocalPoint(this RectTransform rectTransform, Vector3 worldPoint)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector3	worldPoint

Returns

Type	Description
Vector2

| Edit this page View Source

GetCanvasCamera(RectTransform)

Returns the camera of the root canvas where belongs the UnityEngine.RectTransform.

Declaration

public static Camera GetCanvasCamera(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

Returns

Type	Description
Camera

| Edit this page View Source

GetHeight(RectTransform)

Return the height of a UnityEngine.RectTransform's rect.

Declaration

public static float GetHeight(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

Returns

Type	Description
float

| Edit this page View Source

GetRootCanvas(RectTransform)

Returns the root canvas of a UnityEngine.RectTransform.

Declaration

public static Canvas GetRootCanvas(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

Returns

Type	Description
Canvas

| Edit this page View Source

GetSize(RectTransform)

Return the size of a UnityEngine.RectTransform's rect.

Declaration

public static Vector2 GetSize(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

Returns

Type	Description
Vector2	UnityEngine.Vector2 representing (width, height)

| Edit this page View Source

GetWidth(RectTransform)

Return the width of a UnityEngine.RectTransform's rect.

Declaration

public static float GetWidth(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

Returns

Type	Description
float

| Edit this page View Source

Reset(RectTransform)

Reset a UnityEngine.RectTransform (scale + position + anchors + offsets)

Declaration

public static void Reset(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

| Edit this page View Source

ResetAnchors(RectTransform)

Reset the anchors of a UnityEngine.RectTransform

Declaration

public static void ResetAnchors(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

| Edit this page View Source

ResetRect(RectTransform)

Reset the offsets of a UnityEngine.RectTransform

Declaration

public static void ResetRect(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

| Edit this page View Source

ResetScale(RectTransform)

Reset the scale of a UnityEngine.RectTransform

Declaration

public static void ResetScale(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

| Edit this page View Source

ResetTransform(RectTransform)

Reset the position of a UnityEngine.RectTransform

Declaration

public static void ResetTransform(this RectTransform rectTransform)

Parameters

Type	Name	Description
RectTransform	rectTransform

| Edit this page View Source

ScreenPointToLocalPointInRectangle(RectTransform, Vector2, out Vector2)

UnityEngine.RectTransformUtility.ScreenPointToLocalPointInRectangle(UnityEngine.RectTransform, UnityEngine.Vector2, UnityEngine.Camera, out UnityEngine.Vector2) but the camera is automatically detected.

Declaration

public static bool ScreenPointToLocalPointInRectangle(this RectTransform rectTransform, Vector2 screenPoint, out Vector2 result)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector2	screenPoint
Vector2	result

Returns

Type	Description
bool

| Edit this page View Source

ScreenPointToLocalPosition(RectTransform, Vector2, out Vector2)

Just as ScreenPointToLocalPointInRectangle(RectTransform, Vector2, out Vector2) but the point will be extracted from rect to be considered as position in UnityEngine.RectTransform's parent.

Declaration

public static bool ScreenPointToLocalPosition(this RectTransform rectTransform, Vector2 screenPoint, out Vector2 result)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector2	screenPoint
Vector2	result

Returns

Type	Description
bool

| Edit this page View Source

SetBottomLeftPosition(RectTransform, Vector2)

Set the bottom left corner position of a UnityEngine.RectTransform's rect.

Declaration

public static void SetBottomLeftPosition(this RectTransform rectTransform, Vector2 newPos)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector2	newPos

| Edit this page View Source

SetBottomRightPosition(RectTransform, Vector2)

Set the bottom right corner position of a UnityEngine.RectTransform's rect.

Declaration

public static void SetBottomRightPosition(this RectTransform rectTransform, Vector2 newPos)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector2	newPos

| Edit this page View Source

SetHeight(RectTransform, float)

Set the height of a UnityEngine.RectTransform's rect.

Declaration

public static void SetHeight(this RectTransform rectTransform, float height)

Parameters

Type	Name	Description
RectTransform	rectTransform
float	height

| Edit this page View Source

SetPivot(RectTransform, Vector2)

Set the pivot of a UnityEngine.RectTransform's rect.

Declaration

public static void SetPivot(this RectTransform rectTransform, Vector2 newPivot)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector2	newPivot	This is the local position. Differs from the anchored position.

| Edit this page View Source

SetSize(RectTransform, Vector2)

Set the size of a UnityEngine.RectTransform's rect.

Declaration

public static void SetSize(this RectTransform rectTransform, Vector2 newSize)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector2	newSize	UnityEngine.Vector2 representing (width, height)

| Edit this page View Source

SetTopLeftPosition(RectTransform, Vector2)

Set the top left corner position of a UnityEngine.RectTransform's rect.

Declaration

public static void SetTopLeftPosition(this RectTransform rectTransform, Vector2 newPos)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector2	newPos

| Edit this page View Source

SetTopRightPosition(RectTransform, Vector2)

Set the top right corner position of a UnityEngine.RectTransform's rect.

Declaration

public static void SetTopRightPosition(this RectTransform rectTransform, Vector2 newPos)

Parameters

Type	Name	Description
RectTransform	rectTransform
Vector2	newPos

| Edit this page View Source

SetWidth(RectTransform, float)

Set the width of a UnityEngine.RectTransform's rect.

Declaration

public static void SetWidth(this RectTransform rectTransform, float width)

Parameters

Type	Name	Description
RectTransform	rectTransform
float	width

| Edit this page View Source

ToScreenRect(RectTransform)

Returns the 'screen space' rect that represents a UnityEngine.RectTransform.

Declaration

public static Rect ToScreenRect(this RectTransform rt)

Parameters

Type	Name	Description
RectTransform	rt

Returns

Type	Description
Rect