unreal.MagicLeapARPinQuery

class unreal.MagicLeapARPinQuery(types=[MagicLeapARPinType.SINGLE_USER_SINGLE_SESSION, MagicLeapARPinType.SINGLE_USER_MULTI_SESSION, MagicLeapARPinType.MULTI_USER_MULTI_SESSION], max_results=- 1, target_point=[0.0, 0.0, 0.0], radius=0.0, sorted=False)

Bases: unreal.StructBase

This represents a collection of filters and modifiers used by to curate the ARPins search.

C++ Source:

  • Plugin: MagicLeapPassableWorld

  • Module: MagicLeapARPin

  • File: MagicLeapARPinTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • max_results (int32): [Read-Write] Upper bound number of expected results. The implementation may return less entries than requested. Set to -1 for all available.

  • radius (float): [Read-Write] Return only entries within radius of the sphere from TargetPoint. Set to 0 for unbounded results. Filtering by distance will incur a performance penalty.

  • sorted (bool): [Read-Write] Indicate if the result set should be sorted by distance from TargetPoint. Sorting by istance will incur a performance penalty.

  • target_point (Vector): [Read-Write] Center query point from where the nearest neighbours will be calculated.

  • types (Set(MagicLeapARPinType)): [Read-Write] Types of Pins to look for

property max_results

[Read-Write] Upper bound number of expected results. The implementation may return less entries than requested. Set to -1 for all available.

Type

(int32)

property radius

[Read-Write] Return only entries within radius of the sphere from TargetPoint. Set to 0 for unbounded results. Filtering by distance will incur a performance penalty.

Type

(float)

property sorted

[Read-Write] Indicate if the result set should be sorted by distance from TargetPoint. Sorting by istance will incur a performance penalty.

Type

(bool)

property target_point

[Read-Write] Center query point from where the nearest neighbours will be calculated.

Type

(Vector)

property types

[Read-Write] Types of Pins to look for

Type

(Set(MagicLeapARPinType))