GoogleARCore.AugmentedImage

An image in the real world detected and tracked by ARCore.

Summary

ARCore will return an AugmentedImage once it initially detects the image in the environment, even if it does not yet have enough information to estimate its pose and physical size. In that case, the AugmentedImage will have the tracking state Paused. Specifying the optional physical size in the Unity editor will help speed up the initial pose and physical size estimation process. Note that an AugmentedImage can have tracking state Paused even if the session state is Tracking.

Inheritance

Inherits from: GoogleARCore.Trackable

Properties

CenterPose
Pose
Gets the position and orientation of the image's center in Unity world coordinates.
DatabaseIndex
int
Gets the zero-based positional index of this augmented image from its originating image database.
ExtentX
float
Gets the estimated width, in meters, of the corresponding physical image, as measured along the local X-axis (point from image left to image right) of the coordinate space centered on the image.
ExtentZ
float
Gets the estimated height, in meters, of the corresponding physical image, as measured along the local Z-axis (pointing from image bottom to image top) of the coordinate space centered on the image.
Name
string
Gets the name of the image.

Properties

CenterPose

Pose CenterPose

Gets the position and orientation of the image's center in Unity world coordinates.

The Y-axis points perpendicular out of the image. The X-axis points from left to right on the image, and the Z-axis points from bottom to top on the image.

If the tracking state is Paused/Stopped, this returns the pose when the image state was last Tracking, or the identity pose if the image state has never been Tracking.

DatabaseIndex

int DatabaseIndex

Gets the zero-based positional index of this augmented image from its originating image database.

This index serves as the unique identifier for the image in the database.

ExtentX

float ExtentX

Gets the estimated width, in meters, of the corresponding physical image, as measured along the local X-axis (point from image left to image right) of the coordinate space centered on the image.

ARCore will attempt to estimate the physical image's width based on its understanding of the world. If the optional physical size is specified in the Unity editor, this estimation process will happen more quickly. However, the estimated size may be different from the specified size.

If the tracking state is Paused/Stopped, this returns the estimated width when the image state was last Tracking, or 0 if the image state has never been Tracking.

ExtentZ

float ExtentZ

Gets the estimated height, in meters, of the corresponding physical image, as measured along the local Z-axis (pointing from image bottom to image top) of the coordinate space centered on the image.

ARCore will attempt to estimate the physical image's height based on its understanding of the world. If an optional physical size is specified in the Unity editor, this estimation process will happen more quickly. However, the estimated size may be different from the specified size.

If the tracking state is Paused/Stopped, this returns the estimated height when the image state was last Tracking, or 0 if the image state has never been Tracking.

Name

string Name

Gets the name of the image.

The image name is not guaranteed to be unique.

Send feedback about...