unreal.LuminARCandidateImage

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

Bases: unreal.ARCandidateImage

Lumin ARCandidate Image

C++ Source:

  • Plugin: MagicLeap

  • Module: MagicLeapAR

  • File: LuminARTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • axis_orientation (MagicLeapImageTargetOrientation): [Read-Write] Axis Orientation

  • 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

  • image_is_stationary (bool): [Read-Write] Image Is Stationary

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

  • use_unreliable_pose (bool): [Read-Write] Use Unreliable Pose

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

get_axis_orientation() → MagicLeapImageTargetOrientation

Get Axis Orientation

Returns

Return type

MagicLeapImageTargetOrientation

get_image_is_stationary() → bool

FriendlyName:

Returns

Return type

bool

get_use_unreliable_pose() → bool

Get Use Unreliable Pose

Returns

Return type

bool