unreal.ARTrackedImage

class unreal.ARTrackedImage(outer=None, name='None')

Bases: unreal.ARTrackedGeometry

ARTracked Image

C++ Source:

  • Module: AugmentedReality
  • File: ARTrackable.h

Editor Properties: (see get_editor_property/set_editor_property)

  • is_tracked (bool): [Read-Write] Whether the image is currently being tracked by the AR system
get_detected_image() → ARCandidateImage

DetectedImage:

Returns:
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.
Returns:
Return type:Vector2D
is_tracked

(bool) – [Read-Only] Whether the image is currently being tracked by the AR system