Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MagicLeapARPin > IMagicLeapARPinFeature

Light Theme

Dark Theme

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

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.

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

		Name	Description
	FMagicLeapARPin...	GlobalFilter
	FMagicLeapARPin...	OnMagicLeapARPinUpdatedEvent
	FMagicLeapARPin...	OnMagicLeapARPinUpdatedMulti

Constructors

	Name	Description
	IMagicLeapARPinFeature()

Destructors

	Name	Description
	~IMagicLeapARPinFeature()

Functions

	Name	Description
void	AddContentBindingAsync ( const FGuid& PinId, const FString& ObjectId )	Save an ObjectID associated with a given PinID.
EMagicLeapPa...	ARPinIdToString ( const FGuid& ARPinId, FString& Str )
void	BindToOnMagicLeapARPinUpdatedDelegate ( const FMagicLeapARPinUpdatedDelegat... )	Bind a dynamic delegate to the OnMagicLeapARPinUpdated event.
void	BindToOnMagicLeapContentBindingFoundDelegate ( const FMagicLeapContentBindingFound... )	Bind a dynamic delegate to the OnMagicLeapContentBindingFound event.
void	BroadcastOnMagicLeapARPinUpdatedEvent ( const TArray< FGuid >& Added, const TArray< FGuid >& Updated, const TArray< FGuid >& Deleted )
EMagicLeapPa...	CreateTracker()	Create an ARPin tracker.
EMagicLeapPa...	DestroyTracker()	Destroy an ARPin tracker.
IMagicLeapAR...	Get()
bool	GetARPinPositionAndOrientation ( const FGuid& PinID, FVector& Position, FRotator& Orientation, bool& PinFoundInEnvironment )	Returns the world position & orientation of the requested Pin.
bool	GetARPinPositionAndOrientation_TrackingSpace ( const FGuid& PinID, FVector& Position, FRotator& Orientation, bool& PinFoundInEnvironment )	Returns the position & orientation of the requested Pin in tracking space
EMagicLeapPa...	GetARPinState ( const FGuid& PinID, FMagicLeapARPinState& State )	Returns the state of the requested Pin.
EMagicLeapPa...	GetAvailableARPins ( int32 NumRequested, TArray< FGuid >& Pins )	Returns all the AR Pins currently available.
EMagicLeapPa...	GetClosestARPin ( const FVector& SearchPoint, FGuid& PinID )	Returns the Pin closest to the target point passed in.
int32	GetContentBindingSaveGameUserIndex()	Get the user index used to save / load the save game object used for storing all the content bindings (PinID and ObjectID associations in a MagicLeapARPinComponent).
const FMagic...	GetGlobalQueryFilter()	The current filter used when querying pins for updates.
FName	GetModularFeatureName()	Singleton-like access to this module's interface.
EMagicLeapPa...	GetNumAvailableARPins ( int32& Count )	Returns the count of currently available AR Pins.
bool	IsTrackerValid()	Is an ARPin tracker already created.
IMagicLeapAR...	OnMagicLeapARPinUpdated()	Getter for the OnMagicLeapARPinUpdated event, should be used to bind and unbind delegated.
IMagicLeapAR...	OnMagicLeapContentBindingFound()	Getter for the OnMagicLeapContentBindingFound event, should be used to bind and unbind delegates.
EMagicLeapPa...	ParseStringToARPinId ( const FString& PinIdString, FGuid& ARPinId )
EMagicLeapPa...	QueryARPins ( const FMagicLeapARPinQuery& Query, TArray< FGuid >& Pins )	Returns filtered set of Pins based on the informed parameters.
void	RemoveContentBindingAsync ( const FGuid& PinId, const FString& ObjectId )	Remove an ObjectID associated with a given PinID.
void	SetContentBindingSaveGameUserIndex ( int32 UserIndex )	Set the user index to be used to save / load the save game object used for storing all the content bindings (PinID and ObjectID associations in a MagicLeapARPinComponent).
void	SetGlobalQueryFilter ( const FMagicLeapARPinQuery& InGlob... )	Set the filter used to query ARPins at the specified frequency (see UMagicLeapARPinSettings).
void	UnBindToOnMagicLeapARPinUpdatedDelegate ( const FMagicLeapARPinUpdatedDelegat... )	Unbind a dynamic delegate from the OnMagicLeapARPinUpdated event.
void	UnBindToOnMagicLeapContentBindingFoundDelegate ( const FMagicLeapContentBindingFound... )	Unbind a dynamic delegate from the OnMagicLeapContentBindingFound event.

Classes

	Name	Description
	FMagicLeapARPinUpdatedEvent	Delegate event to report updates in ARPins
	FMagicLeapContentBindingFoundEvent	Delegate event to report the foud Content bindings (ObjectIDs of a MagicLeapARPinComponent stored in association with a PinID).

Enums

	Name	Description
	EQueueTaskType

Constants

Name	Description
ContentBindingSaveGameSlotName

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

Take our survey

Dismiss