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.
bool	AddTrackedPointWithName ( const FTransform& WorldTransform, const FString& PointName, bool bDeletePointsWithSameName )	Manually add a tracked point with name and world transform.
void	CalculateAlignmentTransform ( const FTransform& TransformInFirst..., const FTransform& TransformInSecon..., FTransform& AlignmentTransform )	Computes a transform that aligns two coordinate systems. Requires the transform of the same known point in each coordinate system.
void	CalculateClosestIntersection ( const TArray< FVector >& StartPoin..., const TArray< FVector >& EndPoints, FVector& ClosestIntersection )	Alignment helpers.
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...	FindTrackedPointsByName ( const FString& PointName )
FTransform	GetAlignmentTransform()
TArray< UART...	GetAllGeometries()
TArray< T &#...	GetAllGeometriesByClass()
TArray< UART...	GetAllGeometriesByClass ( TSubclassOf< UARTrackedGeometry > G... )
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()
FARSessionSt...	GetARSessionStatus()	It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly.
UARTexture &...	GetARTexture ( EARTextureType TextureType )
float	GetARWorldScale()
bool	GetCameraIntrinsics ( FARCameraIntrinsics& OutCameraIntr... )
TSharedPtr< ...	GetCandidateObject ( FVector Location, FVector Extent )
UARLightEsti...	GetCurrentLightEstimate()	An AugmentedReality session can be configured to provide light estimates.
int32	GetNumberOfTrackedFacesSupported()
bool	GetObjectClassificationAtLocation ( const FVector& InWorldLocation, EARObjectClassification& OutClassi..., FVector& OutClassificationLocation, float MaxLocationDiff )	Try to determine the classification of the object at a world space location : the world location where the classification is needed : the classification result : the world location at where the classification is calculated : the max distance between the specified world location and the classification location
TArray< FVec...	GetPointCloud()
UARSessionCo...	GetSessionConfig()
TArray< FARV...	GetSupportedVideoFormats ( EARSessionType SessionType )
EARTrackingQ...	GetTrackingQuality()
EARTrackingQ...	GetTrackingQualityReason()
EARWorldMapp...	GetWorldMappingStatus()
bool	IsARPinLocalStoreReady()	Is ARPin Local Store Ready
bool	IsARPinLocalStoreSupported()	Is ARPin Local Store Supported
bool	IsARSupported()	Checks if the current device can support AR
bool	IsSceneReconstructionSupported ( EARSessionType SessionType, EARSceneReconstruction SceneReconst... )
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.
TMap< FName,...	LoadARPinsFromLocalStore()	Load all ARPins from local save
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).
bool	PinComponentToARPin ( USceneComponent* ComponentToPi..., UARPin* Pin )	Associate a component with an ARPin, so that its transform will be updated by the pin.
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	RemoveAllARPinsFromLocalStore()	Remove all ARPins from the local store
void	RemoveARPinFromLocalStore ( FName InSaveName )	Remove an ARPin from the local store
void	RemovePin ( UARPin* PinToRemove )	Remove a pin such that it no longer updates the associated component.
FIntPoint	ResizeXRCamera ( const FIntPoint& InSize )	Change screen size of Mixed Reality Capture camera.
bool	SaveARPinToLocalStore ( FName InSaveName, UARPin* InPin )	Save an ARPin to local store
TSharedPtr< ...	SaveWorld()
void	SetAlignmentTransform ( const FTransform& InAlignmentTrans... )	Set a transform that will be applied to the tracking space.
void	SetARWorldOriginLocationAndRotation ( FVector OriginLocation, FRotator OriginRotation, bool bIsTransformInWorldSpace, bool bMaintainUpDirection )	For a point P in the AR local space, whose location and rotation are "OriginLocation" and "OriginRotation" in the world space modify the alignment transform so that the same point P will be transformed to the origin in the world space.
void	SetARWorldScale ( float InWorldScale )	Helper function that modifies the alignment transform scale so that virtual content in the world space appears to be "scaled".
void	SetEnabledXRCamera ( bool bOnOff )	Enable or disable Mixed Reality Capture camera.
void	StartARSession ( UARSessionConfig* SessionConfi... )	Begin a new Augmented Reality session.
void	StopARSession()	Stop a running Augmented Reality session and clear any state.
bool	ToggleARCapture ( const bool bOnOff, const EARCaptureType CaptureType )	Starts or stops a battery intensive service on device.
void	UnpinComponent ( USceneComponent* ComponentToUn... )	Given a pinned `ComponentToUnpin_, remove its attachment to the real world.

Constants

Name	Description
RegisteredARSystem

Deprecated Functions

	Name	Description
TArray< UARE...	GetAllTrackedEnvironmentCaptureProbes()	GetAllTrackedEnvironmentCaptureProbes is deprecated, use GetAllGeometriesByClass.
TArray< UART...	GetAllTrackedImages()	GetAllTrackedImages is deprecated, use GetAllGeometriesByClass.
TArray< UARP...	GetAllTrackedPlanes()	GetAllTrackedPlanes is deprecated, use GetAllGeometriesByClass.
TArray< UART...	GetAllTrackedPoints()	GetAllTrackedPoints is deprecated, use GetAllGeometriesByClass.
TArray< UART...	GetAllTrackedPoses()	GetAllTrackedPoses is deprecated, use GetAllGeometriesByClass.
UARTextureCa...	GetCameraDepth()	GetCameraDepth is deprecated, use GetARTexture.
UARTextureCa...	GetCameraImage()	GetCameraImage is deprecated, use GetARTexture.
UARTexture &...	GetPersonSegmentationDepthImage()	GetPersonSegmentationDepthImage is deprecated, use GetARTexture.
UARTexture &...	GetPersonSegmentationImage()	GetPersonSegmentationImage is deprecated, use GetARTexture.

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

Take our survey

Dismiss