Class MarsEditorUtils

Collection of editor utility methods for the MARS editor GUI

Inheritance

object

MarsEditorUtils

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEditor.MARS

Assembly: Unity.MARS.Editor.dll

Syntax

public static class MarsEditorUtils

Properties

SimulatingDiscovery

Whether MARS is currently simulating the discovery of data over time

Declaration

public static bool SimulatingDiscovery { get; }

Property Value

Type	Description
bool

Methods

CustomAddTabToHere(object)

Add an editor window to the tab of the active window

Declaration

public static EditorWindow CustomAddTabToHere(object userData)

Parameters

Type	Name	Description
object	userData	Window to open's data

Returns

Type	Description
EditorWindow	Editor window open when menu item is selected

HintBox(bool, string, string)

Draw a hint box with a close button/action

Declaration

public static bool HintBox(bool shouldShowHint, string hintMessage, string analyticsLabel)

Parameters

Type	Name	Description
bool	shouldShowHint	Whether the hint box should currently be displayed
string	hintMessage	The primary message to show in the hint box
string	analyticsLabel	Label for this hint to be identified in analytics events

Returns

Type	Description
bool	True, unless the user presses the 'close' button

HintBox(bool, string, string, GUIContent, string, GUIContent, Action)

Draw a hint box, with a 'learn more' button and URL, and a close button/action

Declaration

public static bool HintBox(bool shouldShowHint, string hintMessage, string analyticsLabel, GUIContent learnMoreButton, string learnMoreURL, GUIContent stopShowingHintButton, Action stopShowingHintAction = null)

Parameters

Type	Name	Description
bool	shouldShowHint	Whether the hint box should currently be displayed
string	hintMessage	The primary message to show in the hint box
string	analyticsLabel	Label for this hint to be identified in analytics events
GUIContent	learnMoreButton	GUIContent of the 'learn more' button
string	learnMoreURL	URL to open when the user clicks the 'learn more' button
GUIContent	stopShowingHintButton	GUIContent of the 'close' button
Action	stopShowingHintAction	Action to call when the user presses the 'close' button

Returns

Type	Description
bool	True, unless the user presses the 'close' button

MarsCustomMenuOptions(EditorWindow, GenericMenu)

Adds the MARS custom menu options on a MARS Window using IHasCustomMenu

Declaration

public static void MarsCustomMenuOptions(this EditorWindow window, GenericMenu menu)

Parameters

Type	Name	Description
EditorWindow	window	Parent window we for custom menu
GenericMenu	menu	The menu that is part of IHasCustomMenu

NoActiveSessionHintBox(bool, string, MessageType)

Draw a hint box with a button to add a MARS Session

Declaration

public static bool NoActiveSessionHintBox(bool shouldShowHint, string hintMessage, MessageType messageType)

Parameters

Type	Name	Description
bool	shouldShowHint	Whether the hint box should currently be displayed
string	hintMessage	The primary message to show in the hint box
MessageType	messageType	What type of message box to show (info / warning)

Returns

Type	Description
bool	True, unless the user presses the 'close' button