1. Epic GamesDeveloper
  3. UARBlueprintLibrary

UARBlueprintLibrary

Unreal Engine C++ API Reference > Runtime > AugmentedReality

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UARBlueprintLibrary

References

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

Syntax

UCLASS (Meta=(ScriptName="ARLibrary"))  
class UARBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta bool

AddManualEnvironmentCaptureProbe ( FVector Location,
FVector Extent
)

 Adds an environment capture probe to the ar world
Public function Static FDelegateHandle Static helpers to create the methods needed to add/remove delegates from the AR system.
Public function Static FDelegateHandle  
Public function Static FDelegateHandle  
Public function Static UFunction BlueprintCallable, Category, Meta UARCandidateImage *

AddRuntimeCandidateImage ( UARSessionConfig* SessionConfig,
UTexture2D* CandidateTexture,
FString FriendlyName,
float PhysicalWidth
)

 Create an ARCandidateImage object and add it to the ARCandidateImageList of the given `UARSessionConfig_ object.
Public function Static UFunction BlueprintCallable, Category, Meta bool

AddTrackedPointWithName ( const FTransform& WorldTransform,
const FString& PointName,
bool bDeletePointsWithSameName
)

 Manually add a tracked point with name and world transform.
Public function Static UFunction BlueprintCallable, Category void

CalculateAlignmentTransform ( const FTransform& TransformInFirstCoordinateSystem,
const FTransform& TransformInSecondCoordinateSystem,
FTransform& AlignmentTransform
)

 Computes a transform that aligns two coordinate systems. Requires the transform of the same known point in each coordinate system.
Public function Static UFunction BlueprintCallable, Category void

CalculateClosestIntersection ( const TArray< FVector >& StartPoints,
const TArray< FVector >& EndPoints,
FVector& ClosestIntersection
)

 Alignment helpers.
Public function Static void

ClearOnTrackableAddedDelegate_Handle ( FDelegateHandle& Handle
)

  
Public function Static void  
Public function Static void

ClearOnTrackableRemovedDelegate_Handle ( FDelegateHandle& Handle
)

  
Public function Static void  
Public function Static void

ClearOnTrackableUpdatedDelegate_Handle ( FDelegateHandle& Handle
)

  
Public function Static void  
Public function Static UFunction BlueprintCallable, Category, Meta void

DebugDrawPin ( UARPin* ARPin,
UObject* WorldContextObject,
FLinearColor Color,
float Scale,
float PersistForSeconds
)

 Given a `UARPin_, draw it for debugging purposes.
Public function Static UFunction BlueprintCallable, Category, Meta void

DebugDrawTrackedGeometry ( UARTrackedGeometry* TrackedGeometry,
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)
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UARTrackedPoint * >

FindTrackedPointsByName ( const FString& PointName
)

  
Public function Static UFunction BlueprintPure, Category, Meta FTransform  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UARTrackedGeometry * >  
Public function Static TArray< T * >  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UARTrackedGeometry * >

GetAllGeometriesByClass ( TSubclassOf< UARTrackedGeometry > GeometryClass
)

  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UARPin * > 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.
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FARPose2D >  
Public function Static UFunction BlueprintPure, Category, Meta FARSessionStatus It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly.
Public function Static UFunction BlueprintCallable, Category, Meta UARTexture *

GetARTexture ( EARTextureType TextureType
)

  
Public function Static UFunction BlueprintPure, Category, Meta float  
Public function Static UFunction BlueprintCallable, Category bool

GetCameraIntrinsics ( FARCameraIntrinsics& OutCameraIntrinsics
)

  
Public function Static TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe >

GetCandidateObject ( FVector Location,
FVector Extent
)

  
Public function Static UFunction BlueprintPure, Category UARLightEstimate * An AugmentedReality session can be configured to provide light estimates.
Public function Static UFunction BlueprintCallable, Category int32  
Public function Static UFunction BlueprintCallable, Category bool

GetObjectClassificationAtLocation ( const FVector& InWorldLocation,
EARObjectClassification& OutClassification,
FVector& OutClassificationLocation,
float MaxLocationDiff
)

 Try to determine the classification of the object at a world space location @InWorldLocation: the world location where the classification is needed @OutClassification: the classification result @OutClassificationLocation: the world location at where the classification is calculated @MaxLocationDiff: the max distance between the specified world location and the classification location
Public function Static UFunction BlueprintPure, Category, Meta TArray< FVector >  
Public function Static UFunction BlueprintPure, Category, Meta UARSessionConfig *  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FARVideoFormat >  
Public function Static UFunction BlueprintPure, Category, Meta EARTrackingQuality  
Public function Static UFunction BlueprintPure, Category, Meta EARTrackingQualityReason  
Public function Static UFunction BlueprintPure, Category, Meta EARWorldMappingState  
Public function Static UFunction BlueprintPure, Category, Meta bool Is ARPin Local Store Ready
Public function Static UFunction BlueprintPure, Category, Meta bool Is ARPin Local Store Supported
Public function Static UFunction BlueprintCallable, Category, Meta bool Checks if the current device can support AR
Public function Static UFunction BlueprintPure, Category, Meta bool

IsSceneReconstructionSupported ( EARSessionType SessionType,
EARSceneReconstruction SceneReconstructionMethod
)

  
Public function Static UFunction BlueprintPure, Category, Meta bool  
Public function Static UFunction BlueprintPure, Category, Meta bool Test whether this type of session is supported by the current Augmented Reality platform.
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FARTraceResult >

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.
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FARTraceResult >

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.
Public function Static UFunction BlueprintCallable, Category, Meta TMap< FName, UARPin * > Load all ARPins from local save Note: Multiple loads of a saved pin may result in duplicate pins OR overwritten pins.
Public function Static UFunction BlueprintCallable, Category, Meta void Pause a running Augmented Reality session without clearing existing state.
Public function Static UFunction BlueprintCallable, Category, Meta UARPin *

PinComponent ( USceneComponent* ComponentToPin,
const FTransform& PinToWorldTransform,
UARTrackedGeometry* TrackedGeometry,
const FName DebugName
)

 Pin an Unreal Component to a location in tracking spce (i.e. the real world).
Public function Static UFunction BlueprintCallable, Category, Meta bool

PinComponentToARPin ( USceneComponent* ComponentToPin,
UARPin* Pin
)

 Associate a component with an ARPin, so that its transform will be updated by the pin.
Public function Static UFunction BlueprintCallable, Category, Meta UARPin *

PinComponentToTraceResult ( USceneComponent* ComponentToPin,
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.
Public function Static void

RegisterAsARSystem ( const TSharedRef< FARSupportInterface, ESPMode::ThreadSafe >& NewArSystem
)

  
Public function Static UFunction BlueprintCallable, Category, Meta void Remove all ARPins from the local store
Public function Static UFunction BlueprintCallable, Category, Meta void

RemoveARPinFromLocalStore ( FName InSaveName
)

 Remove an ARPin from the local store
Public function Static UFunction BlueprintCallable, Category, Meta void

RemovePin ( UARPin* PinToRemove
)

 Remove a pin such that it no longer updates the associated component.
Public function Static UFunction BlueprintCallable, Category, Meta FIntPoint

ResizeXRCamera ( const FIntPoint& InSize
)

 Change screen size of Mixed Reality Capture camera.
Public function Static UFunction BlueprintCallable, Category, Meta bool

SaveARPinToLocalStore ( FName InSaveName,
UARPin* InPin
)

 Save an ARPin to local store
Public function Static TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe >  
Public function Static UFunction BlueprintCallable, Category, Meta void

SetAlignmentTransform ( const FTransform& InAlignmentTransform
)

 Set a transform that will be applied to the tracking space.
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category, Meta void

SetARWorldScale ( float InWorldScale
)

 Helper function that modifies the alignment transform scale so that virtual content in the world space appears to be "scaled".
Public function Static UFunction BlueprintCallable, Category, Meta void

SetEnabledXRCamera ( bool bOnOff
)

 Enable or disable Mixed Reality Capture camera.
Public function Static UFunction BlueprintCallable, Category, Meta void

StartARSession ( UARSessionConfig* SessionConfig
)

 Begin a new Augmented Reality session.
Public function Static UFunction BlueprintCallable, Category, Meta void Stop a running Augmented Reality session and clear any state.
Public function Static UFunction BlueprintCallable, Category, Meta bool

ToggleARCapture ( const bool bOnOff,
const EARCaptureType CaptureType
)

 Starts or stops a battery intensive service on device.
Public function Static UFunction BlueprintCallable, Category, Meta void

UnpinComponent ( USceneComponent* ComponentToUnpin
)

 Given a pinned `ComponentToUnpin_, remove its attachment to the real world.

Constants

Name Description
RegisteredARSystem  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.