Class BaseMixedRealityToolkitConfigurationProfileInspector
Base class for all Mixed Reality Toolkit specific BaseMixedRealityProfile inspectors to inherit from.
Inheritance
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Editor
Assembly: cs.temp.dll.dll
Syntax
public abstract class BaseMixedRealityToolkitConfigurationProfileInspector : BaseMixedRealityProfileInspector
Fields
BackProfileDescriptions
Declaration
protected readonly string[] BackProfileDescriptions
Field Value
Type | Description |
---|---|
String[] |
Properties
RenderAsSubProfile
Declaration
public bool RenderAsSubProfile { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
Awake()
Declaration
protected virtual void Awake()
CheckEditorPlayMode()
If application is playing, then show warning to the user and disable inspector GUI
Declaration
protected bool CheckEditorPlayMode()
Returns
Type | Description |
---|---|
Boolean | true if application is playing, false otherwise |
CheckMixedRealityInputActions()
Check if various input settings are set correctly to read the input actions for the active MRTK instance. If any failures, show appropriate error message
Declaration
protected void CheckMixedRealityInputActions()
DrawBacktrackProfileButton(BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType)
Declaration
protected bool DrawBacktrackProfileButton(BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType returnProfileTarget = BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType.Configuration)
Parameters
Type | Name | Description |
---|---|---|
BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType | returnProfileTarget |
Returns
Type | Description |
---|---|
Boolean |
DrawBacktrackProfileButton(String, UnityEngine.Object)
Renders a button that will take user back to a specified profile object
Declaration
protected bool DrawBacktrackProfileButton(string message, UnityEngine.Object activeObject)
Parameters
Type | Name | Description |
---|---|---|
String | message | |
UnityEngine.Object | activeObject |
Returns
Type | Description |
---|---|
Boolean | True if button was clicked |
IsProfileInActiveInstance()
Helper function to determine if the current profile is assigned to the active instance of MRTK. In some cases profile data refers to other profile data in the MRTK config profile. In these cases, we don't want to render when the active instance isn't using this profile, because it may produce an inaccurate combination of settings.
Declaration
protected abstract bool IsProfileInActiveInstance()
Returns
Type | Description |
---|---|
Boolean |
IsProfileRequired(SystemType)
Inspect the attributes of the provided system type to determine if a configuration profile is required.
Declaration
protected bool IsProfileRequired(SystemType serviceType)
Parameters
Type | Name | Description |
---|---|---|
SystemType | serviceType | The system type representing the service. |
Returns
Type | Description |
---|---|
Boolean | True if the service is decorated with an attribute indicating a profile is required, false otherwise. |
RenderDocumentation(Object)
Draws a documentation link for the service.
Declaration
protected void RenderDocumentation(object profileObject)
Parameters
Type | Name | Description |
---|---|---|
Object | profileObject |
RenderMRTKLogoAndSearch()
Render the Mixed Reality Toolkit Logo and search field.
Declaration
protected bool RenderMRTKLogoAndSearch()
Returns
Type | Description |
---|---|
Boolean | True if the rest of the inspector should be drawn. |
RenderProfileHeader(String, String, Object, Boolean, BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType)
Helper function to render header correctly for all profiles
Declaration
protected bool RenderProfileHeader(string title, string description, object selectionObject, bool isProfileInitialized = true, BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType returnProfileTarget = BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType.Configuration)
Parameters
Type | Name | Description |
---|---|---|
String | title | Title of profile |
String | description | profile tooltip describing purpose |
Object | selectionObject | The profile object. Used to re-select the object after MRTK instance is created. |
Boolean | isProfileInitialized | profile properties are full initialized for rendering |
BaseMixedRealityToolkitConfigurationProfileInspector.BackProfileType | returnProfileTarget |
Returns
Type | Description |
---|---|
Boolean | True if the rest of the profile should be rendered. |