Meta Developers

OVRBoundary Class

Provides access to the Oculus boundary system.

See Also:

Overview

Public Types

enum	Node { Node.HandLeft = OVRPlugin.Node.HandLeft, Node.HandRight = OVRPlugin.Node.HandRight, Node.Head = OVRPlugin.Node.Head } Specifies a tracked node that can be queried through the boundary system.
enum	BoundaryType { BoundaryType.OuterBoundary = OVRPlugin.BoundaryType.OuterBoundary, BoundaryType.PlayArea = OVRPlugin.BoundaryType.PlayArea } Specifies a boundary type surface.

Public Member Functions

bool	GetConfigured ( ) Returns true if the boundary system is currently configured with valid boundary data.
OVRBoundary.BoundaryTestResult	TestNode ( OVRBoundary.Node node, OVRBoundary.BoundaryType boundaryType ) Returns the results of testing a tracked node against the specified boundary type.
OVRBoundary.BoundaryTestResult	TestPoint ( Vector3 point, OVRBoundary.BoundaryType boundaryType ) Returns the results of testing a 3d point against the specified boundary type.
Vector3[]	GetGeometry ( OVRBoundary.BoundaryType boundaryType ) Returns an array of 3d points (in clockwise order) that define the specified boundary type.
Vector3	GetDimensions ( OVRBoundary.BoundaryType boundaryType ) Returns a vector that indicates the spatial dimensions of the specified boundary type.
bool	GetVisible ( ) Returns true if the boundary system is currently visible.
void	SetVisible ( bool value ) Requests that the boundary system visibility be set to the specified value.

Details

Member Enumerations

enum OVRBoundary.Node

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

Enumerator

enum OVRBoundary.BoundaryType

Specifies a boundary type surface.

Enumerator

OuterBoundary	= OVRPlugin.BoundaryType.OuterBoundary
PlayArea	= OVRPlugin.BoundaryType.PlayArea

Member Functions

bool OVRBoundary.GetConfigured ( )
Returns true if the boundary system is currently configured with valid boundary data.

OVRBoundary.BoundaryTestResult OVRBoundary.TestNode ( OVRBoundary.Node node, OVRBoundary.BoundaryType 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.

OVRBoundary.BoundaryTestResult OVRBoundary.TestPoint ( Vector3 point, OVRBoundary.BoundaryType 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.

Vector3[] OVRBoundary.GetGeometry ( OVRBoundary.BoundaryType 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.

Vector3 OVRBoundary.GetDimensions ( OVRBoundary.BoundaryType boundaryType )
Returns a vector that indicates the spatial dimensions of the specified boundary type. (x = width, y = height, z = depth)

bool OVRBoundary.GetVisible ( )
Returns true if the boundary system is currently visible.

void OVRBoundary.SetVisible ( bool 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)

Did you find this page helpful?