// Ximmerse Boundaries|SDK_Ximmerse|005
namespace VRTK
{
#if VRTK_DEFINE_SDK_XIMMERSE
using UnityEngine;
using Ximmerse.VR;
#endif
///
/// The Ximmerse Boundaries SDK script provides a bridge to the Ximmerse SDK play area.
///
[SDK_Description(typeof(SDK_XimmerseSystem))]
[SDK_Description(typeof(SDK_XimmerseSystem), 1)]
public class SDK_XimmerseBoundaries
#if VRTK_DEFINE_SDK_XIMMERSE
: SDK_BaseBoundaries
#else
: SDK_FallbackBoundaries
#endif
{
#if VRTK_DEFINE_SDK_XIMMERSE
///
/// The InitBoundaries method is run on start of scene and can be used to initialse anything on game start.
///
public override void InitBoundaries()
{
}
///
/// 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)
{
VRContext vrContext = VRTK_SharedMethods.FindEvenInactiveComponent(true);
if (Application.isPlaying)
{
vrContext.InitVRContext();
}
cachedPlayArea = vrContext.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()
{
var area = GetPlayArea().GetComponentInChildren();
if (area)
{
return area.corners;
}
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()
{
var area = GetPlayArea().GetComponentInChildren();
if (area)
{
return area.borderThickness;
}
return 0f;
}
///
/// 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)
{
}
#endif
}
}