IMagicLeapARPinFeature

Copyright Epic Games, Inc. All Rights Reserved.

Windows
MacOS
Linux

Inheritance Hierarchy

IModularFeature

IMagicLeapARPinFeature

References

Module

MagicLeapARPin

Header

/Engine/Plugins/Lumin/MagicLeapPassableWorld/Source/MagicLeapARPin/Public/IMagicLeapARPinFeature.h

Include

#include "IMagicLeapARPinFeature.h"

Syntax

class IMagicLeapARPinFeature : public IModularFeature

Remarks

Magic Leap AR Pin interface

NOTE: This intentionally does NOT derive from IModuleInterface, to allow for a cleaner separation of code if some modular interface needs to implement ARPins as well. NOTE: You must MANUALLY call IModularFeatures::Get().RegisterModularFeature( GetModularFeatureName(), this ) in your implementation! This allows AR Pins to be both piggy-backed off modules which support them, as well as standing alone.

Variables

Destructors

Name Description

Public function Virtual

~IMagicLeapARPinFeature()

Functions

Name Description

Public function

void

 

BindToOnMagicLeapARPinUpdatedDelegate

(
    const FMagicLeapARPinUpdatedDelegat...
)

Bind a dynamic delegate to the OnMagicLeapARPinUpdated event.

Protected function

void

 

BroadcastOnMagicLeapARPinUpdatedEvent

(
    const TArray< FGuid >& Added,
    const TArray< FGuid >& Updated,
    const TArray< FGuid >& Deleted
)

Public function

EMagicLeapPa...

 

CreateTracker()

Create an ARPin tracker.

Public function

EMagicLeapPa...

 

DestroyTracker()

Destroy an ARPin tracker.

Public function Static

IMagicLeapAR...

 

Get()

Public function

bool

 

GetARPinPositionAndOrientation

(
    const FGuid& PinID,
    FVector& Position,
    FRotator& Orientation,
    bool& PinFoundInEnvironment
)

Returns the world position & orientation of the requested Pin.

Public function

bool

 

GetARPinPositionAndOrientation_TrackingSpace

(
    const FGuid& PinID,
    FVector& Position,
    FRotator& Orientation,
    bool& PinFoundInEnvironment
)

Returns the position & orientation of the requested Pin in tracking space

Public function

EMagicLeapPa...

 

GetARPinState

(
    const FGuid& PinID,
    FMagicLeapARPinState& State
)

Returns the state of the requested Pin.

Public function

EMagicLeapPa...

 

GetAvailableARPins

(
    int32 NumRequested,
    TArray< FGuid >& Pins
)

Returns all the AR Pins currently available.

Public function

EMagicLeapPa...

 

GetClosestARPin

(
    const FVector& SearchPoint,
    FGuid& PinID
)

Returns the Pin closest to the target point passed in.

Public function Static

FName

 

GetModularFeatureName()

Singleton-like access to this module's interface.

Public function

EMagicLeapPa...

 

GetNumAvailableARPins

(
    int32& Count
)

Returns the count of currently available AR Pins.

Public function Const

bool

 

IsTrackerValid()

Is an ARPin tracker already created.

Public function

IMagicLeapAR...

 

OnMagicLeapARPinUpdated()

Getter for the OnMagicLeapARPinUpdated event, should be used to bind and unbind delegated.

Public function

void

 

UnBindToOnMagicLeapARPinUpdatedDelegate

(
    const FMagicLeapARPinUpdatedDelegat...
)

Unbind a dynamic delegate from the OnMagicLeapARPinUpdated event.

Classes

Name

Description

Public class

FMagicLeapARPinUpdatedEvent

Delegate event to report updates in ARPins

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