From 96b707215dea18bce739c60f3486cceade4c4f4f Mon Sep 17 00:00:00 2001 From: Bastiaan Olij Date: Sun, 27 Jun 2021 21:51:30 +1000 Subject: Add support for returning the play area from XRInterface --- doc/classes/XRInterface.xml | 46 ++++++++++++++++++++++++++++++++++++ doc/classes/XRInterfaceExtension.xml | 27 +++++++++++++++++++++ 2 files changed, 73 insertions(+) (limited to 'doc/classes') diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 27713498ee..7ae70f97a2 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -29,6 +29,12 @@ Returns the name of this interface (OpenXR, OpenVR, OpenHMD, ARKit, etc). + + + + Returns an array of vectors that denotes the physical play area mapped to the virtual space around the [XROrigin3D] point. The points form a convex polygon that can be used to react to or visualise the play area. This returns an empty array if this feature is not supported or if the information is not yet available. + + @@ -63,6 +69,20 @@ Is [code]true[/code] if this interface has been initialised. + + + + + Sets the active play area mode, will return [code]false[/code] if the mode can't be used with this interface. + + + + + + + Call this to find out if a given play area mode is supported by this interface. + + @@ -91,7 +111,18 @@ [code]true[/code] if this is the primary interface. + + The play area mode for this interface. + + + + + + Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation. + + + No XR capabilities. @@ -129,5 +160,20 @@ Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.). + + Play area mode not set or not available. + + + Play area only supports orientation tracking, no positional tracking, area will center around player. + + + Player is in seated position, limited positional tracking, fixed guardian around player. + + + Player is free to move around, full positional tracking. + + + Same as roomscale but origin point is fixed to the center of the physical space, XRServer.center_on_hmd disabled. + diff --git a/doc/classes/XRInterfaceExtension.xml b/doc/classes/XRInterfaceExtension.xml index 4328488ced..3b5d8e2f10 100644 --- a/doc/classes/XRInterfaceExtension.xml +++ b/doc/classes/XRInterfaceExtension.xml @@ -41,6 +41,16 @@ + + + + + + + + + + @@ -71,6 +81,11 @@ + + + + + @@ -110,6 +125,18 @@ + + + + + + + + + + + + -- cgit v1.2.3