Stay organized with collections Save and categorize content based on your preferences.

Google.XR.ARCoreExtensions.AREarthManager

Provides localization in Earth-relative coordinates.

Summary

ARCoreExtensionsConfig.GeospatialMode must be GeospatialMode.Enabled in order to make use of the Geospatial API. Not all devices support GeospatialMode.Enabled, use AREarthManager.IsGeospatialModeSupported to find whether the current device supports enabling this mode.

AREarthManager.CameraGeospatialPose should only be used when AREarthManager.EarthTrackingState is TrackingState.Tracking, and otherwise should not be used. If the EarthTrackingState does not become Tracking, then AREarthManager.EarthState may contain more information on this failure.

Inheritance

Inherits from: UnityEngine::MonoBehaviour

Properties

CameraGeospatialPose
Gets the GeospatialPose for the camera in the latest frame, describing the geodedic position of the device.
EarthState
Gets the EarthState for the latest frame.
EarthTrackingState
Gets the tracking state of Earth for the latest frame.

Public static functions

CheckVpsAvailability(double latitude, double longitude)
Gets the availability of the Visual Positioning System (VPS) at a specified horizontal position.

Public functions

Convert(Pose pose)
Gets the GeospatialPose from a local pose relative to camera, relative to the last frame.
Convert(GeospatialPose geospatialPose)
Gets the local pose relative to camera from the GeospatialPose.
IsGeospatialModeSupported(GeospatialMode mode)
Checks whether the provided GeospatialMode is supported on this device.

Properties

CameraGeospatialPose

GeospatialPose CameraGeospatialPose

Gets the GeospatialPose for the camera in the latest frame, describing the geodedic position of the device.

The position of the pose is located at the device's camera, while the orientation closely approximates the orientation of the display.

Note: This pose is only valid when EarthTrackingState is TrackingState.Tracking; otherwise, it should not be used.

EarthState

EarthState EarthState

Gets the EarthState for the latest frame.

EarthTrackingState

TrackingState EarthTrackingState

Gets the tracking state of Earth for the latest frame.

Public static functions

CheckVpsAvailability

VpsAvailabilityPromise CheckVpsAvailability(
  double latitude,
  double longitude
)

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. This function returns a VpsAvailabilityPromise which can be used to obtain the task's result. Its initial PromiseState will be set to PromiseState.Pending. When the operation is completed, its state will be set to PromiseState.Done, and VpsAvailabilityPromise.Result can be used to obtain the operation's result.

Your app must be properly set up to communicate with the Google Cloud ARCore API in order to obtain a result from this call. See Check VPS Availability for more details on required permissions, setup steps, and usage examples.

Details
Parameters
latitude
The latitude in degrees.
longitude
The longitude in degrees.
Returns
Returns a VpsAvailabilityPromise used in a Unity Coroutine. It updates its results in frame update events. See Check VPS Availability for a usage example.

Public functions

Convert

GeospatialPose Convert(
  Pose pose
)

Gets the GeospatialPose from a local pose relative to camera, relative to the last frame.

The rotation quaternion of GeospatialPose is a rotation with respect to an East-Up-North coordinate frame. An identity quaternion 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 north.

EarthTrackingState must be in the TrackingState.Tracking state for this to return a valid pose. The Heading property will be zero for a GeospatialPose returned by this method.

Details
Parameters
pose
The pose to be converted.
Returns

Convert

Pose Convert(
  GeospatialPose geospatialPose
)

Gets the local pose relative to camera from the GeospatialPose.

AREarthManager.EarthTrackingState must be in the TrackingState.Tracking state for this to return a valid pose.

Details
Parameters
geospatialPose
A GeospatialPose with valid Latitude, Longitude, Altitude and EunRotation.
Returns
A Pose.

IsGeospatialModeSupported

FeatureSupported IsGeospatialModeSupported(
  GeospatialMode mode
)

Checks whether the provided GeospatialMode is supported on this device.

The current list of supported devices is documented on the ARCore supported devices page. A device may be incompatible with a given mode due to insufficient sensor capabilities.

Details
Parameters
mode
The desired geospatial mode.
Returns
Indicates whether the given mode is supported on this device. It will return FeatureSupported.Unknown if the session is still under initialization.