ARSystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "ARTypes.h"
#include "ARSessionConfig.h"
#include "Engine/Engine.h" // for FWorldContext
 
class UARPin;
class UARTexture;
class UARTrackedGeometry;
class UARSessionConfig;
class UARTextureCameraImage;
class UARTextureCameraDepth;
struct FARTraceResult;
enum class EARTextureType : uint8;
 
#define DEFINE_AR_DELEGATE_BASE(DelegateName) \
private: \
    F##DelegateName DelegateName##Delegates; \
public: \
    virtual FDelegateHandle Add##DelegateName##Delegate_Handle(const F##DelegateName##Delegate& Delegate) \
    { \
        DelegateName##Delegates.Add(Delegate); \
        return Delegate.GetHandle(); \
    } \
    virtual void Clear##DelegateName##Delegate_Handle(FDelegateHandle& Handle) \
    { \
        DelegateName##Delegates.Remove(Handle); \
        Handle.Reset(); \
    } \
    virtual void Clear##DelegateName##Delegates(FDelegateUserObject Object) \
    { \
        DelegateName##Delegates.RemoveAll(Object); \
    }
 
//need to move refactor some class hierarchies to make this protected again
#define DEFINE_AR_DELEGATE_ONE_PARAM(DelegateName, Param1Type) \
    DEFINE_AR_DELEGATE_BASE(DelegateName) \
public: \
    virtual void Trigger##DelegateName##Delegates(Param1Type Param1) \
    { \
        DelegateName##Delegates.Broadcast(Param1); \
    } \
public:
 
 
class IARSystemSupport
{
public:
    virtual void OnARSystemInitialized(){};
 
    virtual bool OnStartARGameFrame(FWorldContext& WorldContext) { return false;  };
 
    virtual EARTrackingQuality OnGetTrackingQuality() const = 0;
    
    virtual EARTrackingQualityReason OnGetTrackingQualityReason() const = 0;
    
    virtual void OnStartARSession(UARSessionConfig* SessionConfig) = 0;
 
    virtual void OnPauseARSession() = 0;
 
    virtual void OnStopARSession() = 0;
 
    virtual FARSessionStatus OnGetARSessionStatus() const = 0;
    
    virtual bool IsARAvailable() const = 0;
    
    virtual void OnSetAlignmentTransform(const FTransform& InAlignmentTransform) = 0;
    
    virtual TArray<FARTraceResult> OnLineTraceTrackedObjects( const FVector2D ScreenCoord, EARLineTraceChannels TraceChannels ) = 0;
    virtual TArray<FARTraceResult> OnLineTraceTrackedObjects( const FVector Start, const FVector End, EARLineTraceChannels TraceChannels ) = 0;
    
    virtual TArray<UARTrackedGeometry*> OnGetAllTrackedGeometries() const = 0;
    
    virtual TArray<UARPin*> OnGetAllPins() const = 0;
 
    virtual bool OnIsTrackingTypeSupported(EARSessionType SessionType) const = 0;
 
    virtual bool OnToggleARCapture(const bool bOnOff, const EARCaptureType CaptureType) { return false; };
 
    virtual void OnSetEnabledXRCamera(bool bOnOff) {};
    virtual FIntPoint OnResizeXRCamera(const FIntPoint& InSize) { return FIntPoint(0, 0); }
 
    virtual UARLightEstimate* OnGetCurrentLightEstimate() const = 0;
 
    virtual UARPin* FindARPinByComponent(const USceneComponent* Component) const = 0;
 
    virtual UARPin* OnPinComponent(USceneComponent* ComponentToPin, const FTransform& PinToWorldTransform, UARTrackedGeometry* TrackedGeometry = nullptr, const FName DebugName = NAME_None) = 0;
    
    virtual bool OnPinComponentToARPin(USceneComponent* ComponentToPin, UARPin* Pin) = 0;
 
    virtual void OnRemovePin(UARPin* PinToRemove) = 0;
 
    virtual bool OnTryGetOrCreatePinForNativeResource(void* InNativeResource, const FString& InPinName, UARPin*& OutPin) { OutPin = nullptr;  return false; }
 
    virtual bool OnAddManualEnvironmentCaptureProbe(FVector Location, FVector Extent) = 0;
    
    virtual TSharedPtr<FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe> OnGetCandidateObject(FVector Location, FVector Extent) const = 0;
 
    virtual TSharedPtr<FARSaveWorldAsyncTask, ESPMode::ThreadSafe> OnSaveWorld() const = 0;
    
    virtual EARWorldMappingState OnGetWorldMappingStatus() const = 0;
    
    virtual TArray<FARVideoFormat> OnGetSupportedVideoFormats(EARSessionType SessionType) const = 0;
    
    virtual TArray<FVector> OnGetPointCloud() const = 0;
    
    virtual bool OnAddRuntimeCandidateImage(UARSessionConfig* SessionConfig, UTexture2D* CandidateTexture, FString FriendlyName, float PhysicalWidth) = 0;
 
    virtual void* GetARSessionRawPointer() = 0;
    virtual void* GetGameThreadARFrameRawPointer() = 0;
    
    virtual bool OnIsSessionTrackingFeatureSupported(EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature) const { return false; }
    
    virtual TArray<FARPose2D> OnGetTracked2DPose() const { return {}; }
    
    virtual bool OnIsSceneReconstructionSupported(EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod) const { return false; }
    
    virtual bool OnAddTrackedPointWithName(const FTransform& WorldTransform, const FString& PointName, bool bDeletePointsWithSameName) { return false; }
    
    virtual int32 OnGetNumberOfTrackedFacesSupported() const { return 1; }
    
    virtual UARTexture* OnGetARTexture(EARTextureType TextureType) const { return nullptr; }
    
    virtual ~IARSystemSupport(){}
 
    DEFINE_AR_DELEGATE_ONE_PARAM(OnTrackableAdded, UARTrackedGeometry* /* Added */);
 
    DEFINE_AR_DELEGATE_ONE_PARAM(OnTrackableUpdated, UARTrackedGeometry* /* Updated */);
 
    DEFINE_AR_DELEGATE_ONE_PARAM(OnTrackableRemoved, UARTrackedGeometry* /* Removed */);
 
    // ARPin Local Store support.
    // Some Platforms/Devices have the ability to persist AR Anchors (real world positiosn) to the device or user account.
    // They are saved and loaded with a string identifier.
 
    virtual bool IsLocalPinSaveSupported() const
    {
        return false;
    }
 
    virtual bool ArePinsReadyToLoad()
    {
        //UE_LOG(LogHMD, Log, TEXT("Pin Local Store is not supported on this platform"));
        return false;
    }
 
    virtual void LoadARPins(TMap<FName, UARPin*>& LoadedPins)
    {
        //UE_LOG(LogHMD, Log, TEXT("Pin Local Store is not supported on this platform"));
    }
    virtual bool SaveARPin(FName InName, UARPin* InPin)
    {
        //UE_LOG(LogHMD, Log, TEXT("Pin Local Store is not supported on this platform"));
        return false;
    }
    virtual void RemoveSavedARPin(FName InName)
    {
        //UE_LOG(LogHMD, Log, TEXT("Pin Local Store is not supported on this platform"));
    }
    virtual void RemoveAllSavedARPins()
    {
        //UE_LOG(LogHMD, Log, TEXT("Pin Local Store is not supported on this platform"));
    }
    
    virtual bool OnGetCameraIntrinsics(FARCameraIntrinsics& OutCameraIntrinsics) const { return false; }
};