MixedRealityToolkitFiles Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Utilities.Editor

Assembly:: Microsoft.MixedReality.Toolkit.Editor.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

API for working with MixedRealityToolkit folders contained in the project.

public ref class MixedRealityToolkitFiles abstract sealed

public static class MixedRealityToolkitFiles

type MixedRealityToolkitFiles = class

Public Class MixedRealityToolkitFiles

Inheritance: Object
MixedRealityToolkitFiles

Remarks

This class works by looking for sentinel files (following the pattern MRTK.*.sentinel, for example, MRTK.Core.sentinel) in order to identify where the MRTK is located within the project.

Properties

AreFoldersAvailable	Are any of the MRTK directories available?
GetGeneratedFolder	Creates the MixedRealityToolkit.Generated folder if it does not exist and returns the path to the generated folder.
MRTKDirectories	Returns a collection of MRTK Core directories found in the project.

Methods

GetAssetDatabasePath(String)	Maps an absolute path to be relative to the Project Root path (the Unity folder that contains Assets)
GetDirectories(MixedRealityToolkitModuleType)	Get list of discovered directories for provided module type
GetFiles(MixedRealityToolkitModuleType, String)	Returns files from all folder instances of the MRTK folder relative path.
GetFiles(String)	Returns files from all folder instances of the core MRTK folder relative path.
GetModuleFromPackageFolder(String)	Finds the module type, if found, from the specified package folder name.
MapModulePath(MixedRealityToolkitModuleType)	Get the relative asset folder path to the provided Module type
MapRelativeFilePath(MixedRealityToolkitModuleType, String)	Maps a single relative path file to a concrete path from one of the MRTK folders, if found. Otherwise returns null.
MapRelativeFilePath(String)	Maps a single relative path file to a concrete path from one of the core MRTK folders, if found. Otherwise returns null.
MapRelativeFilePathToAbsolutePath(MixedRealityToolkitModuleType, String)	Overload of MapRelativeFilePathToAbsolutePath which provides the ability to specify the module that the file belongs to.
MapRelativeFilePathToAbsolutePath(String)	Maps a single relative path file to MRTK folders to its absolute path, if found. Otherwise returns null.
MapRelativeFolderPathToAbsolutePath(MixedRealityToolkitModuleType, String)	Similar to MapRelativeFilePathToAbsolutePath, except this checks for the existence of a folder instead of file.
RefreshFolders()	Force refresh of MRTK tracked folders. Fires and forgets async call. Returns immediately
WaitForFolderRefresh()	Get task tracking folder refresh if component wants to wait for files to be ready

Applies to