Class LudiqGUI

Inheritance
Object
LudiqGUI
Namespace: Unity.VisualScripting
Syntax
public static class LudiqGUI

Fields

color

Declaration
public static readonly OverrideStack<Color> color
Field Value
Type Description
OverrideStack<Color>

loaderResolution

Declaration
public static readonly TextureResolution loaderResolution
Field Value
Type Description
TextureResolution

loaderSize

Declaration
public const int loaderSize = 24
Field Value
Type Description
Int32

matrix

Declaration
public static readonly OverrideStack<Matrix4x4> matrix
Field Value
Type Description
OverrideStack<Matrix4x4>

Methods

AdaptiveVector2Field(Rect, GUIContent, Vector2)

Declaration
public static Vector2 AdaptiveVector2Field(Rect position, GUIContent label, Vector2 value)
Parameters
Type Name Description
Rect position
GUIContent label
Vector2 value
Returns
Type Description
Vector2

AdaptiveVector3Field(Rect, GUIContent, Vector3)

Declaration
public static Vector3 AdaptiveVector3Field(Rect position, GUIContent label, Vector3 value)
Parameters
Type Name Description
Rect position
GUIContent label
Vector3 value
Returns
Type Description
Vector3

AdaptiveVector4Field(Rect, GUIContent, Vector4)

Declaration
public static Vector4 AdaptiveVector4Field(Rect position, GUIContent label, Vector4 value)
Parameters
Type Name Description
Rect position
GUIContent label
Vector4 value
Returns
Type Description
Vector4

BeginHorizontal(GUILayoutOption[])

Declaration
public static void BeginHorizontal(params GUILayoutOption[] options)
Parameters
Type Name Description
GUILayoutOption[] options

BeginHorizontal(GUIStyle, GUILayoutOption[])

Declaration
public static void BeginHorizontal(GUIStyle style, params GUILayoutOption[] options)
Parameters
Type Name Description
GUIStyle style
GUILayoutOption[] options

BeginVertical(GUILayoutOption[])

Declaration
public static void BeginVertical(params GUILayoutOption[] options)
Parameters
Type Name Description
GUILayoutOption[] options

CenterLoader()

Declaration
public static void CenterLoader()

CompactVector2Field(Rect, GUIContent, Vector2)

Declaration
public static Vector2 CompactVector2Field(Rect position, GUIContent label, Vector2 value)
Parameters
Type Name Description
Rect position
GUIContent label
Vector2 value
Returns
Type Description
Vector2

CompactVector3Field(Rect, GUIContent, Vector3)

Declaration
public static Vector3 CompactVector3Field(Rect position, GUIContent label, Vector3 value)
Parameters
Type Name Description
Rect position
GUIContent label
Vector3 value
Returns
Type Description
Vector3

CompactVector4Field(Rect, GUIContent, Vector4)

Declaration
public static Vector4 CompactVector4Field(Rect position, GUIContent label, Vector4 value)
Parameters
Type Name Description
Rect position
GUIContent label
Vector4 value
Returns
Type Description
Vector4

DraggableFloatField(Rect, Single, GUIContent)

Declaration
public static float DraggableFloatField(Rect position, float value, GUIContent label = null)
Parameters
Type Name Description
Rect position
Single value
GUIContent label
Returns
Type Description
Single

DraggableIntField(Rect, Int32, GUIContent)

Declaration
public static int DraggableIntField(Rect position, int value, GUIContent label = null)
Parameters
Type Name Description
Rect position
Int32 value
GUIContent label
Returns
Type Description
Int32

DraggableLongField(Rect, Int64, GUIContent)

Declaration
public static long DraggableLongField(Rect position, long value, GUIContent label = null)
Parameters
Type Name Description
Rect position
Int64 value
GUIContent label
Returns
Type Description
Int64

DragNumber(Rect, Boolean, Int32, Int32)

Declaration
public static int DragNumber(Rect hotZone, bool deadZone, int controlId, int value)
Parameters
Type Name Description
Rect hotZone
Boolean deadZone
Int32 controlId
Int32 value
Returns
Type Description
Int32

DragNumber(Rect, Boolean, Int32, Int64)

Declaration
public static long DragNumber(Rect hotZone, bool deadZone, int controlId, long value)
Parameters
Type Name Description
Rect hotZone
Boolean deadZone
Int32 controlId
Int64 value
Returns
Type Description
Int64

DragNumber(Rect, Boolean, Int32, Single)

Declaration
public static float DragNumber(Rect hotZone, bool deadZone, int controlId, float value)
Parameters
Type Name Description
Rect hotZone
Boolean deadZone
Int32 controlId
Single value
Returns
Type Description
Single

DrawEmptyRect(Rect, Color)

Declaration
public static void DrawEmptyRect(Rect position, Color color)
Parameters
Type Name Description
Rect position
Color color

Dropdown(Vector2, Action<HashSet<Object>>, IEnumerable<DropdownOption>, HashSet<Object>, Boolean)

Declaration
public static void Dropdown(Vector2 position, Action<HashSet<object>> callback, IEnumerable<DropdownOption> options, HashSet<object> selected, bool showNothingEverything = true)
Parameters
Type Name Description
Vector2 position
Action<HashSet<Object>> callback
IEnumerable<DropdownOption> options
HashSet<Object> selected
Boolean showNothingEverything

Dropdown(Vector2, Action<Object>, IEnumerable<DropdownOption>, Object)

Declaration
public static void Dropdown(Vector2 position, Action<object> callback, IEnumerable<DropdownOption> options, object selected)
Parameters
Type Name Description
Vector2 position
Action<Object> callback
IEnumerable<DropdownOption> options
Object selected

Editor(Metadata, Rect)

Declaration
public static void Editor(Metadata metadata, Rect position)
Parameters
Type Name Description
Metadata metadata
Rect position

EditorLayout(Metadata)

Declaration
public static void EditorLayout(Metadata metadata)
Parameters
Type Name Description
Metadata metadata

EndHorizontal()

Declaration
public static void EndHorizontal()

EndVertical()

Declaration
public static void EndVertical()

FlexibleSpace()

Declaration
public static void FlexibleSpace()

FuzzyDropdown(Rect, IFuzzyOptionTree, HashSet<Object>, Action<HashSet<Object>>)

Declaration
public static void FuzzyDropdown(Rect activatorPosition, IFuzzyOptionTree optionTree, HashSet<object> selected, Action<HashSet<object>> callback)
Parameters
Type Name Description
Rect activatorPosition
IFuzzyOptionTree optionTree
HashSet<Object> selected
Action<HashSet<Object>> callback

FuzzyDropdown(Rect, IFuzzyOptionTree, Object, Action<Object>)

Declaration
public static void FuzzyDropdown(Rect activatorPosition, IFuzzyOptionTree optionTree, object selected, Action<object> callback)
Parameters
Type Name Description
Rect activatorPosition
IFuzzyOptionTree optionTree
Object selected
Action<Object> callback

FuzzyPopup(Rect, Func<IFuzzyOptionTree>, HashSet<Object>, Boolean, GUIContent, GUIStyle)

Declaration
public static HashSet<object> FuzzyPopup(Rect position, Func<IFuzzyOptionTree> getProvider, HashSet<object> selected, bool showNothingEverything = true, GUIContent label = null, GUIStyle style = null)
Parameters
Type Name Description
Rect position
Func<IFuzzyOptionTree> getProvider
HashSet<Object> selected
Boolean showNothingEverything
GUIContent label
GUIStyle style
Returns
Type Description
HashSet<Object>

FuzzyPopup(Rect, Func<IFuzzyOptionTree>, Object, GUIContent, GUIStyle)

Declaration
public static object FuzzyPopup(Rect position, Func<IFuzzyOptionTree> getProvider, object selected, GUIContent label = null, GUIStyle style = null)
Parameters
Type Name Description
Rect position
Func<IFuzzyOptionTree> getProvider
Object selected
GUIContent label
GUIStyle style
Returns
Type Description
Object

GetEditorHeight(Inspector, Metadata, Single)

Declaration
public static float GetEditorHeight(Inspector parentInspector, Metadata metadata, float width)
Parameters
Type Name Description
Inspector parentInspector
Metadata metadata
Single width
Returns
Type Description
Single

GetEnumPopupContent(Enum)

Declaration
public static GUIContent GetEnumPopupContent(Enum value)
Parameters
Type Name Description
Enum value
Returns
Type Description
GUIContent

GetHeaderHeight(Inspector, Metadata, Metadata, EditorTexture, Single, Boolean)

Declaration
public static float GetHeaderHeight(Inspector parentInspector, Metadata titleMetadata, Metadata summaryMetadata, EditorTexture icon, float totalWidth, bool bottomMargin = true)
Parameters
Type Name Description
Inspector parentInspector
Metadata titleMetadata
Metadata summaryMetadata
EditorTexture icon
Single totalWidth
Boolean bottomMargin
Returns
Type Description
Single

GetHeaderHeight(LudiqGUI.GetHeaderTitleHeightDelegate, LudiqGUI.GetHeaderSummaryHeightDelegate, EditorTexture, Single, Boolean, Single)

Declaration
public static float GetHeaderHeight(LudiqGUI.GetHeaderTitleHeightDelegate getTitleHeight, LudiqGUI.GetHeaderSummaryHeightDelegate getSummaryHeight, EditorTexture icon, float totalWidth, bool bottomMargin = true, float spaceBetweenTitleAndSummary = 0F)
Parameters
Type Name Description
LudiqGUI.GetHeaderTitleHeightDelegate getTitleHeight
LudiqGUI.GetHeaderSummaryHeightDelegate getSummaryHeight
EditorTexture icon
Single totalWidth
Boolean bottomMargin
Single spaceBetweenTitleAndSummary
Returns
Type Description
Single

GetHeaderHeight(GUIContent, Single, Boolean)

Declaration
public static float GetHeaderHeight(GUIContent header, float totalWidth, bool bottomMargin = true)
Parameters
Type Name Description
GUIContent header
Single totalWidth
Boolean bottomMargin
Returns
Type Description
Single

GetInspectorAdaptiveWidth(Metadata)

Declaration
public static float GetInspectorAdaptiveWidth(Metadata metadata)
Parameters
Type Name Description
Metadata metadata
Returns
Type Description
Single

GetInspectorHeight(Inspector, Metadata, Single, GUIContent)

Declaration
public static float GetInspectorHeight(Inspector parentInspector, Metadata metadata, float width, GUIContent label = null)
Parameters
Type Name Description
Inspector parentInspector
Metadata metadata
Single width
GUIContent label
Returns
Type Description
Single

GetTextFieldAdaptiveWidth(Object, Single)

Declaration
public static float GetTextFieldAdaptiveWidth(object content, float min = 16F)
Parameters
Type Name Description
Object content
Single min
Returns
Type Description
Single

GetTypeFieldAdaptiveWidth(Type, GUIContent)

Declaration
public static float GetTypeFieldAdaptiveWidth(Type type, GUIContent nullLabel = null)
Parameters
Type Name Description
Type type
GUIContent nullLabel
Returns
Type Description
Single

GetTypeFieldHeight(GUIContent, Type)

Declaration
public static float GetTypeFieldHeight(GUIContent label, Type type)
Parameters
Type Name Description
GUIContent label
Type type
Returns
Type Description
Single

GetVersionMismatchShieldHeight(Single)

Declaration
public static float GetVersionMismatchShieldHeight(float width)
Parameters
Type Name Description
Single width
Returns
Type Description
Single

ImmediatePopup(Int32, Boolean, HashSet<Object>, Action)

Declaration
public static HashSet<object> ImmediatePopup(int controlID, bool activated, HashSet<object> selected, Action dropdown)
Parameters
Type Name Description
Int32 controlID
Boolean activated
HashSet<Object> selected
Action dropdown
Returns
Type Description
HashSet<Object>

ImmediatePopup(Int32, Boolean, Object, Action)

Declaration
public static object ImmediatePopup(int controlID, bool activated, object selected, Action dropdown)
Parameters
Type Name Description
Int32 controlID
Boolean activated
Object selected
Action dropdown
Returns
Type Description
Object

Inspector(Metadata, Rect, GUIContent)

Declaration
public static void Inspector(Metadata metadata, Rect position, GUIContent label = null)
Parameters
Type Name Description
Metadata metadata
Rect position
GUIContent label

InspectorLayout(Metadata, GUIContent, Single, RectOffset)

Declaration
public static void InspectorLayout(Metadata metadata, GUIContent label = null, float scrollbarTrigger = 14F, RectOffset offset = null)
Parameters
Type Name Description
Metadata metadata
GUIContent label
Single scrollbarTrigger
RectOffset offset

List(Vector2, IList<ListOption>, Object, Action<Object>)

Declaration
public static Vector2 List(Vector2 scroll, IList<ListOption> options, object selected, Action<object> selectionChanged)
Parameters
Type Name Description
Vector2 scroll
IList<ListOption> options
Object selected
Action<Object> selectionChanged
Returns
Type Description
Vector2

Loader(Rect)

Declaration
public static void Loader(Rect position)
Parameters
Type Name Description
Rect position

LoaderLayout()

Declaration
public static void LoaderLayout()

OnHeaderGUI(LudiqGUI.GetHeaderTitleHeightDelegate, LudiqGUI.GetHeaderSummaryHeightDelegate, LudiqGUI.OnHeaderTitleGUIDelegate, LudiqGUI.OnHeaderSummaryGUIDelegate, EditorTexture, Rect, ref Single, Boolean, Single)

Declaration
public static void OnHeaderGUI(LudiqGUI.GetHeaderTitleHeightDelegate getTitleHeight, LudiqGUI.GetHeaderSummaryHeightDelegate getSummaryHeight, LudiqGUI.OnHeaderTitleGUIDelegate onTitleGUI, LudiqGUI.OnHeaderSummaryGUIDelegate onSummaryGui, EditorTexture icon, Rect position, ref float y, bool bottomMargin = true, float spaceBetweenTitleAndSummary = 0F)
Parameters
Type Name Description
LudiqGUI.GetHeaderTitleHeightDelegate getTitleHeight
LudiqGUI.GetHeaderSummaryHeightDelegate getSummaryHeight
LudiqGUI.OnHeaderTitleGUIDelegate onTitleGUI
LudiqGUI.OnHeaderSummaryGUIDelegate onSummaryGui
EditorTexture icon
Rect position
Single y
Boolean bottomMargin
Single spaceBetweenTitleAndSummary

OnHeaderGUI(Metadata, Metadata, EditorTexture, Rect, ref Single, Boolean)

Declaration
public static void OnHeaderGUI(Metadata titleMetadata, Metadata summaryMetadata, EditorTexture icon, Rect position, ref float y, bool bottomMargin = true)
Parameters
Type Name Description
Metadata titleMetadata
Metadata summaryMetadata
EditorTexture icon
Rect position
Single y
Boolean bottomMargin

OnHeaderGUI(GUIContent, Rect, ref Single, Boolean)

Declaration
public static void OnHeaderGUI(GUIContent header, Rect position, ref float y, bool bottomMargin = true)
Parameters
Type Name Description
GUIContent header
Rect position
Single y
Boolean bottomMargin

Popup(Rect, Func<IEnumerable<DropdownOption>>, HashSet<Object>, Boolean, GUIContent, GUIStyle)

Declaration
public static HashSet<object> Popup(Rect position, Func<IEnumerable<DropdownOption>> getOptions, HashSet<object> selected, bool showNothingEverything = true, GUIContent label = null, GUIStyle style = null)
Parameters
Type Name Description
Rect position
Func<IEnumerable<DropdownOption>> getOptions
HashSet<Object> selected
Boolean showNothingEverything
GUIContent label
GUIStyle style
Returns
Type Description
HashSet<Object>

Popup(Rect, Func<IEnumerable<DropdownOption>>, Object, GUIContent, GUIStyle)

Declaration
public static object Popup(Rect position, Func<IEnumerable<DropdownOption>> getOptions, object selected, GUIContent label = null, GUIStyle style = null)
Parameters
Type Name Description
Rect position
Func<IEnumerable<DropdownOption>> getOptions
Object selected
GUIContent label
GUIStyle style
Returns
Type Description
Object

Space(Single)

Declaration
public static void Space(float pixels)
Parameters
Type Name Description
Single pixels

Spinner(Rect, Boolean, Boolean)

Declaration
public static int Spinner(Rect position, bool upEnabled = true, bool downEnabled = true)
Parameters
Type Name Description
Rect position
Boolean upEnabled
Boolean downEnabled
Returns
Type Description
Int32

TypeField(Rect, GUIContent, Type, Func<IFuzzyOptionTree>, GUIContent)

Declaration
public static Type TypeField(Rect position, GUIContent label, Type type, Func<IFuzzyOptionTree> getOptions, GUIContent nullLabel = null)
Parameters
Type Name Description
Rect position
GUIContent label
Type type
Func<IFuzzyOptionTree> getOptions
GUIContent nullLabel
Returns
Type Description
Type

UpdateImmediatePopupValue(Object)

Declaration
public static void UpdateImmediatePopupValue(object value)
Parameters
Type Name Description
Object value

UpdateImmediatePopupValues(HashSet<Object>)

Declaration
public static void UpdateImmediatePopupValues(HashSet<object> value)
Parameters
Type Name Description
HashSet<Object> value

VersionMismatchShield(Rect)

Declaration
public static void VersionMismatchShield(Rect position)
Parameters
Type Name Description
Rect position

VersionMismatchShieldLayout()

Declaration
public static void VersionMismatchShieldLayout()

WindowHeader(String, EditorTexture)

Declaration
public static void WindowHeader(string label, EditorTexture icon)
Parameters
Type Name Description
String label
EditorTexture icon