API reference
API reference
Select your platform
No SDKs available
No versions available

OVRBoundary Class

Provides access to the Oculus boundary system.

Methods

GetConfigured ()
Returns true if the boundary system is currently configured with valid boundary data.
Signature 
bool OVRBoundary.GetConfigured()
Returns
bool
GetDimensions ( boundaryType )
Returns a vector that indicates the spatial dimensions of the specified boundary type.
(x = width, y = height, z = depth)
Signature 
Vector3 OVRBoundary.GetDimensions(OVRBoundary.BoundaryType boundaryType)
Parameters
boundaryType: OVRBoundary.BoundaryType
Returns
Vector3
GetGeometry ( boundaryType )
Returns an array of 3d points (in clockwise order) that define the specified boundary type.
All points are returned in local tracking space shared by tracked nodes and accessible through OVRCameraRig's trackingSpace anchor.
Signature 
Vector3[] OVRBoundary.GetGeometry(OVRBoundary.BoundaryType boundaryType)
Parameters
boundaryType: OVRBoundary.BoundaryType
Returns
Vector3[]
GetVisible ()
Returns true if the boundary system is currently visible.
Signature 
bool OVRBoundary.GetVisible()
Returns
bool
SetVisible ( value )
Requests that the boundary system visibility be set to the specified value.
The actual visibility can be overridden by the system (i.e., proximity trigger) or by the user (boundary system disabled)
Signature 
void OVRBoundary.SetVisible(bool value)
Parameters
value: bool
Returns
void
TestNode ( node , boundaryType )
Returns the results of testing a tracked node against the specified boundary type.
All points are returned in local tracking space shared by tracked nodes and accessible through OVRCameraRig's trackingSpace anchor.
Signature 
OVRBoundary.BoundaryTestResult OVRBoundary.TestNode(OVRBoundary.Node node, OVRBoundary.BoundaryType boundaryType)
Parameters
node: OVRBoundary.Node
boundaryType: OVRBoundary.BoundaryType
Returns
OVRBoundary.BoundaryTestResult
TestPoint ( point , boundaryType )
Returns the results of testing a 3d point against the specified boundary type.
The test point is expected in local tracking space. All points are returned in local tracking space shared by tracked nodes and accessible through OVRCameraRig's trackingSpace anchor.
Signature 
OVRBoundary.BoundaryTestResult OVRBoundary.TestPoint(Vector3 point, OVRBoundary.BoundaryType boundaryType)
Parameters
point: Vector3
boundaryType: OVRBoundary.BoundaryType
Returns
OVRBoundary.BoundaryTestResult

Inner Struct

BoundaryTestResult Struct

Provides test results of boundary system queries.

Fields

ClosestDistance : float
Signature 
float OVRBoundary.BoundaryTestResult.ClosestDistance
ClosestPoint : Vector3
Signature 
Vector3 OVRBoundary.BoundaryTestResult.ClosestPoint
ClosestPointNormal : Vector3
Signature 
Vector3 OVRBoundary.BoundaryTestResult.ClosestPointNormal
IsTriggering : bool
Signature 
bool OVRBoundary.BoundaryTestResult.IsTriggering

Inner Enums

Node Enum

Specifies a tracked node that can be queried through the boundary system.

Enumeration Constants

MemberValue
HandLeft
OVRPlugin.Node.HandLeft
HandRight
OVRPlugin.Node.HandRight
Head
OVRPlugin.Node.Head

BoundaryType Enum

Specifies a boundary type surface.

Enumeration Constants

MemberValue
OuterBoundary
OVRPlugin.BoundaryType.OuterBoundary
PlayArea
OVRPlugin.BoundaryType.PlayArea
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta