Guides
Guides
These docs are for v3.1.0. Click to read the latest docs for v3.3.0.

VRTK_SDKManager

Overview

The SDK Manager script provides configuration of supported SDKs

Inspector Parameters

  • Persist On Load: If this is true then the instance of the SDK Manager won't be destroyed on every scene load.
  • System SDK: The SDK to use to deal with all system actions.
  • Boundaries SDK: The SDK to use to utilise room scale boundaries.
  • Headset SDK: The SDK to use to utilise the VR headset.
  • Controller SDK: The SDK to use to utilise the input devices.
  • Auto Manage Script Defines: This determines whether the scripting define symbols required by the selected SDKs are automatically added to the player settings when using the SDK Manager inspector window.
  • Actual Boundaries: A reference to the GameObject that is the user's boundary or play area, most likely provided by the SDK's Camera Rig.
  • Actual Headset: A reference to the GameObject that contains the VR camera, most likely provided by the SDK's Camera Rig Headset.
  • Actual Left Controller: A reference to the GameObject that contains the SDK Left Hand Controller.
  • Actual Right Controller: A reference to the GameObject that contains the SDK Right Hand Controller.
  • Model Alias Left Controller: A reference to the GameObject that models for the Left Hand Controller.
  • Model Alias Right Controller: A reference to the GameObject that models for the Right Hand Controller
  • Script Alias Left Controller: A reference to the GameObject that contains any scripts that apply to the Left Hand Controller.
  • Script Alias Right Controller: A reference to the GameObject that contains any scripts that apply to the Right Hand Controller.

Class Variables

  • public enum SupportedSDKs - The supported SDKs
  • public static VRTK_SDKManager instance - The singleton instance to access the SDK Manager variables from. Default: null

Class Methods

GetSystemSDK/0

public SDK_BaseSystem GetSystemSDK()

  • Parameters
  • none
  • Returns
  • SDK_BaseSystem - The currently selected System SDK

The GetSystemSDK method returns the selected system SDK

GetHeadsetSDK/0

public SDK_BaseHeadset GetHeadsetSDK()

  • Parameters
  • none
  • Returns
  • SDK_BaseHeadset - The currently selected Headset SDK

The GetHeadsetSDK method returns the selected headset SDK

GetControllerSDK/0

public SDK_BaseController GetControllerSDK()

  • Parameters
  • none
  • Returns
  • SDK_BaseController - The currently selected Controller SDK

The GetControllerSDK method returns the selected controller SDK

GetBoundariesSDK/0

public SDK_BaseBoundaries GetBoundariesSDK()

  • Parameters
  • none
  • Returns
  • SDK_BaseBoundaries - The currently selected Boundaries SDK

The GetBoundariesSDK method returns the selected boundaries SDK