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

ReferenceSpace

ReferenceSpace

enum ReferenceSpace : Enum<ReferenceSpace>
Reference spaces determine how positions and orientations are interpreted relative to the user and physical environment. Each space has different behavior when the user recenters their view or moves around in the physical world.
Example: Setting ReferenceSpace to LOCAL_FLOOR to enable recentering:
scene.setReferenceSpace(ReferenceSpace.LOCAL_FLOOR)

Entries

NameSummary
UNKNOWN

Represents invalid reference space. Do not use.
VIEW

Space that is relative to the view (headset).
LOCAL

Space that is relative to an arbitrary origin.
STAGE

World space that remains fixed regardless of user movement.
LOCAL_FLOOR

Similar to LOCAL but takes into account the user’s height.

Properties

NameSummary
name
val name: String
ordinal
val ordinal: Int
space
val space: Int

Integer value corresponding to the native reference space type

Functions

NameSummary
valueOf
fun valueOf(value: String): ReferenceSpace

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
values
fun values(): Array<ReferenceSpace>

Returns an array containing the constants of this enum type, in the order they’re declared.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon