unreal.LuminARSessionConfig

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

Bases: unreal.ARSessionConfig

Lumin ARSession Config

C++ Source:

  • Plugin: MagicLeap

  • Module: MagicLeapAR

  • File: LuminARSessionConfig.h

Editor Properties: (see get_editor_property/set_editor_property)

  • arbitrary_orientation_plane_detection (bool): [Read-Write] Should we detect planes with any orientation (ie not just horizontal or vertical).

  • candidate_images (Array(ARCandidateImage)): [Read-Write] The list of candidate images to detect within the AR camera view

  • candidate_objects (Array(ARCandidateObject)): [Read-Write] A list of candidate objects to search for in the scene

  • default_mesh_material (MaterialInterface): [Read-Write] The default mesh material used by the generated mesh component

  • default_use_unreliable_pose (bool): [Read-Write] For image tracking, Candidate Images may contain both AR Candidate Images and Lumin AR Candidate Images. The former does not contain info about whether to update the pose when tracking is unreliable. In that case, this value is used to determine whether to update the pose, instead.

  • default_wireframe_mesh_material (MaterialInterface): [Read-Write] The default mesh material used by the wireframe setting of the generated mesh component. Note: It is reccomended to ignore this ‘wireframe’ feature and use a wirefraem material in the DefaultMeshMaterial if you want wireframe.

  • desired_video_format (ARVideoFormat): [Read-Write] The desired video format (or the default if not supported) that this session should use if the camera is enabled Note: Call GetSupportedVideoFormats to get a list of device supported formats

  • discard_zero_extent_planes (bool): [Read-Write] If true discard any ‘plane’ objects that come through with zero extents and only polygon edge data.

  • enable_auto_focus (bool): [Read-Write] Whether the camera should use autofocus or not (can cause subtle shifts in position for small objects at macro camera distance)

  • enable_automatic_camera_overlay (bool): [Read-Write] Whether the AR camera feed should be drawn as an overlay or not. Defaults to true.

  • enable_automatic_camera_tracking (bool): [Read-Write] Whether the game camera should track the device movement or not. Defaults to true.

  • enabled_session_tracking_feature (ARSessionTrackingFeature): [Read-Write] A list of session features to enable

  • environment_capture_probe_type (AREnvironmentCaptureProbeType): [Read-Write] How the AR system should handle texture probe capturing

  • environment_probe_component_class (type(Class)): [Read-Write] Environment Probe Component Class

  • face_component_class (type(Class)): [Read-Write] Face Component Class

  • face_tracking_direction (ARFaceTrackingDirection): [Read-Write] Whether to track the face as if you are looking out of the device or as a mirror

  • face_tracking_update (ARFaceTrackingUpdate): [Read-Write] Whether to track the face as if you are looking out of the device or as a mirror

  • frame_sync_mode (ARFrameSyncMode): [Read-Write] EARFrameSyncMode:

  • generate_collision_for_mesh_data (bool): [Read-Write] Whether the AR system should generate collision data from the mesh data or not

  • generate_mesh_data_from_tracked_geometry (bool): [Read-Write] Whether the AR system should generate mesh data that can be rendered, collided against, nav mesh generated on, etc.

  • generate_nav_mesh_for_mesh_data (bool): [Read-Write] Whether the AR system should generate navigation mesh data from the mesh data or not

  • geo_anchor_component_class (type(Class)): [Read-Write] Geo Anchor Component Class

  • horizontal_plane_detection (bool): [Read-Write] Should we detect flat horizontal surfaces: e.g. table tops, windows sills

  • image_component_class (type(Class)): [Read-Write] Image Component Class

  • light_estimation_mode (ARLightEstimationMode): [Read-Write] EARLightEstimationMode:

  • max_num_simultaneous_images_tracked (int32): [Read-Write] The maximum number of images to track at the same time. Defaults to 1

  • max_number_of_tracked_faces (int32): [Read-Write] The maximum number of faces to track simultaneously.

  • max_plane_query_results (int32): [Read-Write] The maximum number of plane results that will be returned. deprecated: Use PlanesQuery instead.

  • mesh_component_class (type(Class)): [Read-Write] Mesh Component Class

  • min_plane_area (int32): [Read-Write] The minimum area (in square cm) of planes to be returned. This value cannot be lower than 400 (lower values will be capped to this minimum). A good default value is 2500. deprecated: Use PlanesQuery instead.

  • object_component_class (type(Class)): [Read-Write] Object Component Class

  • plane_component_class (type(Class)): [Read-Write] Class binding for to facilitate networking

  • plane_query_flags (Array(MagicLeapPlaneQueryFlags)): [Read-Write] Additional Flags to apply to the plane queries. Note: the plane orientation detection settings also cause flags to be set. It is ok to duplicate those here. deprecated: Use PlanesQuery instead.

  • plane_search_extents (Vector): [Read-Write] The dimensions of the box within which plane results will be returned. The box center and rotation are those of the tracking to world transform origin. deprecated: Use PlanesQuery instead.

  • planes_query (MagicLeapPlanesQuery): [Read-Write] The planes information that the AR session uses when generating a query.

  • point_component_class (type(Class)): [Read-Write] Point Component Class

  • pose_component_class (type(Class)): [Read-Write] Pose Component Class

  • qr_code_component_class (type(Class)): [Read-Write] QRCode Component Class

  • render_mesh_data_in_wireframe (bool): [Read-Write] Whether the AR system should render the mesh data in wireframe or not

  • reset_camera_tracking (bool): [Read-Write] Whether the AR system should reset camera tracking (origin, transform) or not. Defaults to true.

  • reset_tracked_objects (bool): [Read-Write] Whether the AR system should remove any tracked objects or not. Defaults to true.

  • scene_reconstruction_method (ARSceneReconstruction): [Read-Write] Which scene reconstruction method to use

  • session_type (ARSessionType): [Read-Write] EARSessionType:

  • track_scene_objects (bool): [Read-Write] Whether the AR system should report scene objects ( EARObjectClassification::SceneObject):

  • use_automatic_image_scale_estimation (bool): [Read-Write] Whether to automatically estimate and set the scale of a detected or tracked image.

  • use_mesh_data_for_occlusion (bool): [Read-Write] Whether the AR system render the mesh data as occlusion meshes or not

  • use_optimal_video_format (bool): [Read-Write] Whether to automatically pick the video format that best matches the device screen size

  • use_person_segmentation_for_occlusion (bool): [Read-Write] Whether to occlude the virtual content with the result from person segmentation

  • use_scene_depth_for_occlusion (bool): [Read-Write] Whether to occlude the virtual content with the scene depth information

  • use_standard_onboarding_ux (bool): [Read-Write] Whether to use the standard onboarding UX, if the system supports it.

  • vertical_plane_detection (bool): [Read-Write] Should we detect flat vertical surfaces: e.g. paintings, monitors, book cases

  • world_alignment (ARWorldAlignment): [Read-Write] EARWorldAlignment:

  • world_map_data (Array(uint8)): [Read-Only] A previously saved world that is to be loaded when the session starts

property default_use_unreliable_pose

[Read-Only] For image tracking, Candidate Images may contain both AR Candidate Images and Lumin AR Candidate Images. The former does not contain info about whether to update the pose when tracking is unreliable. In that case, this value is used to determine whether to update the pose, instead.

Type

(bool)

property max_plane_query_results

[Read-Write] The maximum number of plane results that will be returned. deprecated: Use PlanesQuery instead.

Type

(int32)

property min_plane_area

[Read-Write] The minimum area (in square cm) of planes to be returned. This value cannot be lower than 400 (lower values will be capped to this minimum). A good default value is 2500. deprecated: Use PlanesQuery instead.

Type

(int32)

property plane_query_flags

the plane orientation detection settings also cause flags to be set. It is ok to duplicate those here. deprecated: Use PlanesQuery instead.

Type

(Array(MagicLeapPlaneQueryFlags))

Type

[Read-Write] Additional Flags to apply to the plane queries. Note

property plane_search_extents

[Read-Write] The dimensions of the box within which plane results will be returned. The box center and rotation are those of the tracking to world transform origin. deprecated: Use PlanesQuery instead.

Type

(Vector)