UMagicLeapPlanesComponent

Component that provides access to the Planes API functionality.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MagicLeapPlanes

Header

/Engine/Plugins/Lumin/MagicLeap/Source/MagicLeapPlanes/Source/Public/MagicLeapPlanesComponent.h

Include

#include "MagicLeapPlanesComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=MagicLeap, BlueprintType, Blueprintable, EditInlineNew,
       Meta=(BlueprintSpawnableComponent))
class UMagicLeapPlanesComponent : public USceneComponent

Remarks

Component that provides access to the Planes API functionality.

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

int32

 

MaxResults

The maximum number of planes that should be returned in the result.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

float

 

MinHolePerimeter

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.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

float

 

MinPlaneArea

The minimum area (in squared Unreal Units) of planes to be returned.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

TArray< EMagicL...

 

QueryFlags

The flags to apply to this query.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

EMagicLeapPlane...

 

QueryType

The type of plane query to perform.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

UBoxComponent &...

 

SearchVolume

Bounding box for searching planes in.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

float

 

SimilarityThreshold

The threshold used to compare incoming planes with any cached planes.

Constructors

Name Description

Public function

UMagicLeapPlanesComponent()

Functions

Name Description

Public function UFunction BlueprintCallable, Category

bool

 

RequestPlanesAsync()

Initiates a plane query.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

BeginPlay()

Creates the planes tracker handle for the component (or adds a ref count to an existing one).

Public function Virtual

void

 

EndPlay

(
    const EEndPlayReason::Type EndPlayR...
)

Removes a ref count to the underlying tracker (destroys the tracker if this is the last user).

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss