We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Class InteractableInspector

    Inheritance
    Object
    InteractableInspector
    Namespace: Microsoft.MixedReality.Toolkit.UI.Editor
    Assembly: cs.temp.dll.dll
    Syntax
    public class InteractableInspector : UnityEditor.Editor

    Fields

    actionId

    Declaration
    protected SerializedProperty actionId
    Field Value
    Type Description
    SerializedProperty

    boxStyle

    Declaration
    protected GUIStyle boxStyle
    Field Value
    Type Description
    GUIStyle

    canDeselect

    Declaration
    protected SerializedProperty canDeselect
    Field Value
    Type Description
    SerializedProperty

    canSelect

    Declaration
    protected SerializedProperty canSelect
    Field Value
    Type Description
    SerializedProperty

    dimensionIndex

    Declaration
    protected SerializedProperty dimensionIndex
    Field Value
    Type Description
    SerializedProperty

    dimensions

    Declaration
    protected SerializedProperty dimensions
    Field Value
    Type Description
    SerializedProperty

    enabled

    Declaration
    protected bool enabled
    Field Value
    Type Description
    Boolean

    enabledProperty

    Declaration
    protected SerializedProperty enabledProperty
    Field Value
    Type Description
    SerializedProperty

    eventList

    Declaration
    protected List<InteractableEvent> eventList
    Field Value
    Type Description
    List<InteractableEvent>

    eventOptions

    Declaration
    protected InteractableTypesContainer eventOptions
    Field Value
    Type Description
    InteractableTypesContainer

    hasProfileLayout

    Declaration
    protected bool hasProfileLayout
    Field Value
    Type Description
    Boolean

    inputActionOptions

    Declaration
    protected string[] inputActionOptions
    Field Value
    Type Description
    String[]

    instance

    Declaration
    protected Interactable instance
    Field Value
    Type Description
    Interactable

    isGlobal

    Declaration
    protected SerializedProperty isGlobal
    Field Value
    Type Description
    SerializedProperty

    profileList

    Declaration
    protected SerializedProperty profileList
    Field Value
    Type Description
    SerializedProperty

    ProfilesSetup

    Declaration
    protected static bool ProfilesSetup
    Field Value
    Type Description
    Boolean

    shaderOptions

    Declaration
    protected string[] shaderOptions
    Field Value
    Type Description
    String[]

    showEvents

    Declaration
    protected static bool showEvents
    Field Value
    Type Description
    Boolean

    ShowEventsPrefKey

    Declaration
    protected const string ShowEventsPrefKey = "InteractableInspectorProfiles_ShowEvents"
    Field Value
    Type Description
    String

    showProfiles

    Declaration
    protected static bool showProfiles
    Field Value
    Type Description
    Boolean

    ShowProfilesPrefKey

    Declaration
    protected const string ShowProfilesPrefKey = "InteractableInspectorProfiles"
    Field Value
    Type Description
    String

    speechKeywordOptions

    Declaration
    protected string[] speechKeywordOptions
    Field Value
    Type Description
    String[]

    startDimensionIndex

    Declaration
    protected SerializedProperty startDimensionIndex
    Field Value
    Type Description
    SerializedProperty

    statesProperty

    Declaration
    protected SerializedProperty statesProperty
    Field Value
    Type Description
    SerializedProperty

    themeOptions

    Declaration
    protected InteractableTypesContainer themeOptions
    Field Value
    Type Description
    InteractableTypesContainer

    voiceCommands

    Declaration
    protected SerializedProperty voiceCommands
    Field Value
    Type Description
    SerializedProperty

    Methods

    AddEvent(Int32)

    Declaration
    protected void AddEvent(int index)
    Parameters
    Type Name Description
    Int32 index

    AddProfile(Int32)

    Declaration
    protected void AddProfile(int index)
    Parameters
    Type Name Description
    Int32 index

    AddThemeProperty(SerializedProperty, SerializedProperty)

    Declaration
    protected virtual void AddThemeProperty(SerializedProperty profileItem, SerializedProperty themeItem)
    Parameters
    Type Name Description
    SerializedProperty profileItem
    SerializedProperty themeItem

    ChangeEvent(Int32[], SerializedProperty)

    Declaration
    protected void ChangeEvent(int[] indexArray, SerializedProperty prop = null)
    Parameters
    Type Name Description
    Int32[] indexArray
    SerializedProperty prop

    ChangeThemeProperty(Int32, SerializedObject, SerializedProperty, Boolean)

    Declaration
    protected virtual SerializedObject ChangeThemeProperty(int index, SerializedObject themeObj, SerializedProperty target, bool isNew = false)
    Parameters
    Type Name Description
    Int32 index
    SerializedObject themeObj
    SerializedProperty target
    Boolean isNew
    Returns
    Type Description
    SerializedObject

    CreateTheme(SerializedProperty, SerializedProperty)

    Declaration
    protected void CreateTheme(SerializedProperty profileItem, SerializedProperty themeItem)
    Parameters
    Type Name Description
    SerializedProperty profileItem
    SerializedProperty themeItem

    DrawDropDownProperty(Rect, SerializedProperty, String[], GUIContent)

    Draws a popup UI with PropertyField type features. Displays prefab pending updates

    Declaration
    protected void DrawDropDownProperty(Rect position, SerializedProperty prop, string[] options, GUIContent label)
    Parameters
    Type Name Description
    Rect position
    SerializedProperty prop
    String[] options
    GUIContent label

    GetEventList()

    Declaration
    protected string[] GetEventList()
    Returns
    Type Description
    String[]

    GetStates()

    Declaration
    protected virtual State[] GetStates()
    Returns
    Type Description
    State[]

    OnEnable()

    Declaration
    protected virtual void OnEnable()

    OnInspectorGUI()

    Declaration
    public override sealed void OnInspectorGUI()
    Remarks

    There is a check in here that verifies whether or not we can get InputActions, if we can't we show an error help box; otherwise we get them. This method is sealed, if you wish to override OnInspectorGUI(), then override RenderCustomInspector() method instead.

    RemoveEvent(Int32, SerializedProperty)

    Declaration
    protected void RemoveEvent(int index, SerializedProperty prop = null)
    Parameters
    Type Name Description
    Int32 index
    SerializedProperty prop

    RemoveProfile(Int32, SerializedProperty)

    Declaration
    protected void RemoveProfile(int index, SerializedProperty prop = null)
    Parameters
    Type Name Description
    Int32 index
    SerializedProperty prop

    RemoveThemeProperty(Int32[])

    Declaration
    protected virtual void RemoveThemeProperty(int[] arr)
    Parameters
    Type Name Description
    Int32[] arr

    RenderBaseInspector()

    Declaration
    protected virtual void RenderBaseInspector()

    RenderCustomInspector()

    Declaration
    public virtual void RenderCustomInspector()

    RenderGeneralSettings()

    Declaration
    protected void RenderGeneralSettings()

    SetupEventOptions()

    Declaration
    protected void SetupEventOptions()

    SetupThemeOptions()

    Declaration
    protected void SetupThemeOptions()

    SpeechKeywordLookup(String, String[])

    Get the index of the speech keyword array item based on its name, pop-up field helper Skips the first item in the array (internal added blank value to turn feature off) and returns a 0 if no match is found for the blank value

    Declaration
    protected int SpeechKeywordLookup(string option, string[] options)
    Parameters
    Type Name Description
    String option
    String[] options
    Returns
    Type Description
    Int32
    Back to top Generated by DocFX