ARBlueprintLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Kismet/BlueprintAsyncActionBase.h"
#include "ARTypes.h"
#include "ARSupportInterface.h"
#include "ARSystem.h"
#include "ARTraceResult.h"
#include "ARSessionConfig.h"
#include "ARTrackable.h"
#include "ARTextures.h"
 
#include "ARBlueprintLibrary.generated.h"
 
#define UE_API AUGMENTEDREALITY_API
 
 
#define DEFINE_AR_BPLIB_DELEGATE_FUNCS(DelegateName) \
public: \
    static FDelegateHandle Add##DelegateName##Delegate_Handle(const F##DelegateName##Delegate& Delegate) \
    { \
        auto ARSystem = GetARSystem(); \
        if (ARSystem.IsValid()) \
        { \
            return ARSystem.Pin()->Add##DelegateName##Delegate_Handle(Delegate); \
        } \
        return Delegate.GetHandle(); \
    } \
    static void Clear##DelegateName##Delegate_Handle(FDelegateHandle& Handle) \
    { \
        auto ARSystem = GetARSystem(); \
        if (ARSystem.IsValid()) \
        { \
            ARSystem.Pin()->Clear##DelegateName##Delegate_Handle(Handle); \
            return; \
        } \
        Handle.Reset(); \
    } \
    static void Clear##DelegateName##Delegates(FDelegateUserObject Object) \
    { \
        auto ARSystem = GetARSystem(); \
        if (ARSystem.IsValid()) \
        { \
            ARSystem.Pin()->Clear##DelegateName##Delegates(Object); \
        } \
    }
 
UCLASS(MinimalAPI, meta=(ScriptName="ARLibrary"))
class UARBlueprintLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Session", meta = (DisplayName="Is AR Supported", Keywords = "ar augmentedreality augmented reality session start run running"))
    static UE_API bool IsARSupported();
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Session", meta = (DisplayName="Start AR Session", Keywords = "ar augmentedreality augmented reality session start run running"))
    static UE_API void StartARSession(UARSessionConfig* SessionConfig);
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Session", meta = (DisplayName="Pause AR Session", Keywords = "ar augmentedreality augmented reality session stop run running"))
    static UE_API void PauseARSession();
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Session", meta = (DisplayName="Stop AR Session", Keywords = "ar augmentedreality augmented reality session stop run running"))
    static UE_API void StopARSession();
    
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Session", meta = (DisplayName="Get AR Session Status", Keywords = "ar augmentedreality augmented reality session start stop run running"))
    static UE_API FARSessionStatus GetARSessionStatus();
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Session", meta = (DisplayName="Get AR Session Config", Keywords = "ar augmentedreality augmented reality session"))
    static UE_API UARSessionConfig* GetSessionConfig();
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Session", meta = (Keywords = "ar augmentedreality augmented reality capture start stop"))
    static UE_API bool ToggleARCapture(const bool bOnOff, const EARCaptureType CaptureType);
 
    UFUNCTION(BlueprintCallable, Category = "AR", meta = (Keywords = "ar all"))
    static UE_API void SetEnabledXRCamera(bool bOnOff);
 
    UFUNCTION(BlueprintCallable, Category = "AR", meta = (Keywords = "ar all"))
    static UE_API FIntPoint ResizeXRCamera(const FIntPoint& InSize);
 
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Alignment", meta = (DisplayName="Set AR Alignment Transform", Keywords = "ar augmentedreality augmented reality tracking alignment"))
    static UE_API void SetAlignmentTransform( const FTransform& InAlignmentTransform );
    
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Trace Result", meta = (AdvancedDisplay="1", Keywords = "ar augmentedreality augmented reality tracking tracing linetrace"))
    static UE_API TArray<FARTraceResult> LineTraceTrackedObjects( const FVector2D ScreenCoord, bool bTestFeaturePoints = true, bool bTestGroundPlane = true, bool bTestPlaneExtents = true, bool bTestPlaneBoundaryPolygon = true );
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Trace Result", meta = (AdvancedDisplay = "1", Keywords = "ar augmentedreality augmented reality tracking tracing linetrace"))
    static UE_API TArray<FARTraceResult> LineTraceTrackedObjects3D(const FVector Start, const FVector End, bool bTestFeaturePoints = true, bool bTestGroundPlane = true, bool bTestPlaneExtents = true, bool bTestPlaneBoundaryPolygon = true);
    
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Tracking", meta = (DisplayName="Get AR Tracking Quality", Keywords = "ar augmentedreality augmented reality tracking quality"))
    static UE_API EARTrackingQuality GetTrackingQuality();
    
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Tracking", meta = (DisplayName="Get AR Tracking Quality Reason", Keywords = "ar augmentedreality augmented reality tracking quality reason"))
    static UE_API EARTrackingQualityReason GetTrackingQualityReason();
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Tracking", meta = (DisplayName="Get All AR Geometries", Keywords = "ar augmentedreality augmented reality tracking geometry anchor"))
    static UE_API TArray<UARTrackedGeometry*> GetAllGeometries();
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Tracking", meta = (DisplayName="Get All AR Geometries By Class", Keywords = "ar augmentedreality augmented reality tracking geometry anchor", DeterminesOutputType = "GeometryClass"))
    static UE_API TArray<UARTrackedGeometry*> GetAllGeometriesByClass(TSubclassOf<UARTrackedGeometry> GeometryClass);
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Texture", meta = (DisplayName="Get AR Texture", Keywords = "ar augmentedreality augmented reality texture"))
    static UE_API UARTexture* GetARTexture(EARTextureType TextureType);
    
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Tracking", meta = (DisplayName="Is AR Session Type Supported", Keywords = "ar augmentedreality augmented reality tracking"))
    static UE_API bool IsSessionTypeSupported(EARSessionType SessionType);
    
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Debug", meta = (WorldContext = "WorldContextObject", AdvancedDisplay="1", Keywords = "ar augmentedreality augmented reality tracked geometry debug draw"))
    static UE_API void DebugDrawTrackedGeometry( UARTrackedGeometry* TrackedGeometry, UObject* WorldContextObject, FLinearColor Color = FLinearColor(1.0f, 1.0f, 0.0f, 0.75f), float OutlineThickness=5.0f, float PersistForSeconds = 0.0f );
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Debug", meta = (WorldContext = "WorldContextObject", AdvancedDisplay="1", Keywords = "ar augmentedreality augmented reality pin debug draw"))
    static UE_API void DebugDrawPin( UARPin* ARPin, UObject* WorldContextObject, FLinearColor Color = FLinearColor(1.0f, 1.0f, 0.0f, 0.75f), float Scale=5.0f, float PersistForSeconds = 0.0f );
    
    
    UFUNCTION( BlueprintPure, Category = "AR AugmentedReality|Light Estimate" )
    static UE_API UARLightEstimate* GetCurrentLightEstimate();
    
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (AdvancedDisplay="3", Keywords = "ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor"))
    static UE_API UARPin* PinComponent( USceneComponent* ComponentToPin, const FTransform& PinToWorldTransform, UARTrackedGeometry* TrackedGeometry = nullptr, const FName DebugName = NAME_None );
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (AdvancedDisplay="2", Keywords = "ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor"))
    static UE_API UARPin* PinComponentToTraceResult( USceneComponent* ComponentToPin, const FARTraceResult& TraceResult, const FName DebugName = NAME_None );
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor"))
    static UE_API bool PinComponentToARPin(USceneComponent* ComponentToPin, UARPin* Pin);
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor"))
    static UE_API void UnpinComponent( USceneComponent* ComponentToUnpin );
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin tracked geometry pinning anchor"))
    static UE_API void RemovePin( UARPin* PinToRemove );
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin anchor"))
    static UE_API TArray<UARPin*> GetAllPins();
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin anchor LocalStore"))
    static UE_API bool IsARPinLocalStoreSupported();
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin anchor LocalStore"))
    static UE_API bool IsARPinLocalStoreReady();
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin anchor LocalStore"))
    static UE_API TMap<FName, UARPin*> LoadARPinsFromLocalStore();
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin anchor LocalStore"))
    static UE_API bool SaveARPinToLocalStore(FName InSaveName, UARPin* InPin);
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin anchor LocalStore"))
    static UE_API void RemoveARPinFromLocalStore(FName InSaveName);
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|ARPin", meta = (Keywords = "ar augmentedreality augmented reality tracking arpin anchor LocalStore"))
    static UE_API void RemoveAllARPinsFromLocalStore();
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Tracking", meta = (DisplayName="Add AR Environment Probe", Keywords = "ar augmentedreality augmented reality tracking anchor"))
    static UE_API bool AddManualEnvironmentCaptureProbe(FVector Location, FVector Extent);
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Tracking", meta = (DisplayName="Get AR World Mapping Status", Keywords = "ar augmentedreality augmented reality tracking anchor"))
    static UE_API EARWorldMappingState GetWorldMappingStatus();
    
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Tracking", meta = (DisplayName="Get AR Point Cloud", Keywords = "ar augmentedreality augmented reality tracking point cloud"))
    static UE_API TArray<FVector> GetPointCloud();
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Capabilities", meta = (DisplayName="Get Supported AR Video Formats", Keywords = "ar augmentedreality augmented reality config video formats"))
    static UE_API TArray<FARVideoFormat> GetSupportedVideoFormats(EARSessionType SessionType);
 
    static UE_API TSharedPtr<FARSaveWorldAsyncTask, ESPMode::ThreadSafe> SaveWorld();
    static UE_API TSharedPtr<FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe> GetCandidateObject(FVector Location, FVector Extent);
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Session", meta = (Keywords = "ar augmentedreality augmented reality candidate image"))
    static UE_API UARCandidateImage* AddRuntimeCandidateImage(UARSessionConfig* SessionConfig, UTexture2D* CandidateTexture, FString FriendlyName, float PhysicalWidth);
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Session", meta = (DisplayName="Is AR Session Tracking Feature Supported", Keywords = "ar augmentedreality augmented reality session tracking feature"))
    static UE_API bool IsSessionTrackingFeatureSupported(EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature);
    
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Session", meta = (DisplayName="Is AR Scene Reconstruction Supported", Keywords = "ar augmentedreality augmented reality session scene reconstruction"))
    static UE_API bool IsSceneReconstructionSupported(EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod);
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Pose Tracking", meta = (DisplayName="Get All AR Tracked 2D Poses", Keywords = "ar augmentedreality augmented reality pose tracking"))
    static UE_API TArray<FARPose2D> GetAllTracked2DPoses();
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Classification")
    static UE_API bool GetObjectClassificationAtLocation(const FVector& InWorldLocation, EARObjectClassification& OutClassification, FVector& OutClassificationLocation, float MaxLocationDiff = 10.f);
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Alignment", meta = (DisplayName="Set AR World Origin Location and Rotation", Keywords = "ar augmentedreality augmented reality world origin"))
    static UE_API void SetARWorldOriginLocationAndRotation(FVector OriginLocation, FRotator OriginRotation, bool bIsTransformInWorldSpace = true, bool bMaintainUpDirection = true);
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Alignment", meta = (DisplayName="Set AR World Scale", Keywords = "ar augmentedreality augmented reality world scale"))
    static UE_API void SetARWorldScale(float InWorldScale);
    
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Alignment", meta = (DisplayName="Get AR World Scale", Keywords = "ar augmentedreality augmented reality world scale"))
    static UE_API float GetARWorldScale();
    
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Alignment", meta = (DisplayName="Get Alignment Transform", Keywords = "ar augmentedreality augmented reality alignment transform"))
    static UE_API FTransform GetAlignmentTransform();
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality", meta = (Keywords = "ar augmentedreality augmented reality add point"))
    static UE_API bool AddTrackedPointWithName(const FTransform& WorldTransform, const FString& PointName, bool bDeletePointsWithSameName = true);
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality", meta = (Keywords = "ar augmentedreality augmented reality find point"))
    static UE_API TArray<UARTrackedPoint*> FindTrackedPointsByName(const FString& PointName);
    
    // Static helpers to create the methods needed to add/remove delegates from the AR system
    DEFINE_AR_BPLIB_DELEGATE_FUNCS(OnTrackableAdded)
    DEFINE_AR_BPLIB_DELEGATE_FUNCS(OnTrackableUpdated)
    DEFINE_AR_BPLIB_DELEGATE_FUNCS(OnTrackableRemoved)
    // End helpers
 
    //Alignment helpers
    UFUNCTION(BlueprintCallable, Category = Alignment)
    static UE_API void CalculateClosestIntersection(const TArray<FVector>& StartPoints, const TArray<FVector>& EndPoints, FVector& ClosestIntersection);
 
    // Computes a transform that aligns two coordinate systems. Requires the transform of the same known point in each coordinate system.
    UFUNCTION(BlueprintCallable, Category = Alignment)
    static UE_API void CalculateAlignmentTransform(const FTransform& TransformInFirstCoordinateSystem, const FTransform& TransformInSecondCoordinateSystem, FTransform& AlignmentTransform);
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Face Tracking")
    static UE_API int32 GetNumberOfTrackedFacesSupported();
    
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Geo Tracking")
    static UE_API bool GetCameraIntrinsics(FARCameraIntrinsics& OutCameraIntrinsics);
    
    template<class T>
    static TArray<T*> GetAllGeometriesByClass()
    {
        TArray<T*> Geometries;
        for (auto Geometry : GetAllGeometries())
        {
            if (auto CastedGeometry = Cast<T>(Geometry))
            {
                Geometries.Add(CastedGeometry);
            }
        }
        return MoveTemp(Geometries);
    }
    
public:
    static UE_API void RegisterAsARSystem(const TSharedRef<FARSupportInterface , ESPMode::ThreadSafe>& NewArSystem);
    
private:
    static UE_API const TWeakPtr<FARSupportInterface , ESPMode::ThreadSafe>& GetARSystem();
    static UE_API TWeakPtr<FARSupportInterface , ESPMode::ThreadSafe> RegisteredARSystem;
};
 
 
UCLASS(MinimalAPI, meta=(ScriptName="ARTraceResultLibrary"))
class UARTraceResultLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
    
    public:
    
    UFUNCTION( BlueprintPure, Category = "AR AugmentedReality|Trace Result" )
    static UE_API float GetDistanceFromCamera( const FARTraceResult& TraceResult );
    
    UFUNCTION( BlueprintPure, Category = "AR AugmentedReality|Trace Result" )
    static UE_API FTransform GetLocalToTrackingTransform( const FARTraceResult& TraceResult );
    
    UFUNCTION( BlueprintPure, Category = "AR AugmentedReality|Trace Result" )
    static UE_API FTransform GetLocalToWorldTransform( const FARTraceResult& TraceResult );
    
    UFUNCTION( BlueprintPure, Category = "AR AugmentedReality|Trace Result" )
    static UE_API FTransform GetLocalTransform( const FARTraceResult& TraceResult );
    
    UFUNCTION( BlueprintPure, Category = "AR AugmentedReality|Trace Result" )
    static UE_API UARTrackedGeometry* GetTrackedGeometry( const FARTraceResult& TraceResult );
    
    UFUNCTION( BlueprintPure, Category = "AR AugmentedReality|Trace Result" )
    static UE_API EARLineTraceChannels GetTraceChannel( const FARTraceResult& TraceResult );
};
 
#undef UE_API