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.

49 lines
1.7 KiB

  1. // SDK Base|SDK_Base|001
  2. namespace VRTK
  3. {
  4. using UnityEngine;
  5. /// <summary>
  6. /// Abstract superclass that defines that a particular class is an SDK.
  7. /// </summary>
  8. /// <remarks>
  9. /// This is an abstract class to mark all different SDK endpoints with. This is used to allow for type safety when talking about 'an SDK' instead of one of the different endpoints (System, Boundaries, Headset, Controller).
  10. /// </remarks>
  11. public abstract class SDK_Base : ScriptableObject
  12. {
  13. /// <summary>
  14. /// This method is called just before loading the VRTK_SDKSetup that's using this SDK.
  15. /// </summary>
  16. /// <param name="setup">The SDK Setup which is using this SDK.</param>
  17. public virtual void OnBeforeSetupLoad(VRTK_SDKSetup setup)
  18. {
  19. }
  20. /// <summary>
  21. /// This method is called just after loading the VRTK_SDKSetup that's using this SDK.
  22. /// </summary>
  23. /// <param name="setup">The SDK Setup which is using this SDK.</param>
  24. public virtual void OnAfterSetupLoad(VRTK_SDKSetup setup)
  25. {
  26. }
  27. /// <summary>
  28. /// This method is called just before unloading the VRTK_SDKSetup that's using this SDK.
  29. /// </summary>
  30. /// <param name="setup">The SDK Setup which is using this SDK.</param>
  31. public virtual void OnBeforeSetupUnload(VRTK_SDKSetup setup)
  32. {
  33. }
  34. /// <summary>
  35. /// This method is called just after unloading the VRTK_SDKSetup that's using this SDK.
  36. /// </summary>
  37. /// <param name="setup">The SDK Setup which is using this SDK.</param>
  38. public virtual void OnAfterSetupUnload(VRTK_SDKSetup setup)
  39. {
  40. }
  41. }
  42. }