diff --git a/Definitions/README.md b/Definitions/README.md deleted file mode 100644 index e3a0e7e3e..000000000 --- a/Definitions/README.md +++ /dev/null @@ -1,84 +0,0 @@ -# Mixed Reality Toolkit - Internal - Definitions - -This folder contains all the MRTK Internal description definitions and enums. - -## Struct / Enum Definitions - -The list of definitions for Internal MRTK structures and enums are listed below. - -### BaseManager - -The BaseManager is the base class for all Mixed Reality Toolkit manager classes. -This minimises the use of MonoBehaviour's and provides a faster framework. - -### ButtonAction - -The ButtonAction defines the set of actions exposed by a controller. -Denoting the available buttons / interactions that a controller supports. - -### ButtonDefinition - -A Button Definition maps the capabilities of a selected controllers buttons, one definition should exist for each button profile. - -### Controller - -The Controller definition defines the Controller as defined by the SDK / Unity. - -### ControllerInputType - -The ControllerInputType identifies the type of button or input being sent to the framework from a controller. -This is mainly information only or for advanced users to understand the input coming directly from the controller. - -### ControllerState - -The Controller State defines whether a controller or headset is currently being tracker or not. -This enables developers to be able to handle non-tracked situations and react accordingly - -### Handedness - -The Handedness defines which hand a controller is currently operating in. -It is up to the developer to determine whether this affects the use of a controller or not. - -### Headset - -The headset definition defines the headset as defined by the SDK / Unity. - -### InputActions - -InputActions defines the set of actions consumed internally within the MRTK. -Denoting the available buttons / interactions that MRTK supports and exposed as events from the InputSystem. - -### MixedRealityConfigurationProfile - -The MixedRealityConfigurationProfile is a Scriptable Object definition for creating profiles for the Mixed Reality Toolkit. -This will instruct the toolkit how to operate and which managers to use within a project, centralizing all the configuration required for the project. - -### SDKType - -The SDKType lists the VR SDK's that are supported by the MRTK -Initially, this lists proposed SDK's, not all may be implemented at this time (please see ReleaseNotes for more details) - -## Relationships - -For specific constructs, the following information details the relationships between each component. - -### Controllers - -The controller definition relationships are defined as shown below: -![](/External/ReadMeImages/MRTK-ControllerDiagram.png) - -### Headsets - -The headset definition relationships are defined as shown below: -![](/External/ReadMeImages/MRTK-HeadsetDefinition.png) - -### Internal MRTK InputActions - -Input Actions are those internal mapped actions available to the MRTK. Each controller button would be dynamically mapped to an MRTK action for use in the SDK or output from the InputSystem. - -These are listed as follows: -![](/External/ReadMeImages/MRTK-InputActions.png) - -## Additional Information - -For additional information, please see the [MRTK vNext architecture outline](/MRTK-vNext.md) and the [vNext SDK Outline](/MRTK-SDK.md) \ No newline at end of file diff --git a/Definitions/README.md.meta b/Definitions/README.md.meta deleted file mode 100644 index 0d087cc9a..000000000 --- a/Definitions/README.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 66f8c39f5fe84c4f890edadc8f34a992 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/EventDatum/README.md b/EventDatum/README.md deleted file mode 100644 index 9ff6a2d13..000000000 --- a/EventDatum/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Mixed Reality Toolkit - EventDatum - -Data model classes for the inner workings of the Mixed Reality Toolkit and it's supported Core systems. - -All data models required for system use within the MRTK should be recorded here. \ No newline at end of file diff --git a/EventDatum/README.md.meta b/EventDatum/README.md.meta deleted file mode 100644 index 51cd8f8cd..000000000 --- a/EventDatum/README.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 1b14141a40ca455b8e4ab6a6f4e3a9cc -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Interfaces/README.md b/Interfaces/README.md deleted file mode 100644 index 64d38582d..000000000 --- a/Interfaces/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Mixed Reality Toolkit - Internal - Interfaces - -This folder contains all the Interface definitions for MRTK operation - -## Interface Definitions - -The list of definitions for Internal MRTK Interfaces are listed below. - -### IMixedRealityManager - -The IManager interface ensures that all Manager components comply with the requirements of all Mixed Reality Toolkit managers. - -### IMixedRealityBoundarySystem - -The IMixedRealityBoundarySystem interface is the base interface to identify a component as an Boundary System Manager. This is used to register an Boundary system in the Mixed Reality Toolkit, any replacement Boundary Systems should inherit from this interface for registration. - -### IMixedRealityInputSystem - -The IMixedRealityBoundarySystem interface is the base interface to identify a component as an Input System Manager. This is used to register an Input system in the Mixed Reality Toolkit, any replacement Input Systems should inherit from this interface for registration. \ No newline at end of file diff --git a/Interfaces/README.md.meta b/Interfaces/README.md.meta deleted file mode 100644 index 7c3c34abb..000000000 --- a/Interfaces/README.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 8035bfe5925c4af38dfca2343649d847 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: