Class MixedRealityProjectConfigurator
Utility class that provides methods to both check and configure Unity project for desired settings
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Utilities.Editor
Assembly: cs.temp.dll.dll
Syntax
public class MixedRealityProjectConfigurator
Properties
SelectedSpatializer
Property used to indicate the currently selected audio spatializer when preparing to configure a Mixed Reality Toolkit project.
Declaration
public static string SelectedSpatializer { get; set; }
Property Value
Type | Description |
---|---|
String |
Methods
ApplyXRSettings()
Discover and set the appropriate XR Settings for virtual reality supported for the current build target.
Declaration
public static void ApplyXRSettings()
ApplyXRSettings()
Discover and set the appropriate XR Settings for virtual reality supported for the current build target.
Declaration
public static void ApplyXRSettings()
Configure(MixedRealityProjectConfigurator.Configurations)
Configures the supplied setting type to the desired values for MRTK
Declaration
public static void Configure(MixedRealityProjectConfigurator.Configurations config)
Parameters
Type | Name | Description |
---|---|---|
MixedRealityProjectConfigurator.Configurations | config | The setting configuration that needs to be checked |
Configure(MixedRealityProjectConfigurator.Configurations)
Configures the supplied setting type to the desired values for MRTK
Declaration
public static void Configure(MixedRealityProjectConfigurator.Configurations config)
Parameters
Type | Name | Description |
---|---|---|
MixedRealityProjectConfigurator.Configurations | config | The setting configuration that needs to be checked |
ConfigureProject(HashSet<MixedRealityProjectConfigurator.Configurations>)
Configures the Unity project properly for the list of setting types provided. If null, configures all possibles setting types
Declaration
public static void ConfigureProject(HashSet<MixedRealityProjectConfigurator.Configurations> filter = null)
Parameters
Type | Name | Description |
---|---|---|
HashSet<MixedRealityProjectConfigurator.Configurations> | filter | List of setting types to target with configure action |
ConfigureProject(HashSet<MixedRealityProjectConfigurator.Configurations>)
Configures the Unity project properly for the list of setting types provided. If null, configures all possibles setting types
Declaration
public static void ConfigureProject(HashSet<MixedRealityProjectConfigurator.Configurations> filter = null)
Parameters
Type | Name | Description |
---|---|---|
HashSet<MixedRealityProjectConfigurator.Configurations> | filter | List of setting types to target with configure action |
HasSpatialAwarenessLayer()
Checks if current Unity project has the default Spatial Awareness layer set in the Layers settings
Declaration
public static bool HasSpatialAwarenessLayer()
Returns
Type | Description |
---|---|
Boolean |
HasSpatialAwarenessLayer()
Checks if current Unity project has the default Spatial Awareness layer set in the Layers settings
Declaration
public static bool HasSpatialAwarenessLayer()
Returns
Type | Description |
---|---|
Boolean |
IsConfigured(MixedRealityProjectConfigurator.Configurations)
Checks whether the supplied setting type has been properly configured
Declaration
public static bool IsConfigured(MixedRealityProjectConfigurator.Configurations config)
Parameters
Type | Name | Description |
---|---|---|
MixedRealityProjectConfigurator.Configurations | config | The setting configuration that needs to be checked |
Returns
Type | Description |
---|---|
Boolean | true if properly configured, false otherwise |
IsConfigured(MixedRealityProjectConfigurator.Configurations)
Checks whether the supplied setting type has been properly configured
Declaration
public static bool IsConfigured(MixedRealityProjectConfigurator.Configurations config)
Parameters
Type | Name | Description |
---|---|---|
MixedRealityProjectConfigurator.Configurations | config | The setting configuration that needs to be checked |
Returns
Type | Description |
---|---|
Boolean | true if properly configured, false otherwise |
IsForceTextSerialization()
Checks if current Unity projects uses force text serialization
Declaration
public static bool IsForceTextSerialization()
Returns
Type | Description |
---|---|
Boolean |
IsForceTextSerialization()
Checks if current Unity projects uses force text serialization
Declaration
public static bool IsForceTextSerialization()
Returns
Type | Description |
---|---|
Boolean |
IsLatestScriptingRuntime()
Checks if current Unity project has latest scripting runtime
Declaration
public static bool IsLatestScriptingRuntime()
Returns
Type | Description |
---|---|
Boolean |
IsLatestScriptingRuntime()
Checks if current Unity project has latest scripting runtime
Declaration
public static bool IsLatestScriptingRuntime()
Returns
Type | Description |
---|---|
Boolean |
IsMSBuildForUnityEnabled()
Checks package manifest to see if MSBuild for Unity is included in the dependencies.
Declaration
public static bool IsMSBuildForUnityEnabled()
Returns
Type | Description |
---|---|
Boolean |
IsProjectConfigured()
Is this Unity project configured for all setting types properly
Declaration
public static bool IsProjectConfigured()
Returns
Type | Description |
---|---|
Boolean | true if entire project is configured as recommended, false otherwise |
IsProjectConfigured()
Is this Unity project configured for all setting types properly
Declaration
public static bool IsProjectConfigured()
Returns
Type | Description |
---|---|
Boolean | true if entire project is configured as recommended, false otherwise |
IsVisibleMetaFiles()
Checks if current Unity project uses visible meta files
Declaration
public static bool IsVisibleMetaFiles()
Returns
Type | Description |
---|---|
Boolean |
IsVisibleMetaFiles()
Checks if current Unity project uses visible meta files
Declaration
public static bool IsVisibleMetaFiles()
Returns
Type | Description |
---|---|
Boolean |
SetAudioSpatializer()
Configures current Unity project to use the audio spatializer specified by the SelectedSpatializer property.
Declaration
public static void SetAudioSpatializer()
SetForceTextSerialization()
Configures current Unity project to force text serialization
Declaration
public static void SetForceTextSerialization()
SetForceTextSerialization()
Configures current Unity project to force text serialization
Declaration
public static void SetForceTextSerialization()
SetLatestScriptingRuntime()
Configures current Unity project to use latest scripting runtime and reloads project
Declaration
public static void SetLatestScriptingRuntime()
SetLatestScriptingRuntime()
Configures current Unity project to use latest scripting runtime and reloads project
Declaration
public static void SetLatestScriptingRuntime()
SetSpatialAwarenessLayer()
Configures current Unity project to contain the default Spatial Awareness layer set in the Layers settings
Declaration
public static void SetSpatialAwarenessLayer()
SetSpatialAwarenessLayer()
Configures current Unity project to contain the default Spatial Awareness layer set in the Layers settings
Declaration
public static void SetSpatialAwarenessLayer()
SetVisibleMetaFiles()
Configures current Unity project to enabled visible meta files
Declaration
public static void SetVisibleMetaFiles()
SetVisibleMetaFiles()
Configures current Unity project to enabled visible meta files
Declaration
public static void SetVisibleMetaFiles()