unreal.MagicLeapPlanesComponent

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

Bases: unreal.SceneComponent

Component that provides access to the Planes API functionality.

C++ Source:

  • Plugin: MagicLeap

  • Module: MagicLeapPlanes

  • File: MagicLeapPlanesComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] If RelativeScale3D should be considered relative to the world, rather than the parent

  • asset_user_data (Array(AssetUserData)): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • component_tags (Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • detail_mode (DetailMode): [Read-Write] If detail mode is >= system detail mode, primitive won’t be rendered.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • hidden_in_game (bool): [Read-Write] Whether to hide the primitive in game, if the primitive is Visible.

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • max_results (int32): [Read-Write] The maximum number of planes that should be returned in the result.

  • min_hole_perimeter (float): [Read-Write] If EMagicLeapPlaneQueryFlags::IgnoreHoles is not a query flag then holes with a perimeter (in Unreal Units) smaller than this value will be ignored, and can be part of the plane.

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

  • mobility (ComponentMobility): [Read-Write] How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • on_persistent_planes_query_result (MagicLeapPersistentPlanesResultDelegateMulti): [Read-Write] On Persistent Planes Query Result

  • on_planes_query_result (MagicLeapPlanesResultDelegateMulti): [Read-Write] Delegate instances

  • physics_volume_changed_delegate (PhysicsVolumeChanged): [Read-Write] Delegate that will be called when PhysicsVolume has been changed *

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • query_flags (Array(MagicLeapPlaneQueryFlags)): [Read-Write] The flags to apply to this query. TODO: Should be a TSet but that is misbehaving in the editor.

  • query_type (MagicLeapPlaneQueryType): [Read-Write] The type of plane query to perform. Bulk: Use OnPlanesQueryResult to retrieve results. Delta: Use OnPersistentPlanesQueryResult to retrieve results.

  • relative_location (Vector): [Read-Write] Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • search_volume (BoxComponent): [Read-Write] Bounding box for searching planes in.

  • should_update_physics_volume (bool): [Read-Write] Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()

  • similarity_threshold (float): [Read-Write] The threshold used to compare incoming planes with any cached planes.

  • use_attach_parent_bound (bool): [Read-Write] If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.

  • visible (bool): [Read-Write] Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

property max_results

[Read-Write] The maximum number of planes that should be returned in the result.

Type

(int32)

property min_hole_perimeter

[Read-Write] If EMagicLeapPlaneQueryFlags::IgnoreHoles is not a query flag then holes with a perimeter (in Unreal Units) smaller than this value will be ignored, and can be part of the plane.

Type

(float)

property min_plane_area

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

Type

(float)

property on_persistent_planes_query_result

[Read-Write] On Persistent Planes Query Result

Type

(MagicLeapPersistentPlanesResultDelegateMulti)

property on_planes_query_result

[Read-Write] Delegate instances

Type

(MagicLeapPlanesResultDelegateMulti)

property query_flags

Should be a TSet but that is misbehaving in the editor.

Type

(Array(MagicLeapPlaneQueryFlags))

Type

[Read-Write] The flags to apply to this query. TODO

property query_type

[Read-Write] The type of plane query to perform. Bulk: Use OnPlanesQueryResult to retrieve results. Delta: Use OnPersistentPlanesQueryResult to retrieve results.

Type

(MagicLeapPlaneQueryType)

request_planes_async() → bool

Initiates a plane query.

Returns

Return type

bool

property search_volume

[Read-Write] Bounding box for searching planes in.

Type

(BoxComponent)

property similarity_threshold

[Read-Write] The threshold used to compare incoming planes with any cached planes.

Type

(float)