unreal.MagicLeapPlanesQuery

class unreal.MagicLeapPlanesQuery(flags=[], max_results=0, min_hole_length=0.0, min_plane_area=0.0, search_volume_position=[0.0, 0.0, 0.0], search_volume_orientation=[0.0, 0.0, 0.0, 0.0], search_volume_extents=[0.0, 0.0, 0.0])

Bases: unreal.StructBase

Type used to represent a plane query.

C++ Source:

  • Plugin: MagicLeap
  • Module: MagicLeapPlanes
  • File: MagicLeapPlanesTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • flags (Array(MagicLeapPlaneQueryFlags)): [Read-Write] The flags to apply to this query.
  • max_results (int32): [Read-Write] The maximum number of results that should be returned. This is also the minimum expected size of the array of results passed to the MLPlanesGetResult function.
  • min_hole_length (float): [Read-Write] If #MLPlanesQueryFlag_IgnoreHoles is set to false, holes with a perimeter (in meters) smaller than this value will be ignored, and can be part of the plane. This value cannot be lower than 0 (lower values will be capped to this minimum). A good default value is 50cm.
  • min_plane_area (float): [Read-Write] The minimum area (in squared meters) of planes to be returned. This value cannot be lower than 400 (lower values will be capped to this minimum).
  • search_volume (BoxComponent): [Read-Write] DEPRECATED. Use individual fields for setting search volume position, orientation and extents. deprecated: Property ‘SearchVolume’ is deprecated.
  • search_volume_extents (Vector): [Read-Write] Search Volume Extents
  • search_volume_orientation (Quat): [Read-Write] Search Volume Orientation
  • search_volume_position (Vector): [Read-Write] Search Volume Position
flags

(Array(MagicLeapPlaneQueryFlags)) – [Read-Write] The flags to apply to this query.

max_results

(int32) – [Read-Write] The maximum number of results that should be returned. This is also the minimum expected size of the array of results passed to the MLPlanesGetResult function.

min_hole_length

(float) – [Read-Write] If #MLPlanesQueryFlag_IgnoreHoles is set to false, holes with a perimeter (in meters) smaller than this value will be ignored, and can be part of the plane. This value cannot be lower than 0 (lower values will be capped to this minimum). A good default value is 50cm.

min_plane_area

(float) – [Read-Write] The minimum area (in squared meters) of planes to be returned. This value cannot be lower than 400 (lower values will be capped to this minimum).

search_volume

(BoxComponent) – [Read-Write] DEPRECATED. Use individual fields for setting search volume position, orientation and extents. deprecated: Property ‘SearchVolume’ is deprecated.

search_volume_extents

(Vector) – [Read-Write] Search Volume Extents

search_volume_orientation

(Quat) – [Read-Write] Search Volume Orientation

search_volume_position

(Vector) – [Read-Write] Search Volume Position