unreal.ARTrackedImage

class unreal.ARTrackedImage(outer: Object | None = None, name: Name | str = 'None')

Bases: ARTrackedGeometry

ARTracked Image

C++ Source:

  • Module: AugmentedReality

  • File: ARTrackable.h

Editor Properties: (see get_editor_property/set_editor_property)

  • unique_id (Guid): [Read-Write]

get_detected_image() → ARCandidateImage

see: DetectedImage

Return type:

ARCandidateImage

get_estimate_size() → Vector2D

  • Get the estimate size of the detected image, where X is the estimated width, and Y is the estimated height.

  • Note that ARCore can return a valid estimate size of the detected image when the tracking state of the UARTrackedImage

  • is tracking. The size should reflect the actual size of the image target, which could be different than the input physical

  • size of the candidate image.

  • ARKit will return the physical size of the ARCandidate image.

Return type:

Vector2D