Provides access to the Oculus boundary system. More...

Classes
struct	BoundaryTestResult
	Provides test results of boundary system queries. More...

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. More...

enum	BoundaryType { BoundaryType.OuterBoundary = OVRPlugin.BoundaryType.OuterBoundary, BoundaryType.PlayArea = OVRPlugin.BoundaryType.PlayArea }
	Specifies a boundary type surface. More...

Public Member Functions
bool	GetConfigured ()
	Returns true if the boundary system is currently configured with valid boundary data. More...

OVRBoundary.BoundaryTestResult	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. More...

OVRBoundary.BoundaryTestResult	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. More...

Vector3 []	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. More...

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

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

void	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) More...

Detailed Description

Provides access to the Oculus boundary system.

Member Enumeration Documentation

◆ BoundaryType

enum OVRBoundary.BoundaryType

strong

Specifies a boundary type surface.

Enumerator
OuterBoundary	Outer boundary that closely matches the user's configured walls.
PlayArea	Smaller convex area inset within the outer boundary.

◆ Node

enum OVRBoundary.Node

strong

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

Enumerator
HandLeft	Tracks the left hand node.
HandRight	Tracks the right hand node.
Head	Tracks the head node.

Member Function Documentation

◆ GetConfigured()

bool OVRBoundary.GetConfigured ( )

Returns true if the boundary system is currently configured with valid boundary data.

◆ GetDimensions()

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)

◆ GetGeometry()

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.

◆ GetVisible()

bool OVRBoundary.GetVisible ( )

Returns true if the boundary system is currently visible.

◆ SetVisible()

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)

◆ TestNode()

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.

◆ TestPoint()

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.

The documentation for this class was generated from the following file:

Oculus/VR/Scripts/OVRBoundary.cs

Classes

Public Types

Public Member Functions