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 > UMagicLeapARPinFunctionLibrary

Light Theme

Dark Theme

UMagicLeapARPinFunctionLibrary

Copyright Epic Games, Inc. All Rights Reserved.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UMagicLeapARPinFunctionLibrary

References

Module	MagicLeapARPin
Header	/Engine/Plugins/Lumin/MagicLeapPassableWorld/Source/MagicLeapARPin/Public/MagicLeapARPinFunctionLibrary.h
Include	#include "MagicLeapARPinFunctionLibrary.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=MagicLeap)
class UMagicLeapARPinFunctionLibrary : public UBlueprintFunctionLibrary

Remarks

Direct API interface for the Magic Leap Persistent AR Pin tracker system.

Functions

	Name	Description
FString	ARPinIdToString ( const FGuid& ARPinId )
void	BindToOnMagicLeapARPinUpdatedDelegate ( const FMagicLeapARPinUpdatedDelegat... )	Bind a dynamic delegate to the OnMagicLeapARPinUpdated event.
void	BindToOnMagicLeapContentBindingFoundDelegate ( const FMagicLeapContentBindingFound... )	Bind a dynamic delegate to the OnMagicLeapContentBindingFound event.
EMagicLeapPa...	CreateTracker()	Create an ARPin tracker.
EMagicLeapPa...	DestroyTracker()	Destroy an ARPin tracker.
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.
FString	GetARPinStateToString ( const FMagicLeapARPinState& State )
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).
EMagicLeapPa...	GetGlobalQueryFilter ( FMagicLeapARPinQuery& CurrentGloba... )	The current filter used when querying pins for updates.
EMagicLeapPa...	GetNumAvailableARPins ( int32& Count )	Returns the count of currently available AR Pins.
bool	IsTrackerValid()	Is an ARPin tracker already created.
bool	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	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).
EMagicLeapPa...	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.

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

Take our survey

Dismiss