ARTypes.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Engine/DataAsset.h"
#include "HAL/ThreadSafeBool.h"
#include "ARTypes.generated.h"
 
#define UE_API AUGMENTEDREALITY_API
 
class USceneComponent;
class UARPin;
class UARTrackedGeometry;
class UARLightEstimate;
struct FARTraceResult;
class UTexture2D;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnTrackableAdded, UARTrackedGeometry*);
typedef FOnTrackableAdded::FDelegate FOnTrackableAddedDelegate;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnTrackableUpdated, UARTrackedGeometry*);
typedef FOnTrackableUpdated::FDelegate FOnTrackableUpdatedDelegate;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnTrackableRemoved, UARTrackedGeometry*);
typedef FOnTrackableRemoved::FDelegate FOnTrackableRemovedDelegate;
 
 
UENUM(BlueprintType, Category="AR AugmentedReality", meta=(Experimental))
enum class EARTrackingState : uint8
{
    Unknown,
    
    Tracking,
    
    NotTracking,
    
    StoppedTracking
};
 
 
UENUM(BlueprintType, Category = "AR AugmentedReality", meta = (Experimental))
enum class EARCaptureType : uint8
{
    Camera,
 
    QRCode,
 
    SpatialMapping,
 
    SceneUnderstanding,
 
    HandMesh,
};
 
 
UENUM( BlueprintType, Category="AR AugmentedReality|Trace Result", meta=(Bitflags) )
enum class EARLineTraceChannels : uint8
{
    None = 0,
    
    FeaturePoint = 1,
    
    GroundPlane = 2,
    
    PlaneUsingExtent = 4,
    
    PlaneUsingBoundaryPolygon = 8
};
ENUM_CLASS_FLAGS(EARLineTraceChannels);
 
 
 
UENUM(BlueprintType, Category="AR AugmentedReality", meta=(Experimental))
enum class EARTrackingQuality : uint8
{
    NotTracking,
    
    OrientationOnly,
    
    OrientationAndPosition
};
 
UENUM(BlueprintType, Category="AR AugmentedReality", meta=(Experimental))
enum class EARTrackingQualityReason : uint8
{
    None,
    
    Initializing,
    
    Relocalizing,
    
    ExcessiveMotion,
    
    InsufficientFeatures,
 
    InsufficientLight,
 
     BadState
};
 
UENUM(BlueprintType, meta=(ScriptName="ARSessionStatusType"))
enum class EARSessionStatus : uint8
{
    NotStarted,
    Running,
    NotSupported,
    FatalError,
    PermissionNotGranted,
    UnsupportedConfiguration,
    Other,
};
 
UENUM(BlueprintType, Category="AR AugmentedReality", meta=(Experimental))
enum class EARWorldMappingState : uint8
{
    NotAvailable,
    StillMappingNotRelocalizable,
    StillMappingRelocalizable,
    Mapped
};
 
UENUM(BlueprintType)
enum class EARPlaneOrientation : uint8
{
    Horizontal,
    Vertical,
    Diagonal,
};
 
UENUM(BlueprintType)
enum class EARObjectClassification : uint8
{
    NotApplicable,
    Unknown,
    Wall,
    Ceiling,
    Floor,
    Table,
    Seat,
    Face,
    Image,
    World,
    SceneObject,
    HandMesh,
    Door,
    Window,
    // Add other types here...
};
 
UENUM(BlueprintType)
enum class EARSpatialMeshUsageFlags : uint8
{
    NotApplicable = 0,
    Visible = 1 << 0,
    Collision = 1 << 1
};
 
UENUM(BlueprintType)
enum class EARJointTransformSpace : uint8
{
    Model,
    
    ParentJoint,
};
 
UENUM(BlueprintType)
enum class EARAltitudeSource : uint8
{
    // The framework sets the altitude using a high-resolution digital-elevation model.
    Precise,
    
    // The framework sets the altitude using a coarse digital-elevation model.
    Coarse,
    
    // The app defines the alitude.
    UserDefined,
    
    // Altitude is not yet set.
    Unknown,
};
 
USTRUCT(BlueprintType)
struct FARSessionStatus
{
public:
    
    GENERATED_BODY()
 
    FARSessionStatus()
    :FARSessionStatus(EARSessionStatus::Other)
    {}
 
    FARSessionStatus(EARSessionStatus InStatus, FString InExtraInfo = FString())
        : AdditionalInfo(InExtraInfo)
        , Status(InStatus)
    {
 
    }
    
    UPROPERTY(BlueprintReadOnly, Category="AR AugmentedReality|Session")
    FString AdditionalInfo;
 
    UPROPERTY(BlueprintReadOnly, Category = "AR AugmentedReality|Session")
    EARSessionStatus Status;
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnARTrackingStateChanged, EARTrackingState, NewTrackingState);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnARTransformUpdated, const FTransform&, OldToNewTransform );
 
UCLASS()
class UARTypesDummyClass : public UObject
{
    GENERATED_BODY()
};
 
class IARRef
{
public:
    virtual void AddRef() = 0;
    virtual void RemoveRef() = 0;
public:
    virtual ~IARRef() {}
 
};
 
UENUM(BlueprintType)
enum class EARCandidateImageOrientation : uint8
{
    Landscape,
    Portrait
};
 
UCLASS(MinimalAPI, BlueprintType)
class UARCandidateImage :
    public UDataAsset
{
    GENERATED_BODY()
 
public:
 
    static UARCandidateImage* CreateNewARCandidateImage(UTexture2D* InCandidateTexture, FString InFriendlyName, float InPhysicalWidth, float InPhysicalHeight, EARCandidateImageOrientation InOrientation)
    {
        UARCandidateImage* NewARCandidateImage = NewObject<UARCandidateImage>();
        NewARCandidateImage->CandidateTexture = InCandidateTexture;
        NewARCandidateImage->FriendlyName = InFriendlyName;
        NewARCandidateImage->Width = InPhysicalWidth;
        NewARCandidateImage->Height = InPhysicalHeight;
        NewARCandidateImage->Orientation = InOrientation;
 
        return NewARCandidateImage;
    }
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Image Detection")
    UTexture2D* GetCandidateTexture() const { return CandidateTexture; }
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Image Detection")
    const FString& GetFriendlyName() const { return FriendlyName; }
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Image Detection")
    float GetPhysicalWidth() const { return Width; }
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Image Detection")
    float GetPhysicalHeight() const { return Height; }
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Image Detection")
    EARCandidateImageOrientation GetOrientation() const { return Orientation; }
 
protected:
#if WITH_EDITOR
    UE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
    
    UPROPERTY(EditAnywhere, Category = "AR Candidate Image")
    TObjectPtr<UTexture2D> CandidateTexture;
 
    UPROPERTY(EditAnywhere, Category = "AR Candidate Image")
    FString FriendlyName;
 
    UPROPERTY(EditAnywhere, Category = "AR Candidate Image")
    float Width;
 
    UPROPERTY(EditAnywhere, Category = "AR Candidate Image")
    float Height;
 
    UPROPERTY(EditAnywhere, Category = "AR Candidate Image")
    EARCandidateImageOrientation Orientation;
};
 
UCLASS(MinimalAPI, BlueprintType)
class UARCandidateObject :
    public UDataAsset
{
    GENERATED_BODY()
    
public:
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Object Detection")
    const TArray<uint8>& GetCandidateObjectData() const { return CandidateObjectData; }
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Object Detection")
    void SetCandidateObjectData(const TArray<uint8>& InCandidateObject) { CandidateObjectData = InCandidateObject; }
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Object Detection")
    const FString& GetFriendlyName() const { return FriendlyName; }
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Object Detection")
    void SetFriendlyName(const FString& NewName) { FriendlyName = NewName; }
 
    UFUNCTION(BlueprintPure, Category = "AR AugmentedReality|Object Detection")
    const FBox& GetBoundingBox() const { return BoundingBox; }
 
    UFUNCTION(BlueprintCallable, Category = "AR AugmentedReality|Object Detection")
    void SetBoundingBox(const FBox& InBoundingBox) { BoundingBox = InBoundingBox; }
 
private:
    UPROPERTY(EditAnywhere, Category = "AR Candidate Object")
    TArray<uint8> CandidateObjectData;
    
    UPROPERTY(EditAnywhere, Category = "AR Candidate Object")
    FString FriendlyName;
    
    UPROPERTY(EditAnywhere, Category = "AR Candidate Image")
    FBox BoundingBox;
};
 
class FARAsyncTask
{
public:
    virtual ~FARAsyncTask() {}
    
    UE_API bool HadError() const;
    UE_API FString GetErrorString() const;
    UE_API bool IsDone() const;
    
protected:
    FThreadSafeBool bIsDone;
    FThreadSafeBool bHadError;
    FString Error;
};
 
class FARSaveWorldAsyncTask :
    public FARAsyncTask
{
public:
    UE_API TArray<uint8> GetSavedWorldData();
    
protected:
    TArray<uint8> WorldData;
};
 
class FARGetCandidateObjectAsyncTask :
    public FARAsyncTask
{
public:
    virtual UARCandidateObject* GetCandidateObject() = 0;
};
 
class FARErrorGetCandidateObjectAsyncTask :
    public FARGetCandidateObjectAsyncTask
{
public:
    FARErrorGetCandidateObjectAsyncTask(FString InError)
    {
        Error = InError;
        bHadError = true;
        bIsDone = true;
    }
    virtual UARCandidateObject* GetCandidateObject() override { return nullptr; }
};
 
class FARErrorSaveWorldAsyncTask :
    public FARSaveWorldAsyncTask
{
public:
    FARErrorSaveWorldAsyncTask(FString InError)
    {
        Error = InError;
        bHadError = true;
        bIsDone = true;
    }
};
 
USTRUCT(BlueprintType)
struct FARVideoFormat
{
    GENERATED_BODY()
 
public:
    FARVideoFormat()
        : FPS(0)
        , Width(0)
        , Height(0)
    {
        
    }
    
    FARVideoFormat(int32 InFPS, int32 InWidth, int32 InHeight)
        : FPS(InFPS)
        , Width(InWidth)
        , Height(InHeight)
    {
        
    }
 
    bool operator==(const FARVideoFormat& Other) const
    {
        return FPS == Other.FPS && Width == Other.Width && Height == Other.Height;
    }
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="AR AugmentedReality|Session")
    int32 FPS;
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "AR AugmentedReality|Session")
    int32 Width;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "AR AugmentedReality|Session")
    int32 Height;
 
    bool IsValidFormat() { return FPS > 0 && Width > 0 && Height > 0; }
 
    friend FArchive& operator<<(FArchive& Ar, FARVideoFormat& Format)
    {
        return Ar << Format.FPS << Format.Width << Format.Height;
    }
};
 
USTRUCT(BlueprintType)
struct FARSkeletonDefinition
{
    GENERATED_BODY()
 
public:
    UPROPERTY(BlueprintReadOnly, Category="AR AugmentedReality|Pose Tracking")
    int32 NumJoints = 0;
    
    UPROPERTY(BlueprintReadOnly, Category = "AR AugmentedReality|Pose Tracking")
    TArray<FName> JointNames;
 
    UPROPERTY(BlueprintReadOnly, Category = "AR AugmentedReality|Pose Tracking")
    TArray<int32> ParentIndices;
};
 
USTRUCT(BlueprintType)
struct FARPose2D
{
    GENERATED_BODY()
 
public:
    UPROPERTY(BlueprintReadOnly, Category="AR AugmentedReality|Pose Tracking")
    FARSkeletonDefinition SkeletonDefinition;
    
    UPROPERTY(BlueprintReadOnly, Category = "AR AugmentedReality|Pose Tracking")
    TArray<FVector2D> JointLocations;
 
    UPROPERTY(BlueprintReadOnly, Category = "AR AugmentedReality|Pose Tracking")
    TArray<bool> IsJointTracked;
};
 
USTRUCT(BlueprintType)
struct FARPose3D
{
    GENERATED_BODY()
 
public:
    UPROPERTY(BlueprintReadOnly, Category="AR AugmentedReality|Pose Tracking")
    FARSkeletonDefinition SkeletonDefinition;
    
    UPROPERTY(BlueprintReadOnly, Category = "AR AugmentedReality|Pose Tracking")
    TArray<FTransform> JointTransforms;
    
    UPROPERTY(BlueprintReadOnly, Category = "AR AugmentedReality|Pose Tracking")
    TArray<bool> IsJointTracked;
    
    UPROPERTY(BlueprintReadOnly, Category = "AR AugmentedReality|Pose Tracking")
    EARJointTransformSpace JointTransformSpace = EARJointTransformSpace::Model;
};
 
 
USTRUCT(BlueprintType)
struct FARCameraIntrinsics
{
    GENERATED_BODY()
 
public:
    UPROPERTY(BlueprintReadOnly, Category="AR AugmentedReality|Camera")
    FIntPoint ImageResolution = FIntPoint::ZeroValue;
    
    UPROPERTY(BlueprintReadOnly, Category="AR AugmentedReality|Camera")
    FVector2D FocalLength = FVector2D::ZeroVector;
    
    UPROPERTY(BlueprintReadOnly, Category="AR AugmentedReality|Camera")
    FVector2D PrincipalPoint = FVector2D::ZeroVector;
};
 
#undef UE_API