1. Epic GamesDeveloper
  3. UARBlueprintLibrary

UARBlueprintLibrary

API > API/Runtime > API/Runtime/AugmentedReality

   
Name UARBlueprintLibrary
Type class
Header File /Engine/Source/Runtime/AugmentedReality/Public/ARBlueprintLibrary.h
Include Path #include "ARBlueprintLibrary.h"

Syntax

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

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
RegisteredARSystem TWeakPtr< FARSupportInterface, ESPMode::ThreadSafe >   ARBlueprintLibrary.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddManualEnvironmentCaptureProbe ( FVector Location,
FVector Extent
)

 Adds an environment capture probe to the ar world ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Tracking"
  • Meta=(DisplayName="Add AR Environment Probe", Keywords="ar augmentedreality augmented reality tracking anchor")

static FDelegateHandle AddOnTrackableAddedDelegate_Handle ( const FOnTrackableAddedDelegate& Delegate
)

 Static helpers to create the methods needed to add/remove delegates from the AR system. ARBlueprintLibrary.h  

static FDelegateHandle AddOnTrackableRemovedDelegate_Handle ( const FOnTrackableRemovedDelegate& Delegate
)

   ARBlueprintLibrary.h  

static FDelegateHandle AddOnTrackableUpdatedDelegate_Handle ( const FOnTrackableUpdatedDelegate& Delegate
)

   ARBlueprintLibrary.h  

static 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. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Session"
  • Meta=(Keywords="ar augmentedreality augmented reality candidate image")

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

 Manually add a tracked point with name and world transform. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality"
  • Meta=(Keywords="ar augmentedreality augmented reality add point")

static 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. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category=Alignment

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

 Alignment helpers. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category=Alignment

static void ClearOnTrackableAddedDelegate_Handle ( FDelegateHandle& Handle
)

   ARBlueprintLibrary.h  

static void ClearOnTrackableAddedDelegates ( FDelegateUserObject Object
)

   ARBlueprintLibrary.h  

static void ClearOnTrackableRemovedDelegate_Handle ( FDelegateHandle& Handle
)

   ARBlueprintLibrary.h  

static void ClearOnTrackableRemovedDelegates ( FDelegateUserObject Object
)

   ARBlueprintLibrary.h  

static void ClearOnTrackableUpdatedDelegate_Handle ( FDelegateHandle& Handle
)

   ARBlueprintLibrary.h  

static void ClearOnTrackableUpdatedDelegates ( FDelegateUserObject Object
)

   ARBlueprintLibrary.h  

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

 Given a `UARPin_, draw it for debugging purposes. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Debug"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay="1", Keywords="ar augmentedreality augmented reality pin debug draw")

static 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) ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Debug"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay="1", Keywords="ar augmentedreality augmented reality tracked geometry debug draw")

static TArray< UARTrackedPoint * > FindTrackedPointsByName ( const FString& PointName
)

   ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality"
  • Meta=(Keywords="ar augmentedreality augmented reality find point")

static FTransform GetAlignmentTransform()

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Alignment"
  • Meta=(DisplayName="Get Alignment Transform", Keywords="ar augmentedreality augmented reality alignment transform")

static TArray< UARTrackedGeometry * > GetAllGeometries()

   ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Tracking"
  • Meta=(DisplayName="Get All AR Geometries", Keywords="ar augmentedreality augmented reality tracking geometry anchor")

static TArray< T * > GetAllGeometriesByClass ()

   ARBlueprintLibrary.h  

static TArray< UARTrackedGeometry * > GetAllGeometriesByClass ( TSubclassOf< UARTrackedGeometry > GeometryClass
)

   ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Tracking"
  • Meta=(DisplayName="Get All AR Geometries By Class", Keywords="ar augmentedreality augmented reality tracking geometry anchor", DeterminesOutputType="GeometryClass")

static TArray< UARPin * > 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. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin anchor")

static TArray< FARPose2D > GetAllTracked2DPoses()

   ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Pose Tracking"
  • Meta=(DisplayName="Get All AR Tracked 2D Poses", Keywords="ar augmentedreality augmented reality pose tracking")
It is intended that you check the status of the Augmented Reality session on every frame and take action accordingly. ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Session"
  • Meta=(DisplayName="Get AR Session Status", Keywords="ar augmentedreality augmented reality session start stop run running")

static const TWeakPtr< FARSupportInterface, ESPMode::ThreadSafe > & GetARSystem()

   ARBlueprintLibrary.h  

static UARTexture * GetARTexture ( EARTextureType TextureType
)

   ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Texture"
  • Meta=(DisplayName="Get AR Texture", Keywords="ar augmentedreality augmented reality texture")

static float GetARWorldScale()

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Alignment"
  • Meta=(DisplayName="Get AR World Scale", Keywords="ar augmentedreality augmented reality world scale")

static bool GetCameraIntrinsics ( FARCameraIntrinsics& OutCameraIntrinsics
)

   ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Geo Tracking"

static TSharedPtr< FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe > GetCandidateObject ( FVector Location,
FVector Extent
)

   ARBlueprintLibrary.h  
An AugmentedReality session can be configured to provide light estimates. ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Light Estimate"

static int32 GetNumberOfTrackedFacesSupported()

   ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Face Tracking"

static 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 ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Classification"

static TArray< FVector > GetPointCloud()

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Tracking"
  • Meta=(DisplayName="Get AR Point Cloud", Keywords="ar augmentedreality augmented reality tracking point cloud")

static UARSessionConfig * GetSessionConfig()

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Session"
  • Meta=(DisplayName="Get AR Session Config", Keywords="ar augmentedreality augmented reality session")

static TArray< FARVideoFormat > GetSupportedVideoFormats ( EARSessionType SessionType
)

   ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Capabilities"
  • Meta=(DisplayName="Get Supported AR Video Formats", Keywords="ar augmentedreality augmented reality config video formats")

static EARTrackingQuality GetTrackingQuality()

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Tracking"
  • Meta=(DisplayName="Get AR Tracking Quality", Keywords="ar augmentedreality augmented reality tracking quality")

static EARTrackingQualityReason GetTrackingQualityReason()

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Tracking"
  • Meta=(DisplayName="Get AR Tracking Quality Reason", Keywords="ar augmentedreality augmented reality tracking quality reason")

static EARWorldMappingState GetWorldMappingStatus()

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Tracking"
  • Meta=(DisplayName="Get AR World Mapping Status", Keywords="ar augmentedreality augmented reality tracking anchor")

static bool IsARPinLocalStoreReady()

 Is ARPin Local Store Ready ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin anchor LocalStore")

static bool IsARPinLocalStoreSupported()

 Is ARPin Local Store Supported ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin anchor LocalStore")

static bool IsARSupported()

 Checks if the current device can support AR ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Session"
  • Meta=(DisplayName="Is AR Supported", Keywords="ar augmentedreality augmented reality session start run running")

static bool IsSceneReconstructionSupported ( EARSessionType SessionType,
EARSceneReconstruction SceneReconstructionMethod
)

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Session"
  • Meta=(DisplayName="Is AR Scene Reconstruction Supported", Keywords="ar augmentedreality augmented reality session scene reconstruction")

static bool IsSessionTrackingFeatureSupported ( EARSessionType SessionType,
EARSessionTrackingFeature SessionTrackingFeature
)

   ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Session"
  • Meta=(DisplayName="Is AR Session Tracking Feature Supported", Keywords="ar augmentedreality augmented reality session tracking feature")

static bool IsSessionTypeSupported ( EARSessionType SessionType
)

 Test whether this type of session is supported by the current Augmented Reality platform. ARBlueprintLibrary.h
  • BlueprintPure
  • Category="AR AugmentedReality|Tracking"
  • Meta=(DisplayName="Is AR Session Type Supported", Keywords="ar augmentedreality augmented reality tracking")

static 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. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Trace Result"
  • Meta=(AdvancedDisplay="1", Keywords="ar augmentedreality augmented reality tracking tracing linetrace")

static 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. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Trace Result"
  • Meta=(AdvancedDisplay="1", Keywords="ar augmentedreality augmented reality tracking tracing linetrace")

static TMap< FName, UARPin * > LoadARPinsFromLocalStore ()

 Load all ARPins from local save Note: Multiple loads of a saved pin may result in duplicate pins OR overwritten pins. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin anchor LocalStore")

static void PauseARSession()

 Pause a running Augmented Reality session without clearing existing state. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Session"
  • Meta=(DisplayName="Pause AR Session", Keywords="ar augmentedreality augmented reality session stop run running")

static 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). ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(AdvancedDisplay="3", Keywords="ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor")

static bool PinComponentToARPin ( USceneComponent* ComponentToPin,
UARPin* Pin
)

 Associate a component with an ARPin, so that its transform will be updated by the pin. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor")

static UARPin * PinComponentToTraceResult ( USceneComponent* ComponentToPin,
const FARTraceResult& TraceResult,
const FName DebugName
)

 A convenient version of PinComponent()_ that can be used in conjunction with a result of a LineTraceTrackedObjects_ call. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(AdvancedDisplay="2", Keywords="ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor")

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

   ARBlueprintLibrary.h  

static void RemoveAllARPinsFromLocalStore()

 Remove all ARPins from the local store ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin anchor LocalStore")

static void RemoveARPinFromLocalStore ( FName InSaveName
)

 Remove an ARPin from the local store ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin anchor LocalStore")

static void RemovePin ( UARPin* PinToRemove
)

 Remove a pin such that it no longer updates the associated component. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor")

static FIntPoint ResizeXRCamera ( const FIntPoint& InSize
)

 Change screen size of Mixed Reality Capture camera. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR"
  • Meta=(Keywords="ar all")

static bool SaveARPinToLocalStore ( FName InSaveName,
UARPin* InPin
)

 Save an ARPin to local store ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin anchor LocalStore")

static TSharedPtr< FARSaveWorldAsyncTask, ESPMode::ThreadSafe > SaveWorld()

   ARBlueprintLibrary.h  

static void SetAlignmentTransform ( const FTransform& InAlignmentTransform
)

 Set a transform that will be applied to the tracking space. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Alignment"
  • Meta=(DisplayName="Set AR Alignment Transform", Keywords="ar augmentedreality augmented reality tracking alignment")

static 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. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Alignment"
  • Meta=(DisplayName="Set AR World Origin Location and Rotation", Keywords="ar augmentedreality augmented reality world origin")

static void SetARWorldScale ( float InWorldScale
)

 Helper function that modifies the alignment transform scale so that virtual content in the world space appears to be "scaled". ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Alignment"
  • Meta=(DisplayName="Set AR World Scale", Keywords="ar augmentedreality augmented reality world scale")

static void SetEnabledXRCamera ( bool bOnOff
)

 Enable or disable Mixed Reality Capture camera. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR"
  • Meta=(Keywords="ar all")

static void StartARSession ( UARSessionConfig* SessionConfig
)

 Begin a new Augmented Reality session. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Session"
  • Meta=(DisplayName="Start AR Session", Keywords="ar augmentedreality augmented reality session start run running")

static void StopARSession()

 Stop a running Augmented Reality session and clear any state. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Session"
  • Meta=(DisplayName="Stop AR Session", Keywords="ar augmentedreality augmented reality session stop run running")

static bool ToggleARCapture ( const bool bOnOff,
const EARCaptureType CaptureType
)

 Starts or stops a battery intensive service on device. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|Session"
  • Meta=(Keywords="ar augmentedreality augmented reality capture start stop")

static void UnpinComponent ( USceneComponent* ComponentToUnpin
)

 Given a pinned `ComponentToUnpin_, remove its attachment to the real world. ARBlueprintLibrary.h
  • BlueprintCallable
  • Category="AR AugmentedReality|ARPin"
  • Meta=(Keywords="ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page