mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class BaseDataProviderServiceInspector

    Abstract class providing base functionality for data provider management in inspector. Useful for core systems that follow dataprovider access model. Designed to target ScriptableObject profile classes that configure services who support data providers. These profile ScriptableObject classes should contain an array of IMixedRealityServiceConfigurations that configure a list of data providers for this service configuration

    Inheritance
    Object
    BaseMixedRealityProfileInspector
    BaseMixedRealityToolkitConfigurationProfileInspector
    BaseDataProviderServiceInspector
    Implements
    UnityEditor.Editor
    Inherited Members
    BaseMixedRealityToolkitConfigurationProfileInspector.RenderAsSubProfile
    BaseMixedRealityToolkitConfigurationProfileInspector.IsProfileInActiveInstance()
    BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileDescriptions
    BaseMixedRealityToolkitConfigurationProfileInspector.Awake()
    BaseMixedRealityToolkitConfigurationProfileInspector.RenderMRTKLogoAndSearch()
    BaseMixedRealityToolkitConfigurationProfileInspector.RenderDocumentation(Object)
    BaseMixedRealityToolkitConfigurationProfileInspector.DrawBacktrackProfileButton(BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType)
    BaseMixedRealityToolkitConfigurationProfileInspector.DrawBacktrackProfileButton(String, UnityEngine.Object)
    BaseMixedRealityToolkitConfigurationProfileInspector.RenderProfileHeader(String, String, Object, Boolean, BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType)
    BaseMixedRealityToolkitConfigurationProfileInspector.CheckEditorPlayMode()
    BaseMixedRealityToolkitConfigurationProfileInspector.CheckMixedRealityInputActions()
    BaseMixedRealityToolkitConfigurationProfileInspector.IsProfileRequired(SystemType)
    BaseMixedRealityProfileInspector.RenderReadOnlyProfile(SerializedProperty)
    BaseMixedRealityProfileInspector.RenderProfile(SerializedProperty, Type, Boolean, Boolean, Type)
    BaseMixedRealityProfileInspector.RenderFoldout(Boolean, String, Action, String)
    BaseMixedRealityProfileInspector.IsProfileLock(BaseMixedRealityProfile)
    Namespace: Microsoft.MixedReality.Toolkit.Editor
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class BaseDataProviderServiceInspector : BaseMixedRealityToolkitConfigurationProfileInspector, UnityEditor.Editor

    Methods

    AddDataProvider()

    Adds a new data provider profile entry (i.e IMixedRealityServiceConfiguration) to array list of target object Utilizes GetDataProviderConfigurationList() to get SerializedProperty object that represents array to insert against

    Declaration
    protected virtual void AddDataProvider()

    ApplyProviderConfiguration(Type, BaseDataProviderServiceInspector.ServiceConfigurationProperties)

    Applies the given concrete dataprovider type properties to the provided IMixedRealityServiceConfiguration instance (as represented by BaseDataProviderServiceInspector.ServiceConfigurationProperties). Requires MixedRealityDataProviderAttribute on concrete type class to pull initial values that will be applied to the BaseDataProviderServiceInspector.ServiceConfigurationProperties container SerializedProperties

    Declaration
    protected virtual void ApplyProviderConfiguration(Type dataProviderType, BaseDataProviderServiceInspector.ServiceConfigurationProperties providerProperties)
    Parameters
    Type Name Description
    Type dataProviderType
    BaseDataProviderServiceInspector.ServiceConfigurationProperties providerProperties

    GetDataProviderConfiguration(Int32)

    Returns direct IMixedRealityServiceConfiguration instance at provided index in target object's array of IMixedRealityServiceConfiguration configurations

    Declaration
    protected abstract IMixedRealityServiceConfiguration GetDataProviderConfiguration(int index)
    Parameters
    Type Name Description
    Int32 index
    Returns
    Type Description
    IMixedRealityServiceConfiguration

    GetDataProviderConfigurationList()

    Returns SerializedProperty object that wraps references to array of IMixedRealityServiceConfiguration stored on the inspected target object

    Declaration
    protected abstract SerializedProperty GetDataProviderConfigurationList()
    Returns
    Type Description
    SerializedProperty

    GetDataProviderConfigurationProperties(SerializedProperty)

    Builds BaseDataProviderServiceInspector.ServiceConfigurationProperties container object with SerializedProperty references to associated properties on the supplied IMixedRealityServiceConfiguration reference

    Declaration
    protected abstract BaseDataProviderServiceInspector.ServiceConfigurationProperties GetDataProviderConfigurationProperties(SerializedProperty providerEntry)
    Parameters
    Type Name Description
    SerializedProperty providerEntry

    SerializedProperty reference pointing to IMixedRealityServiceConfiguration instance

    Returns
    Type Description
    BaseDataProviderServiceInspector.ServiceConfigurationProperties

    OnEnable()

    Declaration
    protected override void OnEnable()
    Overrides
    BaseMixedRealityProfileInspector.OnEnable()

    RemoveDataProvider(Int32)

    Removed given index item from IMixedRealityServiceConfiguration array list. Utilizes GetDataProviderConfigurationList() to get SerializedProperty object that represents array to delete against.

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

    RenderDataProviderEntry(Int32, GUIContent, Type)

    Renders properties of IMixedRealityServiceConfiguration instance at provided index in inspector. Also renders inspector view of data provider's profile object and it's contents if applicable and foldout is expanded.

    Declaration
    protected bool RenderDataProviderEntry(int index, GUIContent removeContent, Type dataProviderProfileType = null)
    Parameters
    Type Name Description
    Int32 index
    GUIContent removeContent
    Type dataProviderProfileType
    Returns
    Type Description
    Boolean

    RenderDataProviderList(GUIContent, GUIContent, String, Type)

    Render list of data provider configuration profiles in inspector. Use provided add and remove content labels for the insert/remove buttons Returns true if any property has changed in this render pass, false otherwise

    Declaration
    protected bool RenderDataProviderList(GUIContent addContentLabel, GUIContent removeContentLabel, string errorMsg, Type dataProviderProfileType = null)
    Parameters
    Type Name Description
    GUIContent addContentLabel
    GUIContent removeContentLabel
    String errorMsg
    Type dataProviderProfileType
    Returns
    Type Description
    Boolean

    Implements

    UnityEditor.Editor
    In This Article
    • Methods
      • AddDataProvider()
      • ApplyProviderConfiguration(Type, BaseDataProviderServiceInspector.ServiceConfigurationProperties)
      • GetDataProviderConfiguration(Int32)
      • GetDataProviderConfigurationList()
      • GetDataProviderConfigurationProperties(SerializedProperty)
      • OnEnable()
      • RemoveDataProvider(Int32)
      • RenderDataProviderEntry(Int32, GUIContent, Type)
      • RenderDataProviderList(GUIContent, GUIContent, String, Type)
    • Implements
    Back to top Generated by DocFX