UPlanesComponent

The PlanesComponent class manages requests for planes, processes the results and provides them to the calling system.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MagicLeap

Header

/Engine/Plugins/Lumin/MagicLeap/Source/MagicLeap/Classes/PlanesComponent.h

Include

#include "PlanesComponent.h"

Syntax

UCLASS(ClassGroup=MagicLeap, BlueprintType, Blueprintable, EditInlineNew,
       Meta=(BlueprintSpawnableComponent))
class UPlanesComponent : public USceneComponent

Remarks

The PlanesComponent class manages requests for planes, processes the results and provides them to the calling system. The calling system is able request planes within a specified area. Various other search criteria can be set via this class's public properties. Planes requests are processed on a separate thread. Once a planes request has been processed the calling system will be notified via an FPlaneResultDelegate broadcast.

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 EPlaneQueryFlags::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< EPlaneQ...

 

QueryFlags

The flags to apply to this query.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

UBoxComponent &...

 

SearchVolume

Bounding box for searching planes in.

Constructors

Name Description

Public function

UPlanesComponent()

Destructors

Name Description

Public function

~UPlanesComponent()

Functions

Name Description

Public function UFunction BlueprintCallable, Category

bool

 

RequestPlanes

(
    int32 UserData,
    const FPlaneResultDelegate& Result...
)

Requests planes with the current value of QueryFlags, SearchVolume and MaxResults.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

BeginPlay()

Creates the planes tracker handle for the component

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorComponentTickFunction* T...
)

Polls for and handles the results of the plane queries.

Overridden from UObject

Name Description

Public function Virtual

void

 

FinishDestroy()

Destroys the interface object to the planes api

Classes

Name

Description

Public class

FPlaneResultDelegate

Delegate used to convey the result of a plane query.

Deprecated Variables

Name Description

Public variable UProperty

bool

 

IgnoreBoundingVolume_DEPRECATED

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback