SDK_BaseBoundaries

extends SDK_Base

Overview

The Base Boundaries SDK script provides a bridge to SDK methods that deal with the play area of SDKs that support room scale play spaces.

This is an abstract class to implement the interface required by all implemented SDKs.

Class Methods

InitBoundaries/0

public abstract void InitBoundaries();

• Parameters
  • none
• Returns
  • none

The InitBoundaries method is run on start of scene and can be used to initialse anything on game start.

GetPlayArea/0

public abstract Transform GetPlayArea();

• Parameters
  • none
• Returns
  • Transform - A transform of the object representing the play area in the scene.

The GetPlayArea method returns the Transform of the object that is used to represent the play area in the scene.

GetPlayAreaVertices/0

public abstract Vector3[] GetPlayAreaVertices();

• Parameters
  • none
• Returns
  • Vector3[] - A Vector3 array of the points in the scene that represent the play area boundaries.

The GetPlayAreaVertices method returns the points of the play area boundaries.

GetPlayAreaBorderThickness/0

public abstract float GetPlayAreaBorderThickness();

• Parameters
  • none
• Returns
  • float - The thickness of the drawn border.

The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.

IsPlayAreaSizeCalibrated/0

public abstract bool IsPlayAreaSizeCalibrated();

• Parameters
  • none
• Returns
  • bool - Returns true if the play area size has been auto calibrated and set by external sensors.

The IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.

GetDrawAtRuntime/0

public abstract bool GetDrawAtRuntime();

• Parameters
  • none
• Returns
  • bool - Returns true if the drawn border is being displayed.

The GetDrawAtRuntime method returns whether the given play area drawn border is being displayed.

SetDrawAtRuntime/1

public abstract void SetDrawAtRuntime(bool value);

• Parameters
  • bool value - The state of whether the drawn border should be displayed or not.
• Returns
  • none

The SetDrawAtRuntime method sets whether the given play area drawn border should be displayed at runtime.