Package org.lwjgl.openxr

Class MLSpatialAnchors

java.lang.Object

org.lwjgl.openxr.MLSpatialAnchors

public class MLSpatialAnchors
extends Object

The XR_ML_spatial_anchors extension.

Spatial anchors are XrSpace entities tied to a physical location. This allows the developer to place virtual content in real world locations.

The runtime should then adjust the XrSpace over time as needed, independently of all other spaces and anchors, to ensure that it maintains its original mapping to the real world.

Caution

If head pose is lost and regained, spatial anchors may also be lost. It is therefore strongly recommended that once an anchor is created, it is also persisted using the XR_ML_spatial_anchors_storage extension.

Permissions

Android applications must have the com.magicleap.permission.SPATIAL_ANCHOR permission listed in their manifest to use this extension. (protection level: normal)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML	Extends XrResult.
static final int	XR_ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML	Extends XrResult.
static final int	XR_ERROR_SPATIAL_ANCHORS_PERMISSION_DENIED_ML	Extends XrResult.
static final int	XR_ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML	Extends XrResult.
static final String	XR_ML_SPATIAL_ANCHORS_EXTENSION_NAME	The extension name.
static final int	XR_ML_spatial_anchors_SPEC_VERSION	The extension specification version.
static final int	XR_SPATIAL_ANCHOR_CONFIDENCE_HIGH_ML	XrSpatialAnchorConfidenceML - Spatial anchor confidence
static final int	XR_SPATIAL_ANCHOR_CONFIDENCE_LOW_ML	XrSpatialAnchorConfidenceML - Spatial anchor confidence
static final int	XR_SPATIAL_ANCHOR_CONFIDENCE_MEDIUM_ML	XrSpatialAnchorConfidenceML - Spatial anchor confidence
static final int	XR_TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML	Extends XrStructureType.
static final int	XR_TYPE_SPATIAL_ANCHOR_STATE_ML	Extends XrStructureType.
static final int	XR_TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_POSE_ML	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateSpatialAnchorsAsyncML(XrSession session, long createInfo, long future)	Unsafe version of: CreateSpatialAnchorsAsyncML
static int	nxrCreateSpatialAnchorsCompleteML(XrSession session, long future, long completion)	Unsafe version of: CreateSpatialAnchorsCompleteML
static int	nxrGetSpatialAnchorStateML(XrSpace anchor, long state)	Unsafe version of: GetSpatialAnchorStateML
static int	xrCreateSpatialAnchorsAsyncML(XrSession session, XrSpatialAnchorsCreateInfoBaseHeaderML createInfo, LongBuffer future)	Create spatial anchors.
static int	xrCreateSpatialAnchorsCompleteML(XrSession session, long future, XrCreateSpatialAnchorsCompletionML completion)	Completion function for spatial anchor creation.
static int	xrGetSpatialAnchorStateML(XrSpace anchor, XrSpatialAnchorStateML state)	Retrieve spatial anchor state.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_ML_spatial_anchors_SPEC_VERSION

public static final int XR_ML_spatial_anchors_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_ML_SPATIAL_ANCHORS_EXTENSION_NAME

public static final String XR_ML_SPATIAL_ANCHORS_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_POSE_ML

public static final int XR_TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_POSE_ML

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_POSE_ML
• TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML
• TYPE_SPATIAL_ANCHOR_STATE_ML

See Also:

• Constant Field Values

XR_TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML

public static final int XR_TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_POSE_ML
• TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML
• TYPE_SPATIAL_ANCHOR_STATE_ML

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_ANCHOR_STATE_ML

public static final int XR_TYPE_SPATIAL_ANCHOR_STATE_ML

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_ANCHORS_CREATE_INFO_FROM_POSE_ML
• TYPE_CREATE_SPATIAL_ANCHORS_COMPLETION_ML
• TYPE_SPATIAL_ANCHOR_STATE_ML

See Also:

• Constant Field Values

XR_ERROR_SPATIAL_ANCHORS_PERMISSION_DENIED_ML

public static final int XR_ERROR_SPATIAL_ANCHORS_PERMISSION_DENIED_ML

Extends XrResult.

Enum values:

• ERROR_SPATIAL_ANCHORS_PERMISSION_DENIED_ML
• ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML
• ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML
• ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML

See Also:

• Constant Field Values

XR_ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML

public static final int XR_ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML

Extends XrResult.

Enum values:

• ERROR_SPATIAL_ANCHORS_PERMISSION_DENIED_ML
• ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML
• ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML
• ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML

See Also:

• Constant Field Values

XR_ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML

public static final int XR_ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML

Extends XrResult.

Enum values:

• ERROR_SPATIAL_ANCHORS_PERMISSION_DENIED_ML
• ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML
• ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML
• ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML

See Also:

• Constant Field Values

XR_ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML

public static final int XR_ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML

Extends XrResult.

Enum values:

• ERROR_SPATIAL_ANCHORS_PERMISSION_DENIED_ML
• ERROR_SPATIAL_ANCHORS_NOT_LOCALIZED_ML
• ERROR_SPATIAL_ANCHORS_OUT_OF_MAP_BOUNDS_ML
• ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML

See Also:

• Constant Field Values

XR_SPATIAL_ANCHOR_CONFIDENCE_LOW_ML

public static final int XR_SPATIAL_ANCHOR_CONFIDENCE_LOW_ML

XrSpatialAnchorConfidenceML - Spatial anchor confidence

Description

Enum	Description
SPATIAL_ANCHOR_CONFIDENCE_LOW_ML	Low quality, this anchor can be expected to move significantly.
SPATIAL_ANCHOR_CONFIDENCE_MEDIUM_ML	Medium quality, this anchor may move slightly.
SPATIAL_ANCHOR_CONFIDENCE_HIGH_ML	High quality, this anchor is stable and suitable for digital content attachment.

See Also

XrSpatialAnchorStateML

See Also:

• Constant Field Values

XR_SPATIAL_ANCHOR_CONFIDENCE_MEDIUM_ML

public static final int XR_SPATIAL_ANCHOR_CONFIDENCE_MEDIUM_ML

XrSpatialAnchorConfidenceML - Spatial anchor confidence

Description

Enum	Description
SPATIAL_ANCHOR_CONFIDENCE_LOW_ML	Low quality, this anchor can be expected to move significantly.
SPATIAL_ANCHOR_CONFIDENCE_MEDIUM_ML	Medium quality, this anchor may move slightly.
SPATIAL_ANCHOR_CONFIDENCE_HIGH_ML	High quality, this anchor is stable and suitable for digital content attachment.

See Also

XrSpatialAnchorStateML

See Also:

• Constant Field Values

XR_SPATIAL_ANCHOR_CONFIDENCE_HIGH_ML

public static final int XR_SPATIAL_ANCHOR_CONFIDENCE_HIGH_ML

XrSpatialAnchorConfidenceML - Spatial anchor confidence

Description

Enum	Description
SPATIAL_ANCHOR_CONFIDENCE_LOW_ML	Low quality, this anchor can be expected to move significantly.
SPATIAL_ANCHOR_CONFIDENCE_MEDIUM_ML	Medium quality, this anchor may move slightly.
SPATIAL_ANCHOR_CONFIDENCE_HIGH_ML	High quality, this anchor is stable and suitable for digital content attachment.

See Also

XrSpatialAnchorStateML

See Also:

• Constant Field Values

Method Details

nxrCreateSpatialAnchorsAsyncML

public static int nxrCreateSpatialAnchorsAsyncML(XrSession session,
 long createInfo,
 long future)

Unsafe version of: CreateSpatialAnchorsAsyncML

xrCreateSpatialAnchorsAsyncML

public static int xrCreateSpatialAnchorsAsyncML(XrSession session,
 XrSpatialAnchorsCreateInfoBaseHeaderML createInfo,
 LongBuffer future)

Create spatial anchors.

C Specification

The CreateSpatialAnchorsAsyncML function is defined as:

 XrResult xrCreateSpatialAnchorsAsyncML(
     XrSession                                   session,
     const XrSpatialAnchorsCreateInfoBaseHeaderML* createInfo,
     XrFutureEXT*                                future);

Description

This function starts an asynchronous spatial anchor creation. Call one of the PollFutureEXT functions to check the ready state on the future. Once the future is in ready state, call CreateSpatialAnchorsCompleteML to retrieve the results.

Valid Usage (Implicit)

• The XR_ML_spatial_anchors extension must be enabled prior to calling CreateSpatialAnchorsAsyncML
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrSpatialAnchorsCreateInfoBaseHeaderML-based structure. See also: XrSpatialAnchorsCreateInfoFromPoseML, XrSpatialAnchorsCreateInfoFromUuidsML
• future must be a pointer to an XrFutureEXT value

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_TIME_INVALID
• ERROR_SPATIAL_ANCHORS_SPACE_NOT_LOCATABLE_ML
• ERROR_SPATIAL_ANCHORS_PERMISSION_DENIED_ML
• ERROR_POSE_INVALID

See Also

XrSpatialAnchorsCreateInfoBaseHeaderML, XrSpatialAnchorsCreateInfoFromPoseML, CreateSpatialAnchorsCompleteML

Parameters:

session - a handle to an XrSession previously created with CreateSession.

createInfo - a pointer to an XrSpatialAnchorsCreateInfoBaseHeaderML derived structure.

future - a pointer to an XrFutureEXT.

nxrCreateSpatialAnchorsCompleteML

public static int nxrCreateSpatialAnchorsCompleteML(XrSession session,
 long future,
 long completion)

Unsafe version of: CreateSpatialAnchorsCompleteML

xrCreateSpatialAnchorsCompleteML

public static int xrCreateSpatialAnchorsCompleteML(XrSession session,
 long future,
 XrCreateSpatialAnchorsCompletionML completion)

Completion function for spatial anchor creation.

C Specification

The CreateSpatialAnchorsCompleteML function is defined as:

 XrResult xrCreateSpatialAnchorsCompleteML(
     XrSession                                   session,
     XrFutureEXT                                 future,
     XrCreateSpatialAnchorsCompletionML*         completion);

Valid Usage (Implicit)

• The XR_ML_spatial_anchors extension must be enabled prior to calling CreateSpatialAnchorsCompleteML
• session must be a valid XrSession handle
• completion must be a pointer to an XrCreateSpatialAnchorsCompletionML structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_FUTURE_PENDING_EXT
• ERROR_FUTURE_INVALID_EXT

See Also

XrCreateSpatialAnchorsCompletionML, CreateSpatialAnchorsAsyncML

Parameters:

session - a handle to an XrSession previously created with CreateSession.

future - the XrFutureEXT to complete.

completion - a pointer to an XrCreateSpatialAnchorsCompletionML filled in by the runtime.

nxrGetSpatialAnchorStateML

public static int nxrGetSpatialAnchorStateML(XrSpace anchor,
 long state)

Unsafe version of: GetSpatialAnchorStateML

xrGetSpatialAnchorStateML

public static int xrGetSpatialAnchorStateML(XrSpace anchor,
 XrSpatialAnchorStateML state)

Retrieve spatial anchor state.

C Specification

The GetSpatialAnchorStateML function is defined as:

 XrResult xrGetSpatialAnchorStateML(
     XrSpace                                     anchor,
     XrSpatialAnchorStateML*                     state);

Description

The runtime must return ERROR_VALIDATION_FAILURE if the XrSpace is not an spatial anchor.

Valid Usage (Implicit)

• The XR_ML_spatial_anchors extension must be enabled prior to calling GetSpatialAnchorStateML
• anchor must be a valid XrSpace handle
• state must be a pointer to an XrSpatialAnchorStateML structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED

See Also

XrCreateSpatialAnchorsCompletionML, XrSpatialAnchorStateML, CreateSpatialAnchorsAsyncML

Parameters:

anchor - a handle to an XrSpace corresponding to a spatial anchor.

state - a pointer to an XrSpatialAnchorStateML structure to populate with the spatial anchor state.