// Oculus Boundaries|SDK_Oculus|005
namespace VRTK
{
#if VRTK_DEFINE_SDK_OCULUS
using UnityEngine;
#endif
///
/// The Oculus Boundaries SDK script provides a bridge to the Oculus SDK play area.
///
[SDK_Description(typeof(SDK_OculusSystem))]
[SDK_Description(typeof(SDK_OculusSystem), 1)]
public class SDK_OculusBoundaries
#if VRTK_DEFINE_SDK_OCULUS
: SDK_BaseBoundaries
#else
: SDK_FallbackBoundaries
#endif
{
#if VRTK_DEFINE_SDK_OCULUS
///
/// The InitBoundaries method is run on start of scene and can be used to initialse anything on game start.
///
public override void InitBoundaries()
{
#if VRTK_DEFINE_SDK_OCULUS_AVATAR
GetAvatar();
#endif
}
///
/// The GetPlayArea method returns the Transform of the object that is used to represent the play area in the scene.
///
/// A transform of the object representing the play area in the scene.
public override Transform GetPlayArea()
{
cachedPlayArea = GetSDKManagerPlayArea();
if (cachedPlayArea == null)
{
OVRManager ovrManager = VRTK_SharedMethods.FindEvenInactiveComponent(true);
if (ovrManager != null)
{
cachedPlayArea = ovrManager.transform;
}
}
return cachedPlayArea;
}
///
/// The GetPlayAreaVertices method returns the points of the play area boundaries.
///
/// A Vector3 array of the points in the scene that represent the play area boundaries.
public override Vector3[] GetPlayAreaVertices()
{
OVRBoundary area = new OVRBoundary();
if (area.GetConfigured())
{
Vector3 outerBoundary = area.GetDimensions(OVRBoundary.BoundaryType.OuterBoundary);
float thickness = 0.1f;
Vector3[] vertices = new Vector3[8];
vertices[0] = new Vector3(outerBoundary.x - thickness, 0f, outerBoundary.z - thickness);
vertices[1] = new Vector3(0f + thickness, 0f, outerBoundary.z - thickness);
vertices[2] = new Vector3(0f + thickness, 0f, 0f + thickness);
vertices[3] = new Vector3(outerBoundary.x - thickness, 0f, 0f + thickness);
vertices[4] = new Vector3(outerBoundary.x, 0f, outerBoundary.z);
vertices[5] = new Vector3(0f, 0f, outerBoundary.z);
vertices[6] = new Vector3(0f, 0f, 0f);
vertices[7] = new Vector3(outerBoundary.x, 0f, 0f);
return vertices;
}
return null;
}
///
/// The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.
///
/// The thickness of the drawn border.
public override float GetPlayAreaBorderThickness()
{
return 0.1f;
}
///
/// The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.
///
/// Returns true if the play area size has been auto calibrated and set by external sensors.
public override bool IsPlayAreaSizeCalibrated()
{
return true;
}
///
/// The GetDrawAtRuntime method returns whether the given play area drawn border is being displayed.
///
/// Returns true if the drawn border is being displayed.
public override bool GetDrawAtRuntime()
{
return false;
}
///
/// The SetDrawAtRuntime method sets whether the given play area drawn border should be displayed at runtime.
///
/// The state of whether the drawn border should be displayed or not.
public override void SetDrawAtRuntime(bool value)
{
}
#if VRTK_DEFINE_SDK_OCULUS_AVATAR
private OvrAvatar avatarContainer;
///
/// The GetAvatar method is used to retrieve the Oculus Avatar object if it exists in the scene. This method is only available if the Oculus Avatar package is installed.
///
/// The OvrAvatar script for managing the Oculus Avatar.
public virtual OvrAvatar GetAvatar()
{
if (avatarContainer == null)
{
avatarContainer = VRTK_SharedMethods.FindEvenInactiveComponent(true);
if (avatarContainer != null && avatarContainer.GetComponent() == null)
{
VRTK_TransformFollow objectFollow = avatarContainer.gameObject.AddComponent();
objectFollow.gameObjectToFollow = GetPlayArea().gameObject;
}
}
return avatarContainer;
}
#endif
#endif
}
}