AugmentedImage

An image being detected and tracked by ARCore.

Summary

Typedefs

ArAugmentedImage typedef
struct ArAugmentedImage_
An image that has been detected and tracked (reference type,long-lived").

Functions

ArAugmentedImage_acquireName(const ArSession *session, const ArAugmentedImage *augmented_image, char **out_augmented_image_name)
void
Returns the name of this image.
ArAugmentedImage_getCenterPose(const ArSession *session, const ArAugmentedImage *augmented_image, ArPose *out_pose)
void
Returns the pose of the center of the detected image.
ArAugmentedImage_getExtentX(const ArSession *session, const ArAugmentedImage *augmented_image, float *out_extent_x)
void
Retrieves the estimated width, in metres, of the corresponding physical image, as measured along the local X-axis of the coordinate space with origin and axes as defined by ArAugmentedImage_getCenterPose().
ArAugmentedImage_getExtentZ(const ArSession *session, const ArAugmentedImage *augmented_image, float *out_extent_z)
void
Retrieves the estimated height, in metres, of the corresponding physical image, as measured along the local Z-axis of the coordinate space with origin and axes as defined by ArAugmentedImage_getCenterPose().
ArAugmentedImage_getIndex(const ArSession *session, const ArAugmentedImage *augmented_image, int32_t *out_index)
void
Returns the zero-based positional index of this image from its originating image database.

Typedefs

ArAugmentedImage

struct ArAugmentedImage_ ArAugmentedImage

An image that has been detected and tracked (reference type,long-lived").

Trackable type: AR_TRACKABLE_AUGMENTED_IMAGE
Release with: ArTrackable_release()

Functions

ArAugmentedImage_acquireName

void ArAugmentedImage_acquireName(
  const ArSession *session,
  const ArAugmentedImage *augmented_image,
  char **out_augmented_image_name
)

Returns the name of this image.

The image name is not guaranteed to be unique.

This function will allocate memory for the name string, and set *out_augmented_image_name to point to that string. The caller must release the string using ArString_release when the string is no longer needed.

ArAugmentedImage_getCenterPose

void ArAugmentedImage_getCenterPose(
  const ArSession *session,
  const ArAugmentedImage *augmented_image,
  ArPose *out_pose
)

Returns the pose of the center of the detected image.

The pose's transformed +Y axis will be point normal out of 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.

ArAugmentedImage_getExtentX

void ArAugmentedImage_getExtentX(
  const ArSession *session,
  const ArAugmentedImage *augmented_image,
  float *out_extent_x
)

Retrieves the estimated width, in metres, of the corresponding physical image, as measured along the local X-axis of the coordinate space with origin and axes as defined by ArAugmentedImage_getCenterPose().

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

If the tracking state is PAUSED/STOPPED, this returns the estimated width when the image state was last TRACKING. If the image state has never been TRACKING, this returns 0, even the image has a specified physical size in the image database.

ArAugmentedImage_getExtentZ

void ArAugmentedImage_getExtentZ(
  const ArSession *session,
  const ArAugmentedImage *augmented_image,
  float *out_extent_z
)

Retrieves the estimated height, in metres, of the corresponding physical image, as measured along the local Z-axis of the coordinate space with origin and axes as defined by ArAugmentedImage_getCenterPose().

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

If the tracking state is PAUSED/STOPPED, this returns the estimated height when the image state was last TRACKING. If the image state has never been TRACKING, this returns 0, even the image has a specified physical size in the image database.

ArAugmentedImage_getIndex

void ArAugmentedImage_getIndex(
  const ArSession *session,
  const ArAugmentedImage *augmented_image,
  int32_t *out_index
)

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

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

Send feedback about...