Class LudiqGUIUtility

Inheritance

Object

LudiqGUIUtility

Namespace: Ludiq

Syntax

public static class LudiqGUIUtility

Fields

HelpBoxHeight

Declaration

public const float HelpBoxHeight = 40F

Field Value

Type	Description
Single

isNorthstar

Declaration

public static readonly bool isNorthstar

Field Value

Type	Description
Boolean

scrollBarWidth

Declaration

public const float scrollBarWidth = 15F

Field Value

Type	Description
Single

Properties

clipDepth

Declaration

public static int clipDepth { get; }

Property Value

Type	Description
Int32

clipEnabled

Declaration

public static bool clipEnabled { get; }

Property Value

Type	Description
Boolean

clipMatrix

Declaration

public static Matrix4x4 clipMatrix { get; set; }

Property Value

Type	Description
Matrix4x4

createLinearTextures

Declaration

public static bool createLinearTextures { get; }

Property Value

Type	Description
Boolean

currentInspectorHasScrollbar

Declaration

public static bool currentInspectorHasScrollbar { get; set; }

Property Value

Type	Description
Boolean

currentInspectorWidth

Declaration

public static OverrideStack<float> currentInspectorWidth { get; }

Property Value

Type	Description
OverrideStack<Single>

currentInspectorWidthWithoutScrollbar

Declaration

public static float currentInspectorWidthWithoutScrollbar { get; }

Property Value

Type	Description
Single

editorHasBoldFont

Declaration

public static bool editorHasBoldFont { get; set; }

Property Value

Type	Description
Boolean

iconSize

Declaration

public static OverrideStack<int> iconSize { get; }

Property Value

Type	Description
OverrideStack<Int32>

isWithinGUI

Declaration

public static bool isWithinGUI { get; }

Property Value

Type	Description
Boolean

labelWidth

Declaration

public static OverrideStack<float> labelWidth { get; }

Property Value

Type	Description
OverrideStack<Single>

mainEditorWindowPosition

Declaration

public static Rect mainEditorWindowPosition { get; }

Property Value

Type	Description
Rect

noClip

Declaration

public static LudiqGUIUtility.NoClipContext noClip { get; }

Property Value

Type	Description
LudiqGUIUtility.NoClipContext

topClipRect

Declaration

public static Rect topClipRect { get; }

Property Value

Type	Description
Rect

topmostClipRect

Declaration

public static Rect topmostClipRect { get; }

Property Value

Type	Description
Rect

visibleClipRect

Declaration

public static Rect visibleClipRect { get; }

Property Value

Type	Description
Rect

Methods

BeginNoClip()

Declaration

public static List<Rect> BeginNoClip()

Returns

Type	Description
List<Rect>

BeginNotActuallyOnGUI()

Declaration

public static void BeginNotActuallyOnGUI()

BeginScrollablePanel(Rect, Func<Single, Single>, out Rect, ref Vector2, RectOffset)

Declaration

public static void BeginScrollablePanel(Rect outerPosition, Func<float, float> getInnerHeight, out Rect innerPosition, ref Vector2 scroll, RectOffset overdraw = null)

Parameters

Type	Name	Description
Rect	outerPosition
Func<Single, Single>	getInnerHeight
Rect	innerPosition
Vector2	scroll
RectOffset	overdraw

BeginScrollableWindow(Rect, Func<Single, Single>, out Rect, ref Vector2)

Declaration

public static void BeginScrollableWindow(Rect windowPosition, Func<float, float> getInnerHeight, out Rect innerPosition, ref Vector2 scroll)

Parameters

Type	Name	Description
Rect	windowPosition
Func<Single, Single>	getInnerHeight
Rect	innerPosition
Vector2	scroll

BoldedStyle(GUIStyle)

Declaration

public static GUIStyle BoldedStyle(GUIStyle style)

Parameters

Type	Name	Description
GUIStyle	style

Returns

Type	Description
GUIStyle

CalcSizeWithConstraints(GUIStyle, GUIContent, Vector2)

Declaration

public static Vector2 CalcSizeWithConstraints(this GUIStyle style, GUIContent content, Vector2 constraints)

Parameters

Type	Name	Description
GUIStyle	style
GUIContent	content
Vector2	constraints

Returns

Type	Description
Vector2

Center(EditorWindow)

Declaration

public static void Center(this EditorWindow window)

Parameters

Type	Name	Description
EditorWindow	window

Clip(Rect)

Declaration

public static Rect Clip(Rect absoluteRect)

Parameters

Type	Name	Description
Rect	absoluteRect

Returns

Type	Description
Rect

Clip(Vector2)

Declaration

public static Vector2 Clip(Vector2 absolutePos)

Parameters

Type	Name	Description
Vector2	absolutePos

Returns

Type	Description
Vector2

Clone(RectOffset)

Declaration

public static RectOffset Clone(this RectOffset rectOffset)

Parameters

Type	Name	Description
RectOffset	rectOffset

Returns

Type	Description
RectOffset

ClosestPoints(Rect, Rect, out Vector2, out Vector2)

Declaration

public static void ClosestPoints(Rect rect1, Rect rect2, out Vector2 point1, out Vector2 point2)

Parameters

Type	Name	Description
Rect	rect1
Rect	rect2
Vector2	point1
Vector2	point2

CompactHelpBoxLayoutRect(String, MessageType)

Declaration

public static Rect CompactHelpBoxLayoutRect(string message, MessageType messageType)

Parameters

Type	Name	Description
String	message
MessageType	messageType

Returns

Type	Description
Rect

CtrlOrCmd(Event)

Declaration

public static bool CtrlOrCmd(this Event e)

Parameters

Type	Name	Description
Event	e

Returns

Type	Description
Boolean

CtrlOrCmdString()

Declaration

public static string CtrlOrCmdString()

Returns

Type	Description
String

DimString(String)

Declaration

public static string DimString(string s)

Parameters

Type	Name	Description
String	s

Returns

Type	Description
String

Encompass(Rect, Rect)

Declaration

public static Rect Encompass(this Rect rect, Rect other)

Parameters

Type	Name	Description
Rect	rect
Rect	other

Returns

Type	Description
Rect

Encompass(Rect, Single, Single)

Declaration

public static Rect Encompass(this Rect rect, float x, float y)

Parameters

Type	Name	Description
Rect	rect
Single	x
Single	y

Returns

Type	Description
Rect

Encompass(Rect, Vector2)

Declaration

public static Rect Encompass(this Rect rect, Vector2 point)

Parameters

Type	Name	Description
Rect	rect
Vector2	point

Returns

Type	Description
Rect

Encompass(Nullable<Rect>, Rect)

Declaration

public static Rect Encompass(this Rect? rect, Rect other)

Parameters

Type	Name	Description
Nullable<Rect>	rect
Rect	other

Returns

Type	Description
Rect

Encompasses(Rect, Rect)

Declaration

public static bool Encompasses(this Rect rect, Rect other)

Parameters

Type	Name	Description
Rect	rect
Rect	other

Returns

Type	Description
Boolean

EndNoClip(List<Rect>)

Declaration

public static void EndNoClip(List<Rect> clipRects)

Parameters

Type	Name	Description
List<Rect>	clipRects

EndNotActuallyOnGUI()

Declaration

public static void EndNotActuallyOnGUI()

EndScrollablePanel()

Declaration

public static void EndScrollablePanel()

EndScrollableWindow()

Declaration

public static void EndScrollableWindow()

EscapeRichText(String)

Declaration

public static string EscapeRichText(string s)

Parameters

Type	Name	Description
String	s

Returns

Type	Description
String

ExpandBy(Rect, RectOffset)

Declaration

public static Rect ExpandBy(this Rect rect, RectOffset offset)

Parameters

Type	Name	Description
Rect	rect
RectOffset	offset

Returns

Type	Description
Rect

ExpandBy(Rect, Single)

Declaration

public static Rect ExpandBy(this Rect rect, float padding)

Parameters

Type	Name	Description
Rect	rect
Single	padding

Returns

Type	Description
Rect

ExpandByX(Rect, RectOffset)

Declaration

public static Rect ExpandByX(this Rect rect, RectOffset offset)

Parameters

Type	Name	Description
Rect	rect
RectOffset	offset

Returns

Type	Description
Rect

ExpandByY(Rect, RectOffset)

Declaration

public static Rect ExpandByY(this Rect rect, RectOffset offset)

Parameters

Type	Name	Description
Rect	rect
RectOffset	offset

Returns

Type	Description
Rect

FocusInspector()

Declaration

public static void FocusInspector()

GetHelpBoxHeight(String, MessageType, Single)

Declaration

public static float GetHelpBoxHeight(string message, MessageType messageType, float width)

Parameters

Type	Name	Description
String	message
MessageType	messageType
Single	width

Returns

Type	Description
Single

GetHelpBoxLayoutRect(String, MessageType)

Declaration

public static Rect GetHelpBoxLayoutRect(string message, MessageType messageType)

Parameters

Type	Name	Description
String	message
MessageType	messageType

Returns

Type	Description
Rect

GetHelpBoxWidth(String, MessageType)

Declaration

public static float GetHelpBoxWidth(string message, MessageType messageType)

Parameters

Type	Name	Description
String	message
MessageType	messageType

Returns

Type	Description
Single

GetHelpIcon(MessageType)

Declaration

public static Texture2D GetHelpIcon(MessageType type)

Parameters

Type	Name	Description
MessageType	type

Returns

Type	Description
Texture2D

GetLastControlID()

Declaration

public static int GetLastControlID()

Returns

Type	Description
Int32

GetMultilineHeight(Single[])

Declaration

public static float GetMultilineHeight(params float[] widths)

Parameters

Type	Name	Description
Single[]	widths

Returns

Type	Description
Single

GetMultilineHeightConfigurable(Single, Single, Single[])

Declaration

public static float GetMultilineHeightConfigurable(float lineHeight, float verticalSpacing, params float[] widths)

Parameters

Type	Name	Description
Single	lineHeight
Single	verticalSpacing
Single[]	widths

Returns

Type	Description
Single

GetMultilinePositions(Rect, Single[])

Declaration

public static Rect[] GetMultilinePositions(Rect totalPosition, params float[] widths)

Parameters

Type	Name	Description
Rect	totalPosition
Single[]	widths

Returns

Type	Description
Rect[]

GetMultilinePositionsConfigurable(Rect, Single, Single, Single[])

Declaration

public static Rect[] GetMultilinePositionsConfigurable(Rect totalPosition, float verticalSpacing, float horizontalSpacing, params float[] widths)

Parameters

Type	Name	Description
Rect	totalPosition
Single	verticalSpacing
Single	horizontalSpacing
Single[]	widths

Returns

Type	Description
Rect[]

GetTabs(EditorWindow)

Declaration

public static EditorWindow[] GetTabs(this EditorWindow window)

Parameters

Type	Name	Description
EditorWindow	window

Returns

Type	Description
EditorWindow[]

GUIToScreenRect(Rect)

Declaration

public static Rect GUIToScreenRect(this Rect rect)

Parameters

Type	Name	Description
Rect	rect

Returns

Type	Description
Rect

IsFocused(EditorWindow)

Declaration

public static bool IsFocused(this EditorWindow window)

Parameters

Type	Name	Description
EditorWindow	window

Returns

Type	Description
Boolean

IsRightMouseButton(Event)

Declaration

public static bool IsRightMouseButton(this Event e)

Parameters

Type	Name	Description
Event	e

Returns

Type	Description
Boolean

LabelHighlightScope(String, Color, Color)

Declaration

public static IDisposable LabelHighlightScope(string labelHighlightContext, Color selectionColor, Color textColor)

Parameters

Type	Name	Description
String	labelHighlightContext
Color	selectionColor
Color	textColor

Returns

Type	Description
IDisposable

Lerp(Rect, Rect, Single)

Declaration

public static Rect Lerp(Rect a, Rect b, float t)

Parameters

Type	Name	Description
Rect	a
Rect	b
Single	t

Returns

Type	Description
Rect

NineSlice(Rect, RectOffset, out Rect, out Rect, out Rect, out Rect, out Rect, out Rect, out Rect, out Rect, out Rect)

Declaration

public static void NineSlice(this Rect r, RectOffset o, out Rect topLeft, out Rect topCenter, out Rect topRight, out Rect middleLeft, out Rect middleCenter, out Rect middleRight, out Rect bottomLeft, out Rect bottomCenter, out Rect bottomRight)

Parameters

Type	Name	Description
Rect	r
RectOffset	o
Rect	topLeft
Rect	topCenter
Rect	topRight
Rect	middleLeft
Rect	middleCenter
Rect	middleRight
Rect	bottomLeft
Rect	bottomCenter
Rect	bottomRight

Perpendicular1(Vector2)

Declaration

public static Vector2 Perpendicular1(this Vector2 vector)

Parameters

Type	Name	Description
Vector2	vector

Returns

Type	Description
Vector2

Perpendicular2(Vector2)

Declaration

public static Vector2 Perpendicular2(this Vector2 vector)

Parameters

Type	Name	Description
Vector2	vector

Returns

Type	Description
Vector2

PixelPerfect(Rect)

Declaration

public static Rect PixelPerfect(this Rect rect)

Parameters

Type	Name	Description
Rect	rect

Returns

Type	Description
Rect

PixelPerfect(Single)

Declaration

public static float PixelPerfect(this float f)

Parameters

Type	Name	Description
Single	f

Returns

Type	Description
Single

PixelPerfect(Vector2)

Declaration

public static Vector2 PixelPerfect(this Vector2 vector)

Parameters

Type	Name	Description
Vector2	vector

Returns

Type	Description
Vector2

PointSize(Texture2D)

Declaration

public static Vector2 PointSize(this Texture2D texture)

Parameters

Type	Name	Description
Texture2D	texture

Returns

Type	Description
Vector2

RepaintAllInspectors()

Declaration

public static void RepaintAllInspectors()

ScaleAroundCenter(Rect, Single)

Declaration

public static Rect ScaleAroundCenter(this Rect rect, float scale)

Parameters

Type	Name	Description
Rect	rect
Single	scale

Returns

Type	Description
Rect

ShouldSkip(Event)

Declaration

public static bool ShouldSkip(this Event e)

Parameters

Type	Name	Description
Event	e

Returns

Type	Description
Boolean

ShouldSkip(Event, Rect)

Declaration

public static bool ShouldSkip(this Event e, Rect position)

Parameters

Type	Name	Description
Event	e
Rect	position

Returns

Type	Description
Boolean

ShowAsDropDownWithKeyboardFocus(EditorWindow, Rect, Vector2)

Declaration

public static void ShowAsDropDownWithKeyboardFocus(this EditorWindow window, Rect buttonRect, Vector2 windowSize)

Parameters

Type	Name	Description
EditorWindow	window
Rect	buttonRect
Vector2	windowSize

ShowModal(EditorWindow)

Declaration

public static void ShowModal(this EditorWindow window)

Parameters

Type	Name	Description
EditorWindow	window

ShowNextTabIfPossible(EditorWindow)

Declaration

public static bool ShowNextTabIfPossible(this EditorWindow window)

Parameters

Type	Name	Description
EditorWindow	window

Returns

Type	Description
Boolean

ShowNextTo(EditorWindow, Type[])

Declaration

public static void ShowNextTo(this EditorWindow window, params Type[] windowTypes)

Parameters

Type	Name	Description
EditorWindow	window
Type[]	windowTypes

ShowPrevTabIfPossible(EditorWindow)

Declaration

public static bool ShowPrevTabIfPossible(this EditorWindow window)

Parameters

Type	Name	Description
EditorWindow	window

Returns

Type	Description
Boolean

ShrinkBy(Rect, RectOffset)

Declaration

public static Rect ShrinkBy(this Rect rect, RectOffset offset)

Parameters

Type	Name	Description
Rect	rect
RectOffset	offset

Returns

Type	Description
Rect

ShrinkBy(Rect, Single)

Declaration

public static Rect ShrinkBy(this Rect rect, float padding)

Parameters

Type	Name	Description
Rect	rect
Single	padding

Returns

Type	Description
Rect

ShrinkByX(Rect, RectOffset)

Declaration

public static Rect ShrinkByX(this Rect rect, RectOffset offset)

Parameters

Type	Name	Description
Rect	rect
RectOffset	offset

Returns

Type	Description
Rect

ShrinkByY(Rect, RectOffset)

Declaration

public static Rect ShrinkByY(this Rect rect, RectOffset offset)

Parameters

Type	Name	Description
Rect	rect
RectOffset	offset

Returns

Type	Description
Rect

Size(Texture)

Declaration

public static Vector2 Size(this Texture texture)

Parameters

Type	Name	Description
Texture	texture

Returns

Type	Description
Vector2

Size(Texture2D)

Declaration

public static Vector2 Size(this Texture2D texture)

Parameters

Type	Name	Description
Texture2D	texture

Returns

Type	Description
Vector2

TryDockNextTo(EditorWindow, Type[])

Declaration

public static bool TryDockNextTo(this EditorWindow window, params Type[] windowTypes)

Parameters

Type	Name	Description
EditorWindow	window
Type[]	windowTypes

Returns

Type	Description
Boolean

TryUse(Event)

Declaration

public static void TryUse(this Event e)

Parameters

Type	Name	Description
Event	e

Unclip(Rect)

Declaration

public static Rect Unclip(Rect rect)

Parameters

Type	Name	Description
Rect	rect

Returns

Type	Description
Rect

Unclip(Vector2)

Declaration

public static Vector2 Unclip(Vector2 pos)

Parameters

Type	Name	Description
Vector2	pos

Returns

Type	Description
Vector2

ValidateObjectFieldAssignment(UnityEngine.Object[], Type, SerializedProperty)

Declaration

public static UnityEngine.Object ValidateObjectFieldAssignment(UnityEngine.Object[] references, Type objType, SerializedProperty property = null)

Parameters

Type	Name	Description
UnityEngine.Object[]	references
Type	objType
SerializedProperty	property

Returns

Type	Description
UnityEngine.Object

VerticalSection(Rect, ref Single, Single)

Declaration

public static Rect VerticalSection(this Rect rect, ref float y, float height)

Parameters

Type	Name	Description
Rect	rect
Single	y
Single	height

Returns

Type	Description
Rect