SirenixEditorGUI

Collection of various editor GUI functions.

namespace Sirenix.Utilities.Editor
{
[InitializeOnLoadAttribute]
public static class SirenixEditorGUI
}

Requirements

Namespace: Sirenix.Utilities.Editor
Assembly: Sirenix.OdinInspector
Version: 2.0.0.0

Static Fields

Return Type Definition Description
string MixedValueDashChar The mixed value dash character, to show when something has mixed values;

Static Properties

Return Type Definition Description
float DefaultFadeGroupDuration Default fade group animation duration.
bool ExpandFoldoutByDefault Expand foldouts by default.
float ShakingAnimationDuration Shaking animation duration.
float TabPageSlideAnimationDuration Tab page slide animation duration.

Static Methods

Return Type Definition Description
Rect BeginBox(GUIContent, bool, GUILayoutOption[]) Begins drawing a box. Remember to end with EndToolbarBox().
Rect BeginBox(GUILayoutOption[]) Begins drawing a box. Remember to end with EndToolbarBox().
Rect BeginBox(string, bool, GUILayoutOption[]) Begins drawing a box. Remember to end with EndToolbarBox().
Rect BeginBoxHeader() Begins drawing a box header. Remember to end with EndToolbarBoxHeader().
bool BeginFadeGroup(float) Begins a fade group. Remember to end with EndFadeGroup().
bool BeginFadeGroup(Object, bool) Begins a fade group. Remember to end with EndFadeGroup().
bool BeginFadeGroup(Object, bool, float) Begins a fade group. Remember to end with EndFadeGroup().
bool BeginFadeGroup(Object, bool, ref float) Begins a fade group. Remember to end with EndFadeGroup().
bool BeginFadeGroup(Object, bool, ref float, float) Begins a fade group. Remember to end with EndFadeGroup().
bool BeginFadeGroup(Object, Object, bool) Begins a fade group. Remember to end with EndFadeGroup().
bool BeginFadeGroup(Object, Object, bool, float) Begins a fade group. Remember to end with EndFadeGroup().
bool BeginFadeGroup(Object, string, bool) Begins a fade group. Remember to end with EndFadeGroup().
bool BeginFadeGroup(Object, string, bool, float) Begins a fade group. Remember to end with EndFadeGroup().
Rect BeginHorizontalAutoScrollBox(Object, GUILayoutOption[]) Begins drawing a horizontal auto scroll box. Remember to end with EndHorizontalAutoScrollBox().
Rect BeginHorizontalToolbar(float, int) Begins a horizontal toolbar. Remember to end with EndHorizontalToolbar().
Rect BeginHorizontalToolbar(GUIStyle, float, int) Begins a horizontal toolbar. Remember to end with EndHorizontalToolbar().
void BeginIndentedHorizontal(GUILayoutOption[]) Begins a horizontal indentation. Remember to end with EndIndentedHorizontal().
void BeginIndentedHorizontal(GUIStyle, GUILayoutOption[]) Begins a horizontal indentation. Remember to end with EndIndentedHorizontal().
Rect BeginIndentedVertical(GUILayoutOption[]) Begins a vertical indentation. Remember to end with EndIndentedVertical().
Rect BeginIndentedVertical(GUIStyle, GUILayoutOption[]) Begins a vertical indentation. Remember to end with EndIndentedVertical().
Rect BeginInlineBox(GUILayoutOption[]) Begins drawing an inline box. Remember to end with EndInlineBox().
Rect BeginLegendBox(GUIContent, bool, GUILayoutOption[]) Begins drawing a legend style box. Remember to end with EndLegendBox().
Rect BeginLegendBox(GUILayoutOption[]) Begins drawing a legend style box. Remember to end with EndLegendBox().
Rect BeginLegendBox(string, bool, GUILayoutOption[]) Begins drawing a legend style box. Remember to end with EndLegendBox().
Rect BeginListItem(bool, GUIStyle, GUILayoutOption[]) Begins drawing a list item.
Rect BeginListItem(bool, GUIStyle, ref bool, GUILayoutOption[]) Begins drawing a list item.
Rect BeginMenuListItem(ref bool, ref bool, bool) Begins drawing a menu list item. Remember to end with EndMenuListItem()
void BeginShakeableGroup(Object) Begins a shakeable group.
bool BeginToggleGroup(Object, ref bool, ref bool, string) Begins drawing a toggle group. Remember to end with EndToggleGroup().
bool BeginToggleGroup(Object, ref bool, ref bool, string, float) Begins drawing a toggle group. Remember to end with EndToggleGroup().
Rect BeginToolbarBox(GUIContent, bool, GUILayoutOption[]) Begins drawing a box with toolbar style header. Remember to end with EndToolbarBox().
Rect BeginToolbarBox(GUILayoutOption[]) Begins drawing a box with toolbar style header. Remember to end with EndToolbarBox().
Rect BeginToolbarBox(string, bool, GUILayoutOption[]) Begins drawing a box with toolbar style header. Remember to end with EndToolbarBox().
Rect BeginToolbarBoxHeader() Begins drawing a toolbar style box header. Remember to end with EndToolbarBoxHeader().
Rect BeginVerticalList(bool, bool, GUILayoutOption[]) Begins drawing a vertical list.
Rect BeginVerticalMenuList(Object) Begins drawing a vertical menu list.
GUITabGroup CreateAnimatedTabGroup(Object) Creates a animated tab group.
bool DetailedMessageBox(string, string, MessageType, bool, bool) Draws a message box that can be expanded to show more details.
void DrawBorders(Rect, int, bool) Draws borders around a rect.
void DrawBorders(Rect, int, Color, bool) Draws borders around a rect.
void DrawBorders(Rect, int, int, int, int, bool) Draws borders around a rect.
void DrawBorders(Rect, int, int, int, int, Color, bool) Draws borders around a rect.
Color DrawColorField(Rect, Color, bool, bool) Draws a GUI color field.
void DrawHorizontalLineSeperator(float, float, float, float) Draws a horizontal line seperator.
Rect DrawSolidRect(float, float, Color, bool) Draws a solid color rectangle.
void DrawSolidRect(Rect, Color, bool) Draws a solid color rectangle.
void DrawThickHorizontalSeparator() Draws a thick horizontal seperator.
void DrawThickHorizontalSeparator(float, float) Draws a thick horizontal seperator.
void DrawThickHorizontalSeperator(float, float, float) Draws a thick horizontal seperator.
void DrawThickHorizontalSeperator(Rect) Draws a thick horizontal seperator.
void DrawVerticalLineSeperator(float, float, float, float) Draws a vertical line seperator.
T DynamicPrimitiveField<T>(GUIContent, T, GUILayoutOption[]) Draws a field for a value of type T - dynamically choosing an appropriate drawer for the type. Currently supported are: char, string, sbyte, byte, short, ushort, int, uint, long, ulong, float, double, decimal, Guid and all enums.
bool DynamicPrimitiveFieldCanDraw<T>() Checks whether a given type can be drawn as a dynamic field by DynamicPrimitiveField<T>(GUIContent, T, GUILayoutOption[])
void EndBox() Ends drawing a box started by any BeginBox.
void EndBoxHeader() Ends drawing a box header started by BeginToolbarBoxHeader(),
void EndFadeGroup() Ends a fade group started by any BeginFadeGroup.
void EndHorizontalAutoScrollBox() Ends drawing a horizontal auto scroll box started by BeginHorizontalAutoScrollBox(Object, GUILayoutOption[]).
void EndHorizontalToolbar() Ends a horizontal toolbar started by !:BeginHorizontalToolbar(int, int).
void EndIndentedHorizontal() Ends a identation horizontal layout group started by BeginIndentedHorizontal(GUILayoutOption[]).
void EndIndentedVertical() Ends a identation vertical layout group started by BeginIndentedVertical(GUILayoutOption[]).
void EndInlineBox() Ends drawing an inline box started by any BeginInlineBox.
void EndLegendBox() Ends the drawing of a legend style box started by BeginLegendBox(GUILayoutOption[])
void EndListItem() Ends drawing a list item started by BeginListItem(bool, GUIStyle, GUILayoutOption[]).
void EndMenuListItem() Ends drawing a menu list item started by BeginMenuListItem(ref bool, ref bool, bool)
void EndShakeableGroup(Object) Ends the shakeable group.
void EndToggleGroup() Ends drawing a toggle group started by BeginToggleGroup(Object, ref bool, ref bool, string, float).
void EndToolbarBox() Ends the drawing a box with a toolbar style header started by BeginToolbarBox(GUILayoutOption[]).
void EndToolbarBoxHeader() Ends the drawing of a toolbar style box header started by BeginToolbarBoxHeader().
void EndVerticalList() Ends drawing a vertical list started by BeginVerticalList(bool, bool, GUILayoutOption[]).
void EndVerticalMenuList() Ends drawing a vertical menu list started by BeginVerticalMenuList(Object)
void ErrorMessageBox(string, bool) Draws an error message box.
bool Foldout(bool, GUIContent, GUIStyle) Draws a foldout field where clicking on the label toggles to the foldout too.
bool Foldout(bool, GUIContent, ref Rect, GUIStyle) Draws a foldout field where clicking on the label toggles to the foldout too.
bool Foldout(bool, string, GUIStyle) Draws a foldout field where clicking on the label toggles to the foldout too.
bool Foldout(Rect, bool, GUIContent, GUIStyle) Draws a foldout field where clicking on the label toggles to the foldout too.
Rect GetFeatureRichControl(Rect, GUIContent, ref int, ref bool) Creates a control ID that handles keyboard control, focused editor window, indentation and prefix label correctly.
Rect GetFeatureRichControl(Rect, ref int, ref bool) Creates a control ID that handles keyboard control, focused editor window, indentation and prefix label correctly.
Rect GetFeatureRichControlRect(GUIContent, int, ref int, ref bool, ref Rect, GUILayoutOption[]) Gets the feature rich control rect.
Rect GetFeatureRichControlRect(GUIContent, ref int, ref bool, ref Rect, GUILayoutOption[]) Gets the feature rich control rect.
void HorizontalLineSeparator(Color, int) Draws a horizontal line separator.
void HorizontalLineSeparator(int) Draws a horizontal line separator.
bool IconButton(EditorIcon, GUIStyle, int, int, string) Draws a GUI button with an icon.
bool IconButton(EditorIcon, int, int, string) Draws a GUI button with an icon.
bool IconButton(Rect, EditorIcon) Draws a GUI button with an icon.
bool IconButton(Rect, EditorIcon, GUIStyle, string) Draws a GUI button with an icon.
bool IconButton(Rect, EditorIcon, string) Draws a GUI button with an icon.
bool IconButton(Rect, Texture, GUIStyle, string) Draws a GUI button with an icon.
bool IconButton(Rect, Texture, string) Draws a GUI button with an icon.
bool IconButton(Texture, GUIStyle, int, int, string) Draws a GUI button with an icon.
bool IconButton(Texture, int, int, string) Draws a GUI button with an icon.
bool IconRepeatButton(EditorIcon) Draws a repeating icon button.
bool IconRepeatButton(EditorIcon, int) Draws a repeating icon button.
bool IconRepeatButton(EditorIcon, int, int) Draws a repeating icon button.
void IndentSpace() Indents by the current indent value, CurrentIndentAmount.
void InfoMessageBox(string, bool) Draws a info message box.
bool MenuButton(int, string, bool, Texture) Draws a menu button.
void MessageBox(string, bool) Draws a message box.
void MessageBox(string, MessageType, bool) Draws a message box.
Object ObjectField(GUIContent, Object, Type, bool, bool) Draws an GUI field for objects.
Object ObjectField(Object, Type, GUIContent, Object, bool) Draws a GUI field for objects.
Object ObjectField(Rect, GUIContent, Object, Type, bool, bool) Draws a GUI field for objects.
Rect PrivateMessageBox(string, MessageType, GUIStyle, bool) Draws a message box.
string SearchField(Rect, string, bool, string) Draws a search field.
float SlideRect(Rect, int, float) Creates a rect that can be grabbed and pulled to change a value up or down.
Vector2 SlideRect(Rect, MouseCursor) Creates a rect that can be grabbed and pulled
Vector2 SlideRect(Vector2, Rect) Creates a rect that can be grabbed and pulled
double SlideRectDouble(Rect, int, double) Creates a rect that can be grabbed and pulled to change a value up or down.
int SlideRectInt(Rect, int, int) Creates a rect that can be grabbed and pulled to change a value up or down.
long SlideRectLong(Rect, int, long) Creates a rect that can be grabbed and pulled to change a value up or down.
void StartShakingGroup(Object) Starts the shaking animation of a shaking group.
void StartShakingGroup(Object, float) Starts the shaking animation of a shaking group.
void Title(string, string, TextAlignment, bool, bool) Draws a nicely formatted title with an optinal sub-title and horizontal ruler.
bool ToolbarButton(EditorIcon, bool) Draws a toolbar icon button.
bool ToolbarButton(GUIContent, bool) Draws a toolbar icon button.
string ToolbarSearchField(string, bool, float) Draws a toolbar search field.
bool ToolbarTab(bool, GUIContent) Draws a toolbar tab.
bool ToolbarTab(bool, string) Draws a toolbar tab.
bool ToolbarToggle(bool, EditorIcon) Draws a toolbar toggle.
bool ToolbarToggle(bool, GUIContent) Draws a toolbar toggle.
bool ToolbarToggle(bool, string) Draws a toolbar toggle.
void VerticalLineSeparator(Color, int) Draws a vertical line separator.
void VerticalLineSeparator(int) Draws a vertical line separator.
void WarningMessageBox(string, bool) Draws a warning message box.