ARSessionConfig.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "ARTrackable.h"
#include "ARComponent.h"
#include "Engine/DataAsset.h"
 
#include "ARSessionConfig.generated.h"
 
#define UE_API AUGMENTEDREALITY_API
 
class UMaterialInterface;
 
UENUM(BlueprintType, Category="AR AugmentedReality", meta=(Experimental))
enum class EARWorldAlignment : uint8
{
    Gravity,
 
    GravityAndHeading,
 
    Camera
};
 
UENUM(BlueprintType, Category = "AR AugmentedReality", meta = (Experimental))
enum class EARSessionType : uint8
{
    None,
 
    Orientation,
 
    World,
 
    Face,
 
    Image,
 
    ObjectScanning,
    
    PoseTracking,
    
    GeoTracking,
};
 
UENUM(BlueprintType, Category = "AR AugmentedReality", meta = (Experimental, Bitflags))
enum class EARPlaneDetectionMode : uint8
{
    None = 0,
    
    /* Detects horizontal, flat surfaces. */
    HorizontalPlaneDetection = 1,
 
    /* Detects vertical, flat surfaces. */
    VerticalPlaneDetection = 2
};
ENUM_CLASS_FLAGS(EARPlaneDetectionMode);
 
UENUM(BlueprintType, Category = "AR AugmentedReality", meta = (Experimental))
enum class EARLightEstimationMode : uint8
{
    None = 0,
 
    AmbientLightEstimate = 1,
 
    DirectionalLightEstimate = 2
};
 
UENUM(BlueprintType, Category = "AR AugmentedReality", meta = (Experimental))
enum class EARFrameSyncMode : uint8
{
    SyncTickWithCameraImage = 0,
 
    SyncTickWithoutCameraImage = 1,
};
 
UENUM(BlueprintType)
enum class EAREnvironmentCaptureProbeType : uint8
{
    None,
 
    Manual,
 
    Automatic
};
 
UENUM(BlueprintType)
enum class EARFaceTrackingUpdate : uint8
{
    CurvesAndGeo,
 
    CurvesOnly
};
 
UENUM(BlueprintType)
enum class EARSessionTrackingFeature : uint8
{
    None,
    
    PoseDetection2D,
    
    PersonSegmentation,
    
    PersonSegmentationWithDepth,
    
    SceneDepth,
    
    SmoothedSceneDepth,
};
 
UENUM(BlueprintType)
enum class EARSceneReconstruction : uint8
{
    None,
    
    MeshOnly,
    
    MeshWithClassification,
};
 
UCLASS(MinimalAPI, BlueprintType, Category="AR Settings")
class UARSessionConfig : public UDataAsset
{
    GENERATED_BODY()
 
public:
    UE_API UARSessionConfig();
    
public:
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARWorldAlignment GetWorldAlignment() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARSessionType GetSessionType() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARPlaneDetectionMode GetPlaneDetectionMode() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARLightEstimationMode GetLightEstimationMode() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARFrameSyncMode GetFrameSyncMode() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API bool ShouldRenderCameraOverlay() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API bool ShouldEnableCameraTracking() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API bool ShouldEnableAutoFocus() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetEnableAutoFocus(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API bool ShouldResetCameraTracking() const;
    
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetResetCameraTracking(bool bNewValue);
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API bool ShouldResetTrackedObjects() const;
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetResetTrackedObjects(bool bNewValue);
    
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API const TArray<UARCandidateImage*>& GetCandidateImageList() const;
 
    // Add a new CandidateImage to the ARSessionConfig.
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void AddCandidateImage(UARCandidateImage* NewCandidateImage);
    
    // Remove a candidate image from the ARSessionConfig, by pointer, note the image object must match, not the content of the image.
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void RemoveCandidateImage(UARCandidateImage* CandidateImage);
 
    // Remove a candidate image from the ARSessionConfig, by index.
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void RemoveCandidateImageAtIndex(int Index);
 
    // Remove all candidate images from the ARSessionConfig
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void ClearCandidateImages();
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API int32 GetMaxNumSimultaneousImagesTracked() const;
    
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EAREnvironmentCaptureProbeType GetEnvironmentCaptureProbeType() const;
    
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API const TArray<uint8>& GetWorldMapData() const;
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetWorldMapData(TArray<uint8> WorldMapData);
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API const TArray<UARCandidateObject*>& GetCandidateObjectList() const;
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetCandidateObjectList(const TArray<UARCandidateObject*>& InCandidateObjects);
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void AddCandidateObject(UARCandidateObject* CandidateObject);
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API FARVideoFormat GetDesiredVideoFormat() const;
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetDesiredVideoFormat(FARVideoFormat NewFormat);
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARFaceTrackingDirection GetFaceTrackingDirection() const;
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetFaceTrackingDirection(EARFaceTrackingDirection InDirection);
    
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARFaceTrackingUpdate GetFaceTrackingUpdate() const;
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetFaceTrackingUpdate(EARFaceTrackingUpdate InUpdate);
 
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARSessionTrackingFeature GetEnabledSessionTrackingFeature() const;
    
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API EARSceneReconstruction GetSceneReconstructionMethod() const;
    
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetSessionTrackingFeatureToEnable(EARSessionTrackingFeature InSessionTrackingFeature);
    
    UFUNCTION(BlueprintCallable, Category = "AR Settings")
    UE_API void SetSceneReconstructionMethod(EARSceneReconstruction InSceneReconstructionMethod);
 
    bool ShouldDoHorizontalPlaneDetection() const { return bHorizontalPlaneDetection; }
    bool ShouldDoVerticalPlaneDetection() const { return bVerticalPlaneDetection; }
    
    UE_API const TArray<uint8>& GetSerializedARCandidateImageDatabase() const;
 
    UE_API UClass* GetPlaneComponentClass(void) const;
    UE_API UClass* GetPointComponentClass(void) const;
    UE_API UClass* GetFaceComponentClass(void) const;
    UE_API UClass* GetImageComponentClass(void) const;
    UE_API UClass* GetQRCodeComponentClass(void) const;
    UE_API UClass* GetPoseComponentClass(void) const;
    UE_API UClass* GetEnvironmentProbeComponentClass(void) const;
    UE_API UClass* GetObjectComponentClass(void) const;
    UE_API UClass* GetMeshComponentClass(void) const;
    UE_API UClass* GetGeoAnchorComponentClass(void) const;
    
    UMaterialInterface* GetDefaultMeshMaterial() const { return DefaultMeshMaterial; }
    UMaterialInterface* GetDefaultWireframeMeshMaterial() const { return DefaultWireframeMeshMaterial; }
    
    int32 GetMaxNumberOfTrackedFaces() const { return MaxNumberOfTrackedFaces; }
    
    UPROPERTY(EditAnywhere, Category = "AR Settings | World Mapping")
    bool bGenerateMeshDataFromTrackedGeometry;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings | World Mapping")
    bool bGenerateCollisionForMeshData;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings | World Mapping")
    bool bGenerateNavMeshForMeshData;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings | World Mapping")
    bool bUseMeshDataForOcclusion;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings | World Mapping")
    bool bRenderMeshDataInWireframe;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings | World Mapping")
    bool bTrackSceneObjects;
    
    UPROPERTY(EditAnywhere, Category = "AR Settings | Occlusion")
    bool bUsePersonSegmentationForOcclusion = true;
    
    UPROPERTY(EditAnywhere, Category = "AR Settings | Occlusion")
    bool bUseSceneDepthForOcclusion = false;
    
    UPROPERTY(EditAnywhere, Category = "AR Settings | Image Tracking")
    bool bUseAutomaticImageScaleEstimation = true;
    
    UPROPERTY(EditAnywhere, Category = "AR Settings")
    bool bUseStandardOnboardingUX = false;
    
    UE_API bool ShouldUseOptimalVideoFormat() const;
 
private:
    //~ UObject interface
    UE_API virtual void Serialize(FArchive& Ar) override;
    //~ UObject interface
 
protected:
    UPROPERTY(EditAnywhere, Category = "AR Settings")
    EARWorldAlignment WorldAlignment;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings")
    EARSessionType SessionType;
 
    UPROPERTY()
    EARPlaneDetectionMode PlaneDetectionMode_DEPRECATED;
    
    UPROPERTY(EditAnywhere, Category = "AR Settings")
    bool bHorizontalPlaneDetection;
    
    UPROPERTY(EditAnywhere, Category = "AR Settings")
    bool bVerticalPlaneDetection;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings")
    bool bEnableAutoFocus;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings")
    EARLightEstimationMode LightEstimationMode;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = "AR Settings")
    EARFrameSyncMode FrameSyncMode;
 
    UPROPERTY(EditAnywhere, Category="AR Settings")
    bool bEnableAutomaticCameraOverlay;
 
    UPROPERTY(EditAnywhere, Category="AR Settings")
    bool bEnableAutomaticCameraTracking;
 
    UPROPERTY(EditAnywhere, Category="AR Settings")
    bool bResetCameraTracking;
    
    UPROPERTY(EditAnywhere, Category="AR Settings")
    bool bResetTrackedObjects;
    
    UPROPERTY(EditAnywhere, Category="AR Settings | Image Tracking")
    TArray<TObjectPtr<UARCandidateImage>> CandidateImages;
 
    UPROPERTY(EditAnywhere, Category="AR Settings | Image Tracking")
    int32 MaxNumSimultaneousImagesTracked;
    
    UPROPERTY(EditAnywhere, Category="AR Settings")
    EAREnvironmentCaptureProbeType EnvironmentCaptureProbeType;
 
    UPROPERTY(VisibleAnywhere, Category="AR Settings | World Mapping")
    TArray<uint8> WorldMapData;
 
    UPROPERTY(EditAnywhere, Category="AR Settings")
    TArray<TObjectPtr<UARCandidateObject>> CandidateObjects;
 
    UPROPERTY(EditAnywhere, Category="AR Settings")
    FARVideoFormat DesiredVideoFormat;
    
    UPROPERTY(EditAnywhere, Category="AR Settings")
    bool bUseOptimalVideoFormat = true;
    
    UPROPERTY(EditAnywhere, Category="Face AR Settings")
    EARFaceTrackingDirection FaceTrackingDirection;
 
    UPROPERTY(EditAnywhere, Category="Face AR Settings")
    EARFaceTrackingUpdate FaceTrackingUpdate;
    
    UPROPERTY(EditAnywhere, Category="Face AR Settings")
    int32 MaxNumberOfTrackedFaces = 1;
    
    UPROPERTY()
    TArray<uint8> SerializedARCandidateImageDatabase;
    
    UPROPERTY(EditAnywhere, Category="AR Settings")
    EARSessionTrackingFeature EnabledSessionTrackingFeature = EARSessionTrackingFeature::None;
    
    UPROPERTY(EditAnywhere, Category="AR Settings")
    EARSceneReconstruction SceneReconstructionMethod = EARSceneReconstruction::None;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARPlaneComponent> PlaneComponentClass;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARPointComponent> PointComponentClass;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARFaceComponent> FaceComponentClass;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARImageComponent> ImageComponentClass;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARQRCodeComponent> QRCodeComponentClass;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARPoseComponent> PoseComponentClass;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UAREnvironmentProbeComponent> EnvironmentProbeComponentClass;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARObjectComponent> ObjectComponentClass;
 
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARMeshComponent> MeshComponentClass;
    
    UPROPERTY(EditAnywhere, Category = "AR Gameplay")
    TSubclassOf<UARGeoAnchorComponent> GeoAnchorComponentClass;
    
    UPROPERTY(EditAnywhere, Category = "AR Settings | World Mapping")
    TObjectPtr<UMaterialInterface> DefaultMeshMaterial;
 
    UPROPERTY(EditAnywhere, Category = "AR Settings | World Mapping")
    TObjectPtr<UMaterialInterface> DefaultWireframeMeshMaterial;
};
 
#undef UE_API