Assignment for RMIT Mixed Reality in 2020
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

74 lines
2.8 KiB

  1. // Fallback Boundaries|SDK_Fallback|004
  2. namespace VRTK
  3. {
  4. using UnityEngine;
  5. /// <summary>
  6. /// The Fallback Boundaries SDK script provides a fallback collection of methods that return null or default headset values.
  7. /// </summary>
  8. /// <remarks>
  9. /// This is the fallback class that will just return default values.
  10. /// </remarks>
  11. [SDK_Description(typeof(SDK_FallbackSystem))]
  12. public class SDK_FallbackBoundaries : SDK_BaseBoundaries
  13. {
  14. /// <summary>
  15. /// The InitBoundaries method is run on start of scene and can be used to initialse anything on game start.
  16. /// </summary>
  17. public override void InitBoundaries()
  18. {
  19. }
  20. /// <summary>
  21. /// The GetPlayArea method returns the Transform of the object that is used to represent the play area in the scene.
  22. /// </summary>
  23. /// <returns>A transform of the object representing the play area in the scene.</returns>
  24. public override Transform GetPlayArea()
  25. {
  26. return null;
  27. }
  28. /// <summary>
  29. /// The GetPlayAreaVertices method returns the points of the play area boundaries.
  30. /// </summary>
  31. /// <returns>A Vector3 array of the points in the scene that represent the play area boundaries.</returns>
  32. public override Vector3[] GetPlayAreaVertices()
  33. {
  34. return null;
  35. }
  36. /// <summary>
  37. /// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
  38. /// </summary>
  39. /// <returns>The thickness of the drawn border.</returns>
  40. public override float GetPlayAreaBorderThickness()
  41. {
  42. return 0f;
  43. }
  44. /// <summary>
  45. /// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
  46. /// </summary>
  47. /// <returns>Returns true if the play area size has been auto calibrated and set by external sensors.</returns>
  48. public override bool IsPlayAreaSizeCalibrated()
  49. {
  50. return false;
  51. }
  52. /// <summary>
  53. /// The GetDrawAtRuntime method returns whether the given play area drawn border is being displayed.
  54. /// </summary>
  55. /// <returns>Returns true if the drawn border is being displayed.</returns>
  56. public override bool GetDrawAtRuntime()
  57. {
  58. return false;
  59. }
  60. /// <summary>
  61. /// The SetDrawAtRuntime method sets whether the given play area drawn border should be displayed at runtime.
  62. /// </summary>
  63. /// <param name="value">The state of whether the drawn border should be displayed or not.</param>
  64. public override void SetDrawAtRuntime(bool value)
  65. {
  66. }
  67. }
  68. }