{"__v":0,"_id":"58796781cd4a9c37007c971a","category":{"version":"58796781cd4a9c37007c96ef","project":"571fa55ca0acd42000af9545","_id":"58796781cd4a9c37007c9700","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-01T19:39:03.051Z","from_sync":false,"order":18,"slug":"oculusvr-sdk","title":"OculusVR SDK"},"parentDoc":null,"project":"571fa55ca0acd42000af9545","user":"571fa519db52d01700f5cf3d","version":{"__v":4,"_id":"58796781cd4a9c37007c96ef","project":"571fa55ca0acd42000af9545","createdAt":"2017-01-13T23:49:21.393Z","releaseDate":"2017-01-13T23:49:21.393Z","categories":["58796781cd4a9c37007c96f0","58796781cd4a9c37007c96f1","58796781cd4a9c37007c96f2","58796781cd4a9c37007c96f3","58796781cd4a9c37007c96f4","58796781cd4a9c37007c96f5","58796781cd4a9c37007c96f6","58796781cd4a9c37007c96f7","58796781cd4a9c37007c96f8","58796781cd4a9c37007c96f9","58796781cd4a9c37007c96fa","58796781cd4a9c37007c96fb","58796781cd4a9c37007c96fc","58796781cd4a9c37007c96fd","58796781cd4a9c37007c96fe","58796781cd4a9c37007c96ff","58796781cd4a9c37007c9700","58b157ca1756cf370022f90d","58b1596f5dae732f00adeca2","58b1605a5dae732f00adecb1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Mukota","version_clean":"3.1.0","version":"3.1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-01T19:40:19.851Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"> extends [SDK_BaseBoundaries](doc:sdk_baseboundaries)\n\n## Overview\n\nThe OculusVR Boundaries SDK script provides a bridge to the OculusVR SDK play area.\n\n## Class Methods\n\n### InitBoundaries/0\n\n  > `public override void InitBoundaries()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * _none_\n\nThe InitBoundaries method is run on start of scene and can be used to initialse anything on game start.\n\n### GetPlayArea/0\n\n  > `public override Transform GetPlayArea()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * `Transform` - A transform of the object representing the play area in the scene.\n\nThe GetPlayArea method returns the Transform of the object that is used to represent the play area in the scene.\n\n### GetPlayAreaVertices/1\n\n  > `public override Vector3[] GetPlayAreaVertices(GameObject playArea)`\n\n  * Parameters\n   * `GameObject playArea` - The GameObject containing the play area representation.\n  * Returns\n   * `Vector3[]` - A Vector3 array of the points in the scene that represent the play area boundaries.\n\nThe GetPlayAreaVertices method returns the points of the play area boundaries.\n\n### GetPlayAreaBorderThickness/1\n\n  > `public override float GetPlayAreaBorderThickness(GameObject playArea)`\n\n  * Parameters\n   * `GameObject playArea` - The GameObject containing the play area representation.\n  * Returns\n   * `float` - The thickness of the drawn border.\n\nThe GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area.\n\n### IsPlayAreaSizeCalibrated/1\n\n  > `public override bool IsPlayAreaSizeCalibrated(GameObject playArea)`\n\n  * Parameters\n   * `GameObject playArea` - The GameObject containing the play area representation.\n  * Returns\n   * `bool` - Returns true if the play area size has been auto calibrated and set by external sensors.\n\nThe IsPlayAreaSizeCalibrated method returns whether the given play area size has been auto calibrated by external sensors.\n\n### GetAvatar/0\n\n  > `public virtual OvrAvatar GetAvatar()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * `OvrAvatar` - The OvrAvatar script for managing the Oculus Avatar.\n\nThe 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.","excerpt":"","slug":"sdk_oculusvrboundaries","type":"basic","title":"SDK_OculusVRBoundaries"}

SDK_OculusVRBoundaries


> extends [SDK_BaseBoundaries](doc:sdk_baseboundaries) ## Overview The OculusVR Boundaries SDK script provides a bridge to the OculusVR SDK play area. ## Class Methods ### InitBoundaries/0 > `public override 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 override 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/1 > `public override Vector3[] GetPlayAreaVertices(GameObject playArea)` * Parameters * `GameObject playArea` - The GameObject containing the play area representation. * 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/1 > `public override float GetPlayAreaBorderThickness(GameObject playArea)` * Parameters * `GameObject playArea` - The GameObject containing the play area representation. * Returns * `float` - The thickness of the drawn border. The GetPlayAreaBorderThickness returns the thickness of the drawn border for the given play area. ### IsPlayAreaSizeCalibrated/1 > `public override bool IsPlayAreaSizeCalibrated(GameObject playArea)` * Parameters * `GameObject playArea` - The GameObject containing the play area representation. * 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. ### GetAvatar/0 > `public virtual OvrAvatar GetAvatar()` * Parameters * _none_ * Returns * `OvrAvatar` - The OvrAvatar script for managing the Oculus Avatar. 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.