unreal.ARCandidateObject

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

Bases: DataAsset

An asset that points to an object to be detected in a scene

C++ Source:

• Module: AugmentedReality

• File: ARTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

• bounding_box (Box): [Read-Write] The physical bounds in centimeters of the object that this candidate object represents

• candidate_object_data (Array[uint8]): [Read-Write] The object to detect in scenes

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

get_bounding_box() → Box

see: BoundingBox

Return type:

Box

get_candidate_object_data() → Array[uint8]

see: CandidateObjectData

Return type:

Array[uint8]

get_friendly_name() → str

see: FriendlyName

Return type:

str

set_bounding_box(bounding_box) → None

Set Bounding Box

Parameters:

bounding_box (Box) –

set_candidate_object_data(candidate_object) → None

Set Candidate Object Data

Parameters:

candidate_object (Array[uint8]) –

set_friendly_name(new_name) → None

Set Friendly Name

Parameters:

new_name (str) –