Geospatial

fun getInstance(session: Session): Geospatial

Returns the Geospatial object for the given Session.

suspend fun checkVpsAvailability(latitude: Double, longitude: Double): VpsAvailabilityResult

Gets the availability of the Visual Positioning System (VPS) at a specified horizontal position. 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 VpsAvailabilityNotAuthorized.

fun createAnchor(
    latitude: Double,
    longitude: Double,
    altitude: Double,
    eastUpSouthQuaternion: Quaternion
): AnchorCreateResult

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

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

suspend fun createAnchorOnSurface(
    latitude: Double,
    longitude: Double,
    altitudeAboveSurface: Double,
    eastUpSouthQuaternion: Quaternion,
    surface: Geospatial.Surface
): AnchorCreateResult

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.

Surface.TERRAIN refers to the Earth's terrain (or floor) and Surface.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 EarthState.Running. If it is not, then this function returns an AnchorCreateIllegalState 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 TrackingState.Paused if the Earth is not actively tracking. Its tracking state will permanently become 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.

fun createGeospatialPoseFromPose(pose: Pose): CreateGeospatialPoseFromPoseResult

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

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

fun createPoseFromGeospatialPose(geospatialPose: GeospatialPose): CreatePoseFromGeospatialPoseResult

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

This method may return a PoseNotTracking 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.

val state: StateFlow<Geospatial.State>

The current State of Geospatial.

fun Geospatial.checkVpsAvailabilityAsync(
    session: Session,
    latitude: Double,
    longitude: Double
): ListenableFuture<VpsAvailabilityResult>

Gets the availability of the Visual Positioning System (VPS) at a specified horizontal position. 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 VpsAvailabilityNotAuthorized.

val Geospatial.stateAsFlowable: Flowable<Geospatial.State>

The current State of Geospatial.