UMagicLeapARPinComponent

Component to make content persist at locations in the real world.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MagicLeap

Header

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

Include

#include "MagicLeapARPinComponent.h"

Syntax

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

Remarks

Component to make content persist at locations in the real world.

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

EAutoPinType

 

AutoPinType

Mode for automatically pinning this component or it's owner actor to real-world.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bShouldPinActor

Pin this component's owner actor instead of just the component itself.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FString

 

ObjectUID

Unique ID for this component to save the meta data for the Pin and make content persistent.

Public variable UProperty BlueprintAssignable

FPersistentEnti...

 

OnPersistentEntityPinned

Fired when an entity is successfully pinned by this component.

Constructors

Name Description

Public function

UMagicLeapARPinComponent()

Functions

Name Description

Public function UFunction BlueprintCallable, Category

bool

 

GetPinnedPinID

(
    FGuid& PinID
)

Get the ID of the Pin the entity (component or actor) is currently pinned to.

Public function Const UFunction BlueprintCallable, Category

bool

 

IsPinned()

True if an entity (component or actor) is currently pinned by this component.

Public function UFunction BlueprintCallable, Category

bool

 

PinActor

(
    AActor* ActorToPin
)

Pin given Actor to the closest AR Pin in real-world.

Public function Const UFunction BlueprintCallable, Category

bool

 

PinRestoredOrSynced()

True if the AR Pin for the unique ID ObjectUID was restored from the app's local storage or was repliated over network.

Public function UFunction BlueprintCallable, Category

bool

 

PinSceneComponent

(
    USceneComponent* ComponentToPi...
)

Pin given SceneComponent to the closest AR Pin in real-world.

Public function UFunction BlueprintCallable, Category

void

 

UnPin()

Detach or un-pin the currently pinned entity (component or actor) from the real-world.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

BeginPlay()

BeginsPlay for the component.

Public function Virtual

void

 

TickComponent

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

Function called every frame on this ActorComponent.

Overridden from UObject

Name Description

Public function Virtual

void

 

FinishDestroy()

Called to finish destroying the object.

Classes

Name

Description

Public class

FPersistentEntityPinned

Delegate used to notify the instigating blueprint that an entity (component or actor) has been successfuly pinned to the real-world.

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