Geospatial

public final @NonNull VpsAvailabilityResult checkVpsAvailability(double latitude, double longitude)

Gets the availability of the Visual Positioning System (VPS) at a specified horizontal position.

The Visual Positioning System (VPS) provides highly accurate global localization by matching features from the device's camera against Google's global database of 3D imagery. The availability of VPS in a given location helps to improve the quality of Geospatial localization and tracking accuracy.

This launches an asynchronous operation used to query the Google Cloud ARCore API. It may be called without calling Session.configure.

Your app must be properly set up to communicate with the Google Cloud ARCore API in order to obtain a result from this call, otherwise the result will be androidx.xr.arcore.runtime.VpsAvailabilityNotAuthorized.

public final @NonNull AnchorResult createAnchor(
    double latitude,
    double longitude,
    double altitude,
    @NonNull Quaternion eastUpSouthQuaternion
)

Creates a new Anchor at the specified geospatial location and orientation relative to the Earth.

Latitude and longitude are defined by the WGS84 specification, and the altitude value is defined by the elevation above the WGS84 ellipsoid in meters. To create an anchor using an altitude relative to the Earth's terrain instead of altitude above the WGS84 ellipsoid, use Geospatial.createAnchorOnSurface.

The rotation quaternion provided is with respect to an east-up-south coordinate frame. An identity rotation will have the anchor oriented such that X+ points to the east, Y+ points up away from the center of the earth, and Z+ points to the south.

The tracking state of an Anchor will permanently become androidx.xr.arcore.TrackingState.STOPPED if the androidx.xr.runtime.GeospatialMode is disabled, or if another full-space app uses Geospatial.

Creating anchors near the north pole or south pole is not supported. If the latitude is within 0.1 degrees of the north pole or south pole (90 degrees or -90 degrees), this function will throw IllegalArgumentException.

public final @NonNull AnchorResult createAnchorOnSurface(
    double latitude,
    double longitude,
    double altitudeAboveSurface,
    @NonNull Quaternion eastUpSouthQuaternion,
    @NonNull GeospatialSurface surface
)

Asynchronously creates a new Anchor at a specified horizontal position and altitude relative to the horizontal position's surface (Terrain or Rooftop).

The specified altitudeAboveSurface is interpreted to be relative to the given surface at the specified latitude/longitude geospatial coordinates, rather than relative to the WGS84 ellipsoid. Specifying an altitude of 0 will position the anchor directly on the surface whereas specifying a positive altitude will position the anchor above the surface, against the direction of gravity.

GeospatialSurface.TERRAIN refers to the Earth's terrain (or floor) and GeospatialSurface.ROOFTOP refers to the top of a building at the given horizontal location. If there is no building at the given location, then the rooftop surface is interpreted to be the terrain instead.

You may resolve multiple anchors at a time, but a session cannot be tracking more than 100 surface anchors at time. Attempting to resolve more than 100 surface anchors will return an AnchorCreateResourcesExhausted result.

Creating a Terrain anchor requires an active Earth which is GeospatialTrackingState.RUNNING. If it is not, then this function returns an AnchorCreateTrackingUnavailable result. This call also requires a working internet connection to communicate with the ARCore API on Google Cloud. ARCore will continue to retry if it is unable to establish a connection to the ARCore service.

A Terrain anchor's tracking state will be androidx.xr.arcore.TrackingState.PAUSED if the Earth is not actively tracking. Its tracking state will permanently become androidx.xr.arcore.TrackingState.STOPPED if androidx.xr.runtime.GeospatialMode is disabled, or if another full-space app uses Geospatial.

Latitude and longitude are defined by the WGS84 specification, and the altitude value is defined by the elevation above the Earth's terrain (or floor) in meters.

The rotation quaternion provided is with respect to an east-up-south coordinate frame. An identity rotation will have the anchor oriented such that X+ points to the east, Y+ points up away from the center of the earth, and Z+ points to the south.

public final @NonNull CreateGeospatialPoseFromPoseResult createGeospatialPoseFromPose(@NonNull Pose pose)

Converts the input Pose to a GeospatialPose in the same position as the original pose.

This method may return a GeospatialPoseNotTrackingException result if Geospatial is not currently tracking.

public final @NonNull CreatePoseFromGeospatialPoseResult createPoseFromGeospatialPose(@NonNull GeospatialPose geospatialPose)

Converts the input geospatial location and orientation relative to the Earth to a Pose in the same position.

This method may return a CreatePoseFromGeospatialPoseNotTracking result if Geospatial is not currently tracking.

Positions near the north pole or south pole is not supported. If the latitude is within 0.1 degrees of the north pole or south pole (90 degrees or -90 degrees), this function will throw an IllegalArgumentException.

public static final @NonNull Geospatial getInstance(@NonNull Session session)

Returns the Geospatial object for the given Session.

public final @NonNull StateFlow<@NonNull Geospatial.State> getState()

the current State of Geospatial