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

Light Theme

Dark Theme

UMagicLeapARPinComponent

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UMagicLeapARPinComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(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
EMagicLeapAutoP...	AutoPinType	Mode for automatically pinning this component or it's owner actor to real-world.
bool	bShouldPinActor	Pin this component's owner actor instead of just the component itself.
FString	ObjectUID	Unique ID for this component to save the meta data for the Pin and make content persistent.
FPersistentEnti...	OnPersistentEntityPinLost	Fired when an entity loses its pin.
FPersistentEnti...	OnPersistentEntityPinned	Fired when an entity is successfully pinned by this component.
FMagicLeapARPin...	OnPinDataLoadAttemptCompleted
TSubclassOf< UM...	PinDataClass	The user defined save game class associated with this pin.
TSet< EMagicLea...	SearchPinTypes	Pin types to look for when attempting to pin this component.
USphereComponen...	SearchVolume	Volume to search for an ARPin in.
int32	UserIndex	Index to get the save game data for the pin

Constructors

	Name	Description
	UMagicLeapARPinComponent()

Functions

	Name	Description
bool	AttemptPinDataRestoration()	If BeginPlay() is called before app sets ObjectUID (can happen when component is spawned at runtime or actor that includes this component is spawned at runtime), this function can be called to attempt a fresh restoration.
void	AttemptPinDataRestorationAsync()	If BeginPlay() is called before app sets ObjectUID (can happen when component is spawned at runtime or actor that includes this component is spawned at runtime), this function can be called to attempt a fresh restoration.
UMagicLeapAR...	GetPinData ( TSubclassOf< UMagicLeapARPinSaveGam... )	Retrieves the data associated with this pin.
bool	GetPinnedPinID ( FGuid& PinID )	Get the ID of the Pin the entity (component or actor) is currently pinned to.
bool	GetPinState ( FMagicLeapARPinState& State )	Returns the state of this Pin.
bool	IsPinned()	True if an entity (component or actor) is currently pinned by this component.
bool	PinActor ( AActor* ActorToPin )	Deprecated and can no longer be used to pin any actor other than the owner of this component.
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.
bool	PinSceneComponent ( USceneComponent* ComponentToPi... )	Deprecated and can no longer be used to pin any scene component other than itself.
void	PinToBestFit()	Pin this component (or owner actor if bShouldPinActor is true) to the ARPin that is the best fit based on its location and desired type.
bool	PinToID ( const FGuid& PinID )	Pin this component (or owner actor if bShouldPinActor is true) to the specified PinID.
bool	PinToRestoredOrSyncedID()	Pin this component (or owner actor if bShouldPinActor is true) to the PinID that was restored from a previous session or was synced voer the network.
UMagicLeapAR...	TryGetPinData ( TSubclassOf< UMagicLeapARPinSaveGam..., bool& OutPinDataValid )	Tries to retreive the data associated with this pin.
void	UnPin()	Detach or un-pin the currently pinned entity (component) from the real-world.

Overridden from UActorComponent

	Name	Description
void	BeginPlay()	Begins Play for the component.
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Ends gameplay for this component.
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Classes

	Name	Description
	FMagicLeapARPinDataLoadAttemptCompleted	Delegate used to notify that the pin data associated with this component's ObjectUID has been successfully loaded or not.
	FPersistentEntityPinLost	Delegate used to notify the instigating blueprint that an entity (component or actor) has lost a previously obtained pin.
	FPersistentEntityPinned	Delegate used to notify the instigating blueprint that an entity (component or actor) has been successfully pinned to the real-world.

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

Take our survey

Dismiss