|
|
- // Fallback Headset|SDK_Fallback|002
- namespace VRTK
- {
- using UnityEngine;
- using System.Collections.Generic;
-
- /// <summary>
- /// The Fallback Headset SDK script provides a fallback collection of methods that return null or default headset values.
- /// </summary>
- /// <remarks>
- /// This is the fallback class that will just return default values.
- /// </remarks>
- [SDK_Description(typeof(SDK_FallbackSystem))]
- public class SDK_FallbackHeadset : SDK_BaseHeadset
- {
- /// <summary>
- /// The ProcessUpdate method enables an SDK to run logic for every Unity Update
- /// </summary>
- /// <param name="options">A dictionary of generic options that can be used to within the update.</param>
- public override void ProcessUpdate(Dictionary<string, object> options)
- {
- }
-
- /// <summary>
- /// The ProcessFixedUpdate method enables an SDK to run logic for every Unity FixedUpdate
- /// </summary>
- /// <param name="options">A dictionary of generic options that can be used to within the fixed update.</param>
- public override void ProcessFixedUpdate(Dictionary<string, object> options)
- {
- }
-
- /// <summary>
- /// The GetHeadset method returns the Transform of the object that is used to represent the headset in the scene.
- /// </summary>
- /// <returns>A transform of the object representing the headset in the scene.</returns>
- public override Transform GetHeadset()
- {
- return null;
- }
-
- /// <summary>
- /// The GetHeadsetCamera method returns the Transform of the object that is used to hold the headset camera in the scene.
- /// </summary>
- /// <returns>A transform of the object holding the headset camera in the scene.</returns>
- public override Transform GetHeadsetCamera()
- {
- return null;
- }
-
- /// <summary>
- /// The GetHeadsetType method returns a string representing the type of headset connected.
- /// </summary>
- /// <returns>The string of the headset connected.</returns>
- public override string GetHeadsetType()
- {
- return CleanPropertyString("");
- }
-
- /// <summary>
- /// The GetHeadsetVelocity method is used to determine the current velocity of the headset.
- /// </summary>
- /// <returns>A Vector3 containing the current velocity of the headset.</returns>
- public override Vector3 GetHeadsetVelocity()
- {
- return Vector3.zero;
- }
-
- /// <summary>
- /// The GetHeadsetAngularVelocity method is used to determine the current angular velocity of the headset.
- /// </summary>
- /// <returns>A Vector3 containing the current angular velocity of the headset.</returns>
- public override Vector3 GetHeadsetAngularVelocity()
- {
- return Vector3.zero;
- }
-
- /// <summary>
- /// The HeadsetFade method is used to apply a fade to the headset camera to progressively change the colour.
- /// </summary>
- /// <param name="color">The colour to fade to.</param>
- /// <param name="duration">The amount of time the fade should take to reach the given colour.</param>
- /// <param name="fadeOverlay">Determines whether to use an overlay on the fade.</param>
- public override void HeadsetFade(Color color, float duration, bool fadeOverlay = false)
- {
- }
-
- /// <summary>
- /// The HasHeadsetFade method checks to see if the given game object (usually the camera) has the ability to fade the viewpoint.
- /// </summary>
- /// <param name="obj">The Transform to check to see if a camera fade is available on.</param>
- /// <returns>Returns true if the headset has fade functionality on it.</returns>
- public override bool HasHeadsetFade(Transform obj)
- {
- return false;
- }
-
- /// <summary>
- /// The AddHeadsetFade method attempts to add the fade functionality to the game object with the camera on it.
- /// </summary>
- /// <param name="camera">The Transform to with the camera on to add the fade functionality to.</param>
- public override void AddHeadsetFade(Transform camera)
- {
- }
- }
- }
|