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 > Runtime > AugmentedReality > UARBlueprintLibrary

Light Theme

Dark Theme

UARBlueprintLibrary

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UARBlueprintLibrary

References

Module	AugmentedReality
Header	/Engine/Source/Runtime/AugmentedReality/Public/ARBlueprintLibrary.h
Include	#include "ARBlueprintLibrary.h"

Syntax

class UARBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

	Name	Description
bool	AddManualEnvironmentCaptureProbe ( FVector Location, FVector Extent )	Adds an environment capture probe to the ar world
FDelegateHan...	AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate& D... )	Static helpers to create the methods needed to add/remove delegates from the AR system.
FDelegateHan...	AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate&... )
FDelegateHan...	AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate&... )
UARCandidate...	AddRuntimeCandidateImage ( UARSessionConfig* SessionConfi..., UTexture2D* CandidateTexture, FString FriendlyName, float PhysicalWidth )	Create an ARCandidateImage object and add it to the ARCandidateImageList of the given `UARSessionConfig_ object.
void	ClearOnTrackableAddedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableAddedDelegates ( void* Object )
void	ClearOnTrackableRemovedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableRemovedDelegates ( void* Object )
void	ClearOnTrackableUpdatedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnTrackableUpdatedDelegates ( void* Object )
void	DebugDrawPin ( UARPin* ARPin, UObject* WorldContextObject, FLinearColor Color, float Scale, float PersistForSeconds )	Given a `UARPin_, draw it for debugging purposes.
void	DebugDrawTrackedGeometry ( UARTrackedGeometry* TrackedGeo..., UObject* WorldContextObject, FLinearColor Color, float OutlineThickness, float PersistForSeconds )	Given some real-world geometry being tracked by the Augmented Reality system, draw it on the screen for debugging purposes (rudimentary)
TArray< UART...	GetAllGeometries()
TArray< UARP...	GetAllPins()	Get a list of all the `UARPin_ objects that the Augmented Reality session is currently using to connect virtual objects to real-world, tracked locations.
TArray< FARP...	GetAllTracked2DPoses()
TArray< UARE...	GetAllTrackedEnvironmentCaptureProbes()
TArray< UART...	GetAllTrackedImages()
TArray< UARP...	GetAllTrackedPlanes()
TArray< UART...	GetAllTrackedPoints()
TArray< UART...	GetAllTrackedPoses()
FARSessionSt...	GetARSessionStatus()	It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly.
UARTextureCa...	GetCameraDepth()
UARTextureCa...	GetCameraImage()
TSharedPtr< ...	GetCandidateObject ( FVector Location, FVector Extent )
UARLightEsti...	GetCurrentLightEstimate()	An AugmentedReality session can be configured to provide light estimates.
UARTextureCa...	GetPersonSegmentationDepthImage()
UARTextureCa...	GetPersonSegmentationImage()
TArray< FVec...	GetPointCloud()
UARSessionCo...	GetSessionConfig()
TArray< FARV...	GetSupportedVideoFormats ( EARSessionType SessionType )
EARTrackingQ...	GetTrackingQuality()
EARTrackingQ...	GetTrackingQualityReason()
EARWorldMapp...	GetWorldMappingStatus()
bool	IsARSupported()	Checks if the current device can support AR
bool	IsSessionTrackingFeatureSupported ( EARSessionType SessionType, EARSessionTrackingFeature SessionTr... )
bool	IsSessionTypeSupported ( EARSessionType SessionType )	Test whether this type of session is supported by the current Augmented Reality platform.
TArray< FART...	LineTraceTrackedObjects ( const FVector2D ScreenCoord, bool bTestFeaturePoints, bool bTestGroundPlane, bool bTestPlaneExtents, bool bTestPlaneBoundaryPolygon )	Perform a line trace against any real-world geometry as tracked by the AR system.
TArray< FART...	LineTraceTrackedObjects3D ( const FVector Start, const FVector End, bool bTestFeaturePoints, bool bTestGroundPlane, bool bTestPlaneExtents, bool bTestPlaneBoundaryPolygon )	Perform a line trace against any real-world geometry as tracked by the AR system.
void	PauseARSession()	Pause a running Augmented Reality session without clearing existing state.
UARPin *	PinComponent ( USceneComponent* ComponentToPi..., const FTransform& PinToWorldTransf..., UARTrackedGeometry* TrackedGeo..., const FName DebugName )	Pin an Unreal Component to a location in tracking spce (i.e. the real world).
UARPin *	PinComponentToTraceResult ( USceneComponent* ComponentToPi..., const FARTraceResult& TraceResult, const FName DebugName )	A convenient version of `[PinComponent()](API\Runtime\AugmentedReality\UARBlueprintLibrary\PinComponent)_ that can be used in conjunction with a result of a` LineTraceTrackedObjects_ call.
void	RegisterAsARSystem ( const TSharedRef< FARSupportInterfa... )
void	RemovePin ( UARPin* PinToRemove )	Remove a pin such that it no longer updates the associated component.
TSharedPtr< ...	SaveWorld()
void	SetAlignmentTransform ( const FTransform& InAlignmentTrans... )	Set a transform that will be applied to the tracking space.
void	StartARSession ( UARSessionConfig* SessionConfi... )	Begin a new Augmented Reality session.
void	StopARSession()	Stop a running Augmented Reality session and clear any state.
void	UnpinComponent ( USceneComponent* ComponentToUn... )	Given a pinned `ComponentToUnpin_, remove its attachment to the real world.

Constants

Name	Description
RegisteredARSystem

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

Take our survey

Dismiss