unreal.ARCandidateImage

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] The image to detect in scenes
  • friendly_name (str): [Read-Write] The friendly name to report back when the image is detected in scenes
  • height (float): [Read-Write] The physical height in centimeters of the object that this candidate image represents. Ignored in ARCore
  • orientation (ARCandidateImageOrientation): [Read-Write] The orientation to treat the candidate image as. Ignored in ARCore
  • width (float): [Read-Write] The physical width in centimeters of the object that this candidate image represents
get_candidate_texture() → Texture2D

CandidateTexture:

Returns:
Return type:Texture2D
get_friendly_name() → str

FriendlyName:

Returns:
Return type:str
get_orientation() → ARCandidateImageOrientation

Orientation:

Returns:
Return type:ARCandidateImageOrientation
get_physical_height() → float

Height:

Returns:
Return type:float
get_physical_width() → float

Width:

Returns:
Return type:float