ARSupportInterface.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "ARTypes.h"
#include "ARSessionConfig.h"
#include "ARTextures.h"
#include "Engine/Engine.h" // for FWorldContext
 
#define UE_API AUGMENTEDREALITY_API
 
class IARSystemSupport;
class IXRTrackingSystem;
 
DECLARE_MULTICAST_DELEGATE(FARSystemOnSessionStarted);
DECLARE_MULTICAST_DELEGATE_OneParam(FARSystemOnAlignmentTransformUpdated, const FTransform&);
 
#define DECLARE_AR_SI_DELEGATE_FUNCS(DelegateName) \
public: \
    UE_API FDelegateHandle Add##DelegateName##Delegate_Handle(const F##DelegateName##Delegate& Delegate); \
    UE_API void Clear##DelegateName##Delegate_Handle(FDelegateHandle& Handle); \
    UE_API void Clear##DelegateName##Delegates(FDelegateUserObject Object);
 
class FARSupportInterface : public TSharedFromThis<FARSupportInterface, ESPMode::ThreadSafe>, public FGCObject, public IModularFeature
{
public:
    UE_API FARSupportInterface (IARSystemSupport* InARImplementation, IXRTrackingSystem* InXRTrackingSystem);
    UE_API virtual ~FARSupportInterface ();
 
 
    static FName GetModularFeatureName()
    {
        static const FName ModularFeatureName = FName(TEXT("ARSystem"));
        return ModularFeatureName;
    }
 
    UE_API void InitializeARSystem();
    UE_API IXRTrackingSystem* GetXRTrackingSystem();
 
    UE_API bool StartARGameFrame(FWorldContext& WorldContext);
 
    UE_API const FTransform& GetAlignmentTransform() const;
    UE_API const UARSessionConfig& GetSessionConfig() const;
    UE_API UARSessionConfig& AccessSessionConfig();
 
    UE_API EARTrackingQuality GetTrackingQuality() const;
    UE_API EARTrackingQualityReason GetTrackingQualityReason() const;
    UE_API void StartARSession(UARSessionConfig* InSessionConfig);
    UE_API void PauseARSession();
    UE_API void StopARSession();
    UE_API FARSessionStatus GetARSessionStatus() const;
    UE_API bool IsSessionTypeSupported(EARSessionType SessionType) const;
 
    UE_API bool ToggleARCapture(const bool bOnOff, const EARCaptureType CaptureType);
 
    UE_API void SetEnabledXRCamera(bool bOnOff);
    UE_API FIntPoint ResizeXRCamera(const FIntPoint& InSize);
 
    UE_API void SetAlignmentTransform(const FTransform& InAlignmentTransform);
 
    UE_API TArray<FARTraceResult> LineTraceTrackedObjects(const FVector2D ScreenCoords, EARLineTraceChannels TraceChannels);
    UE_API TArray<FARTraceResult> LineTraceTrackedObjects(const FVector Start, const FVector End, EARLineTraceChannels TraceChannels);
    UE_API TArray<UARTrackedGeometry*> GetAllTrackedGeometries() const;
    UE_API TArray<UARPin*> GetAllPins() const;
    UE_API bool IsEnvironmentCaptureSupported() const;
    UE_API bool AddManualEnvironmentCaptureProbe(FVector Location, FVector Extent);
    UE_API TSharedPtr<FARGetCandidateObjectAsyncTask, ESPMode::ThreadSafe> GetCandidateObject(FVector Location, FVector Extent) const;
    UE_API TSharedPtr<FARSaveWorldAsyncTask, ESPMode::ThreadSafe> SaveWorld() const;
    UE_API EARWorldMappingState GetWorldMappingStatus() const;
 
    UE_API UARLightEstimate* GetCurrentLightEstimate() const;
 
    UE_API UARPin* PinComponent(USceneComponent* ComponentToPin, const FTransform& PinToWorldTransform, UARTrackedGeometry* TrackedGeometry = nullptr, const FName DebugName = NAME_None);
    UE_API UARPin* PinComponent(USceneComponent* ComponentToPin, const FARTraceResult& HitResult, const FName DebugName = NAME_None);
    UE_API void RemovePin(UARPin* PinToRemove);
    UE_API bool TryGetOrCreatePinForNativeResource(void* InNativeResource, const FString& InAnchorName, UARPin*& OutAnchor);
 
    UE_API TArray<FARVideoFormat> GetSupportedVideoFormats(EARSessionType SessionType = EARSessionType::World) const;
 
    UE_API TArray<FVector> GetPointCloud() const;
 
    UE_API UARCandidateImage* AddRuntimeCandidateImage(UARSessionConfig* SessionConfig, UTexture2D* CandidateTexture, FString FriendlyName, float PhysicalWidth);
 
    UE_API void* GetARSessionRawPointer();
    UE_API void* GetGameThreadARFrameRawPointer();
    
    UE_API bool IsSessionTrackingFeatureSupported(EARSessionType SessionType, EARSessionTrackingFeature SessionTrackingFeature) const;
    
    UE_API TArray<FARPose2D> GetTracked2DPose() const;
    
    UE_API bool IsSceneReconstructionSupported(EARSessionType SessionType, EARSceneReconstruction SceneReconstructionMethod) const;
    
    UE_API bool AddTrackedPointWithName(const FTransform& WorldTransform, const FString& PointName, bool bDeletePointsWithSameName);
    
    UE_API int32 GetNumberOfTrackedFacesSupported() const;
    
    UE_API UARTexture* GetARTexture(EARTextureType TextureType) const;
    
    UE_API bool GetCameraIntrinsics(FARCameraIntrinsics& OutCameraIntrinsics) const;
    
    UE_API bool IsARAvailable() const;
 
    //~ FGCObject
    UE_API virtual void AddReferencedObjects(FReferenceCollector& Collector) override;
    virtual FString GetReferencerName() const override
    {
        return TEXT("FARSupportInterface");
    }
    //~ FGCObject
 
    // Pass through helpers to create the methods needed to add/remove delegates from the AR system
    DECLARE_AR_SI_DELEGATE_FUNCS(OnTrackableAdded)
    DECLARE_AR_SI_DELEGATE_FUNCS(OnTrackableUpdated)
    DECLARE_AR_SI_DELEGATE_FUNCS(OnTrackableRemoved)
    // End helpers
 
    
    UE_API bool PinComponent(USceneComponent* ComponentToPin, UARPin* Pin);
    UE_API bool IsLocalPinSaveSupported() const;
    UE_API bool ArePinsReadyToLoad();
    UE_API void LoadARPins(TMap<FName, UARPin*>& LoadedPins);
    UE_API bool SaveARPin(FName InName, UARPin* InPin);
    UE_API void RemoveSavedARPin(FName InName);
    UE_API void RemoveAllSavedARPins();
 
 
    FARSystemOnSessionStarted OnARSessionStarted;
    FARSystemOnAlignmentTransformUpdated OnAlignmentTransformUpdated;
 
private:
    IARSystemSupport* ARImplemention;
    IXRTrackingSystem* XRTrackingSystem;
 
    FTransform AlignmentTransform;
    TObjectPtr<UARSessionConfig> ARSettings;
};
 
#undef UE_API