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

Bases: unreal.DataAsset

An asset that points to an image to be detected in a scene and provides the size of the object in real life

C++ Source:

  • Module: AugmentedReality

  • File: ARTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • candidate_texture (Texture2D): [Read-Write] Candidate Texture: The image to detect in scenes

  • friendly_name (str): [Read-Write] Friendly Name: The friendly name to report back when the image is detected in scenes

  • height (float): [Read-Write] Height: The physical height in centimeters of the object that this candidate image represents. Ignored in ARCore

  • orientation (ARCandidateImageOrientation): [Read-Write] Orientation: The orientation to treat the candidate image as. Ignored in ARCore

  • width (float): [Read-Write] Width: The physical width in centimeters of the object that this candidate image represents

get_candidate_texture() Texture2D

see: CandidateTexture

Return type


get_friendly_name() str

see: FriendlyName

Return type


get_orientation() ARCandidateImageOrientation

see: Orientation

Return type


get_physical_height() float

see: Height

Return type


get_physical_width() float

see: Width

Return type