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
  • 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.
  • environment_capture_probe_type (AREnvironmentCaptureProbeType): [Read-Write] How the AR system should handle texture probe capturing
  • 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:
  • horizontal_plane_detection (bool): [Read-Write] Should we detect flat horizontal surfaces: e.g. table tops, windows sills
  • 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_plane_query_results (int32): [Read-Write] The maximum number of plane results that will be returned.
  • 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.
  • plane_query_flags (Array(PlaneQueryFlags)): [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.
  • 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.
  • 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.
  • session_type (ARSessionType): [Read-Write] EARSessionType:
  • 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