Class ExtensionServiceCreator
Class used to generate service scripts and profile instances. Primarily designed for in-editor use
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Editor
Assembly: cs.temp.dll.dll
Syntax
public class ExtensionServiceCreator
Properties
CreationLog
Log of errors and updates thus far in the create operation of the new extension service classes
Declaration
public string CreationLog { get; }
Property Value
Type | Description |
---|---|
String |
InspectorFolderObject
Unity object pointing to folder asset to place Inspector class file, if applicable
Declaration
public UnityEngine.Object InspectorFolderObject { get; set; }
Property Value
Type | Description |
---|---|
UnityEngine.Object |
InspectorName
Name of Unity inspector class to create. Value is ServiceName concatenated with "Inspector"
Declaration
public string InspectorName { get; }
Property Value
Type | Description |
---|---|
String |
InterfaceFolderObject
Unity object pointing to folder asset to place interface file, if applicable
Declaration
public UnityEngine.Object InterfaceFolderObject { get; set; }
Property Value
Type | Description |
---|---|
UnityEngine.Object |
InterfaceName
Name of interface to create for new extension service. Value is ServiceName with leading "I"
Declaration
public string InterfaceName { get; }
Property Value
Type | Description |
---|---|
String |
Namespace
Namespace to utilize for all classes
Declaration
public string Namespace { get; set; }
Property Value
Type | Description |
---|---|
String |
Platforms
Supported platform flags for new extension service. Added to attribute on service class
Declaration
public SupportedPlatforms Platforms { get; set; }
Property Value
Type | Description |
---|---|
SupportedPlatforms |
ProfileAssetFolderObject
Unity object pointing to folder asset to place ScriptableObject profile asset file, if applicable
Declaration
public UnityEngine.Object ProfileAssetFolderObject { get; set; }
Property Value
Type | Description |
---|---|
UnityEngine.Object |
ProfileAssetName
Name of default ScriptableObject instance asset to create. Value is "Default" concatenated with ProfileName
Declaration
public string ProfileAssetName { get; }
Property Value
Type | Description |
---|---|
String |
ProfileFolderObject
Unity object pointing to folder asset to place ScriptableObject profile class file, if applicable
Declaration
public UnityEngine.Object ProfileFolderObject { get; set; }
Property Value
Type | Description |
---|---|
UnityEngine.Object |
ProfileInstance
Object instance of ScriptableObject profile class for extension service created
Declaration
public BaseMixedRealityProfile ProfileInstance { get; }
Property Value
Type | Description |
---|---|
BaseMixedRealityProfile |
ProfileName
Name of ScriptableObject profile class to create. Value is ServiceName concatenated with "Profile"
Declaration
public string ProfileName { get; }
Property Value
Type | Description |
---|---|
String |
Result
Current result of extension service file(s) create operation
Declaration
public ExtensionServiceCreator.CreateResult Result { get; }
Property Value
Type | Description |
---|---|
ExtensionServiceCreator.CreateResult |
SampleCode
Sample code string demonstrating example usage for new Extension service created
Declaration
public string SampleCode { get; }
Property Value
Type | Description |
---|---|
String |
ServiceFolderObject
Unity object pointing to folder asset to place Service class file
Declaration
public UnityEngine.Object ServiceFolderObject { get; set; }
Property Value
Type | Description |
---|---|
UnityEngine.Object |
ServiceName
The name of the new extension service to build
Declaration
public string ServiceName { get; set; }
Property Value
Type | Description |
---|---|
String |
ServiceType
System.Type of Extension Service created
Declaration
public Type ServiceType { get; }
Property Value
Type | Description |
---|---|
Type |
Stage
Current stage in UI workflow for creation
Declaration
public ExtensionServiceCreator.CreationStage Stage { get; set; }
Property Value
Type | Description |
---|---|
ExtensionServiceCreator.CreationStage |
UsesInspector
Should a custom editor inspector class be created for new extension service
Declaration
public bool UsesInspector { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
UsesProfile
Should a ScriptableObject profile class be created for new extension service
Declaration
public bool UsesProfile { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
BeginAssetCreationProcess()
Start the creation process for all relevant extension service files based on current creator property settings
Declaration
public Task BeginAssetCreationProcess()
Returns
Type | Description |
---|---|
Task |
CanBuildAsset(UnityEngine.Object, String)
Returns true if the asset supplied, via Folder object representing path and file name string (assumming .cs files only), does not exist. False otherwise
Declaration
public bool CanBuildAsset(UnityEngine.Object folder, string fileName)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.Object | folder | |
String | fileName |
Returns
Type | Description |
---|---|
Boolean |
IsValidFolder(String)
Returns true if the folder path string supplied is a valid location in the Unity project, false otherwise
Declaration
public bool IsValidFolder(string folderPath)
Parameters
Type | Name | Description |
---|---|---|
String | folderPath |
Returns
Type | Description |
---|---|
Boolean |
IsValidFolder(UnityEngine.Object)
Returns true if the folder path supplied by Folder object is a valid location in the Unity project, false otherwise
Declaration
public bool IsValidFolder(UnityEngine.Object folder)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.Object | folder |
Returns
Type | Description |
---|---|
Boolean |
LoadStoredState()
Load creator state from unity SessionState
Declaration
public void LoadStoredState()
ResetState()
Reset current creator state to default and save
Declaration
public void ResetState()
SetAllFolders(String)
Declaration
public bool SetAllFolders(string path)
Parameters
Type | Name | Description |
---|---|---|
String | path |
Returns
Type | Description |
---|---|
Boolean |
StoreState()
Save current creator state to session registry in Unity
Declaration
public void StoreState()
ValidateAssets(List<String>)
Validate template assets
Declaration
public bool ValidateAssets(List<string> errors)
Parameters
Type | Name | Description |
---|---|---|
List<String> | errors |
Returns
Type | Description |
---|---|
Boolean | true if no errors encountered, false otherwise |
Remarks
Adds items to errors log field if not valid
ValidateName(List<String>)
Return true if configured Extension Service class name is valid. False otherwise
Declaration
public bool ValidateName(List<string> errors)
Parameters
Type | Name | Description |
---|---|---|
List<String> | errors |
Returns
Type | Description |
---|---|
Boolean |
Remarks
Adds items to errors log field if not valid
ValidateNamespace(List<String>)
Validate namespace property with each class/interface file to be created for new extension service
Declaration
public bool ValidateNamespace(List<string> errors)
Parameters
Type | Name | Description |
---|---|---|
List<String> | errors |
Returns
Type | Description |
---|---|
Boolean | true if no errors, false otherwise |
Remarks
Adds items to errors log field if not valid
ValidatePlatforms(List<String>)
Validate that SupportedPlatforms is not zero.
Declaration
public bool ValidatePlatforms(List<string> errors)
Parameters
Type | Name | Description |
---|---|---|
List<String> | errors |
Returns
Type | Description |
---|---|
Boolean |
Remarks
Adds items to errors log field if not valid