I3DHConnector.h Source File

instant3Dhub: I3DHConnector.h Source File
instant3Dhub
 
#pragma once
 
#include "CoreMinimal.h"
 
#include "I3DHConnectorAPI.h"
#include "I3DHConnectorStorage.h"
#include "I3DHDataTypes.h"
#include "I3DHVersion.h"
 
#include "Engine/Texture2D.h"
#include "GameFramework/Actor.h"
 
#include "I3DHConnector.generated.h"
 
class AI3DHGeometry;
class UMaterialParameterCollectionInstance;
class FI3DHPageToStaticMeshTask;
class UBodySetup;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FConnectedDelegate);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FConnectErrorDelegate, const FString&, ErrorMessage);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FErrorDelegate, const FString&, ErrorMessage);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FDisconnectedDelegate);
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FClipPlaneCreatedDelegate, int32, ClipPlaneId, AActor*, ClipPlaneActor, bool, OwnEvent);
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FClipPlaneRemovedDelegate, int32, ClipPlaneId, bool, OwnEvent);
 
USTRUCT(BlueprintType, Category = "{instant3Dhub}|Connector")
struct FI3DHConnectOptions
{
    GENERATED_BODY()
 
    
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "{instant3Dhub}|ConnectOptions")
    FString SessionId;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "{instant3Dhub}|ConnectOptions")
    FString RestoreSessionId;
};
 
UCLASS(ClassGroup = "instant3Dhub", MinimalAPI)
class AI3DHConnector : public AActor
{
    GENERATED_BODY()
 
public:
    INSTANT3DHUB_API AI3DHConnector();
 
protected:
    INSTANT3DHUB_API virtual void BeginPlay() override;
    INSTANT3DHUB_API virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
 
    INSTANT3DHUB_API virtual void Tick(float DeltaTime) override;
 
#if WITH_EDITOR
    INSTANT3DHUB_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
    // ----------------------------------------------------------
    // API Accessor
    // ----------------------------------------------------------
public:
    INSTANT3DHUB_API TSharedPtr<FI3DHConnectorAPI> GetAPI() const;
 
    // ----------------------------------------------------------
    // ConnectorAPI
    // ----------------------------------------------------------
public:
    UFUNCTION(BlueprintCallable, BlueprintPure = false, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API void AddNetworkCredentialCookie(const FString& CookieKey, const FString& CookieValue);
 
    UFUNCTION(BlueprintCallable, BlueprintPure = false, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API void RemoveNetworkCredentialCookie(const FString& CookieKey);
 
    UFUNCTION(BlueprintCallable, BlueprintPure = false, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API void AddNetworkCredentialToken(const FString& TokenKey, const FString& TokenValue);
 
    UFUNCTION(BlueprintCallable, BlueprintPure = false, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API void RemoveNetworkCredentialToken(const FString& TokenKey);
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API const TMap<FString, FString>& GetNetworkCredentialCookies() const { return NetworkCredentialCookies; }
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API const TMap<FString, FString>& GetNetworkCredentialTokens() const { return NetworkCredentialTokens; }
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API void ConnectToHub(const FString& HubURL, const FString& SessionId);
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API void ConnectToHubWithOptions(const FString& HubURL, const FI3DHConnectOptions& Options);
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API void Disconnect();
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API bool IsDisconnected() const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API bool IsEstablishingConnectionToHub() const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API bool IsConnectedToHub() const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API FString GetHubURL() const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API FString GetSessionId() const;
 
    UPROPERTY(BlueprintAssignable, Transient, Category = "{instant3Dhub}|Connector")
    FConnectedDelegate OnConnectedDelegate;
 
    UPROPERTY(BlueprintAssignable, Transient, Category = "{instant3Dhub}|Connector")
    FConnectErrorDelegate OnConnectErrorDelegate;
 
    UPROPERTY(BlueprintAssignable, Transient, Category = "{instant3Dhub}|Connector")
    FErrorDelegate OnErrorDelegate;
 
    UPROPERTY(BlueprintAssignable, Transient, Category = "{instant3Dhub}|Connector")
    FDisconnectedDelegate OnDisconnectedDelegate;
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API FMatrix GetOriginToWorldTransform() const;
 
    UFUNCTION(BlueprintCallable, BlueprintPure, Category = "{instant3Dhub}|Connector")
    INSTANT3DHUB_API FMatrix GetWorldToOriginTransform() const;
 
    INSTANT3DHUB_API AActor* GetOriginActor()
    {
        AActor* RootActor = this;
        check(RootActor != nullptr);
        return RootActor;
    }
 
    INSTANT3DHUB_API const AActor* GetOriginActor() const
    {
        const AActor* RootActor = this;
        check(RootActor != nullptr);
        return RootActor;
    }
 
    // ----------------------------------------------------------
    // Internal Connection Helper Functions
    // ----------------------------------------------------------
public:
    void OnBackendConnected_Internal_GameThread(const FString& SessionId);
    void OnBackendError_Internal_GameThread(const FString& ErrorMessage);
 
private:
    void ReportError_Internal_GameThread(const FString& ErrorMessage);
    void ReportConnectError_Internal_GameThread(const FString& ErrorMessage);
    bool Disconnect_Internal_GameThread();
    // ----------------------------------------------------------
    // Debugging Tools
    // ----------------------------------------------------------
 
public:
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Debugging")
    INSTANT3DHUB_API bool RequestRemoteCullerDebugStream();
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Debugging")
    INSTANT3DHUB_API UTexture2D* GetRemoteCullerDebugStreamTexture();
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Debugging")
    INSTANT3DHUB_API const TArray<FI3DHDebugMetric>& GetDebugMetrics();
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Debugging")
    INSTANT3DHUB_API FString GetDebugSessionInfo();
 
    // ----------------------------------------------------------
    // Progress
    // ----------------------------------------------------------
 
public:
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Progress")
    INSTANT3DHUB_API FI3DHClientProgress GetClientProgress();
 
    // ----------------------------------------------------------
    // ClipPlane API
    // ----------------------------------------------------------
public:
    UPROPERTY(BlueprintAssignable, Transient, Category = "{instant3Dhub}|Clip Plane API")
    FClipPlaneCreatedDelegate OnClipPlaneCreatedDelegate;
 
    UPROPERTY(BlueprintAssignable, Transient, Category = "{instant3Dhub}|Clip Plane API")
    FClipPlaneRemovedDelegate OnClipPlaneRemovedDelegate;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.1", ClampMax = "120.0", UIMin = "0.1", UIMax = "120.0"), Category = "{instant3Dhub}|Clip Plane API")
    float ClipPlaneSyncHz = 1.0;
 
    UPROPERTY(EditAnywhere, Category = "{instant3Dhub}|Clip Plane API")
    TSubclassOf<AActor> ClipPlaneActorClass = nullptr;
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Clip Plane API")
    INSTANT3DHUB_API TArray<int32> GetClipPlanes();
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Clip Plane API")
    INSTANT3DHUB_API AActor* FindClipPlaneActor(int32 ClipPlaneId);
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Clip Plane API")
    INSTANT3DHUB_API AActor* GetMainClipPlaneActor();
 
    // ----------------------------------------------------------
    // Drawing API
    // ----------------------------------------------------------
public:
    UPROPERTY(EditAnywhere, Category = "{instant3Dhub}|Drawing API", AdvancedDisplay)
    TObjectPtr<UMaterialInterface> DrawingBaseMaterial{nullptr};
 
    UPROPERTY(EditAnywhere, Category = "{instant3Dhub}|Drawing API", AdvancedDisplay)
    TObjectPtr<class UStaticMesh> DrawingSegmentMesh{nullptr};
 
    UPROPERTY(EditAnywhere, Category = "{instant3Dhub}|Drawing API", AdvancedDisplay)
    TObjectPtr<class UStaticMesh> DrawingJointMesh{nullptr};
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Drawing API", meta = (DisplayName = "Create Drawing Material"))
    INSTANT3DHUB_API UMaterialInterface* GetDrawingMaterial(FLinearColor Color);
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Drawing API")
    INSTANT3DHUB_API class AI3DHDrawing* FindDrawingActor(int32 DrawingHandle);
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Drawing API")
    INSTANT3DHUB_API void SetClipDrawingsByClipPlane(const bool bClipDrawingsByClipPlaneEnabled);
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Drawing API")
    INSTANT3DHUB_API bool GetClipDrawingsByClipPlane();
 
    // ----------------------------------------------------------
    // EditDrawing API
    // ----------------------------------------------------------
public:
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|EditDrawing API")
    virtual void EditDrawing(int32 DrawingHandle, const TScriptInterface<class II3DHEditDrawingInterface>& EditDrawingInterface, bool bIsEditingCopy = false);
 
    // ----------------------------------------------------------
    // InstanceGraph API
    // ----------------------------------------------------------
public:
    UFUNCTION(BlueprintPure, Category = "{instant3Dhub}|Instance Graph API")
    INSTANT3DHUB_API int32 GetGlobalRootNodeId();
 
    // ----------------------------------------------------------
    // Selection API
    // ----------------------------------------------------------
public:
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Selection API")
    INSTANT3DHUB_API TArray<int32> GetSelection();
 
    // ----------------------------------------------------------
    // TransformAuthority API
    // ----------------------------------------------------------
public:
    INSTANT3DHUB_EXPERIMENTAL(0.0.23, "TransformAuthorityAPI is a temporary solution suspect to changes or replacement.")
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Transform Authority", meta = (DisplayName = "Get WorldTransform With Authority (Experimental)"))
    INSTANT3DHUB_API bool GetWorldTransformWithAuthority(const FI3DHTransformAuthorityHandle TransformAuthorityHandle, int32 NodeId, FMatrix& OutWorldTransform);
 
    INSTANT3DHUB_EXPERIMENTAL(0.0.23, "TransformAuthorityAPI is a temporary solution suspect to changes or replacement.")
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Transform Authority", meta = (DisplayName = "Set WorldTransform With Authority (Experimental)"))
    INSTANT3DHUB_API void SetWorldTransformWithAuthority(const FI3DHTransformAuthorityHandle TransformAuthorityHandle, int32 NodeId, const FMatrix& WorldTransform);
 
    INSTANT3DHUB_EXPERIMENTAL(0.0.23, "TransformAuthorityAPI is a temporary solution suspect to changes or replacement.")
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Transform Authority", meta = (DisplayName = "Release TransformAuthority (Experimental)"))
    INSTANT3DHUB_API void ReleaseTransformAuthority(const FI3DHTransformAuthorityHandle TransformAuthorityHandle);
 
    INSTANT3DHUB_EXPERIMENTAL(0.0.23, "TransformAuthorityAPI is a temporary solution suspect to changes or replacement.")
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Transform Authority", meta = (DisplayName = "Is TransformAuthority Active (Experimental)"))
    INSTANT3DHUB_API bool IsTransformAuthorityActive(const FI3DHTransformAuthorityHandle TransformAuthorityHandle) const;
 
    // ----------------------------------------------------------
    // Runtime adjustable performance parameters
    // ----------------------------------------------------------
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "{instant3Dhub}|Connector", meta = (ClampMin = 1, UIMin = 1))
    int32 MaxConversionTasksCreatedPerTick = 8;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "{instant3Dhub}|Connector", meta = (ClampMin = 1, UIMin = 1))
    int32 MaxComponentsCreatedPerTick = 2;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "{instant3Dhub}|Connector", meta = (ClampMin = 0, UIMin = 0, Delta = 1000000))
    int32 TargetedTrianglesOnComponentsWithVisibility = 10000000;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.1", ClampMax = "100.0", UIMin = "0.1", UIMax = "100.0"), Category = "{instant3Dhub}|Connector")
    float CreateComponentsBudgetMs = 5.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (ClampMin = "0.1", ClampMax = "120.0", UIMin = "0.1", UIMax = "120.0"), Category = "{instant3Dhub}|Connector")
    float ViewSyncHz = 5.0;
 
protected:
    UPROPERTY(EditAnywhere, Category = "{instant3Dhub}|Connector")
    TObjectPtr<class UMaterialParameterCollection> I3DHParameterCollection = nullptr;
 
    PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
    UPROPERTY(EditAnywhere, Category = "{instant3Dhub}|Connector")
    TSubclassOf<AI3DHGeometry> GeometryActorClass;
    PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
 
    UPROPERTY(EditAnywhere, Category = "{instant3Dhub}|Connector")
    bool bSpawnedGeometryCastsShadow = false;
 
protected:
    UPROPERTY(VisibleAnywhere, Category = "{instant3Dhub}|Connector")
    TObjectPtr<USceneComponent> RootComponentConnector;
 
    // ----------------------------------------------------------
    // Internal
    // ----------------------------------------------------------
public:
    FI3DHConnectorDrawingStorage& GetDrawingStorage();
    const FI3DHConnectorDrawingStorage& GetDrawingStorage() const;
 
    FI3DHConnectorRenderStorage& GetRenderStorage();
    const FI3DHConnectorRenderStorage& GetRenderStorage() const;
 
    const FI3DHConnectorRenderStats& GetRenderStats() const;
 
    PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
    AI3DHGeometry* FindGeometryActor(int32 RootNodeId);
    PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
 
    UMaterialParameterCollectionInstance* GetI3DHParameterCollectionInstance() const;
 
private:
    TMap<FString, FString> NetworkCredentialCookies;
    TMap<FString, FString> NetworkCredentialTokens;
 
    FString HubURL;
    FString SessionId;
 
    bool bReloadKeyPressedLastFrame = false;
    bool bDebugStreamKeyPressedLastFrame = false;
 
    // Timings for measuring time to first pixel.
    // All values in seconds of platform time.
    //
    // Note that the camera position and orientation can influence the timings
    // via effects on the remote culler. For accurate measurements the camera
    // should be in a fixed position pointing at the scene.
    double ConnectTime;
    double FirstVisibilityTime;
    double FirstActorTime;
 
    // Time estimates for CreateMeshComponents budgeting.
    // The estimates are updated using exponential moving averages.
    // For the physics build we assume (based on our tests) that
    // the constant overhead is negligible and the time is
    // fully dependent on the per-triangle cost.
    // Initial values are based on measurements on my computer.
    double EstimatedSpawnGeometryActorTime = 0.180e-3;       // seconds
    double EstimatedSpawnMeshComponentStaticTime = 0.600e-3; // seconds
    double EstimatedPhysicsBuildTimePerTriangle = 0.240e-6;  // seconds per triangle
 
    FTimerHandle ViewSyncTimer;
 
    UPROPERTY()
    FI3DHConnectorDrawingStorage DrawingStorage;
 
    UPROPERTY()
    FI3DHConnectorRenderStorage RenderStorage;
 
    TArray<FI3DHDebugMetric> DebugMetrics;
    // Timing metrics in milliseconds.
    int32 MetricTimingVisibilityMs = 0;
    int32 MetricTimingGeometryMs = 0;
 
    // API and Backend
    // ----------------------------------------------------------
    TSharedPtr<class FI3DHConnectorAPIImpl> APIImpl;
 
    TSharedPtr<class FI3DHConnectionPromiseImpl> ConnectionPromise;
 
    TSharedPtr<class FI3DHConnectorBackend> ConnectorBackend;
    TSharedPtr<class FI3DHEventBackend> EventBackend;
    TSharedPtr<class FI3DHRenderBackend> RenderBackend;
 
private:
    PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
    AI3DHGeometry* SpawnGeometryActor(AActor* AttachActor, int32 RootNodeId, const struct FI3DHInstanceSpawnProperties& SpawnProperties);
    PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
 
    PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
    UStaticMeshComponent* SpawnMeshComponentFromTask(FI3DHPageInstanceHandle PageInstanceHandle, AI3DHGeometry* AttachActor, const FI3DHPageToStaticMeshTask& Task, double& PhysicsBuildTime);
    PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
 
    void FinishPhysicsAsyncCook(bool bSuccess, UBodySetup* FinishedBodySetup);
 
public:
    void SetAppearance_Internal(const FLinearColor& OverrideColor, EAppearanceURIMode OverrideMode, const TArray<int32>& RootNodeIds);
 
    void SetTransforms_Internal(const TArray<FMatrix>& GlobalTransforms, const TArray<int32>& RootNodeIds);
 
    void SetEnabled_Internal(bool bNewEnabled, const TArray<int32>& RootNodeIds);
 
    void SetVariantEnabled_Internal(bool bNewVariantEnabled, const TArray<int32>& RootNodeIds);
 
    void SetSelected_Internal(bool bNewSelected, const TArray<int32>& RootNodeIds);
 
    void RemoveGeometryActors_Internal(const TArray<int32>& RootNodeIds);
 
private:
    PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
    void UpdateMeshComponentVisibilityAfterActorHiddenInGameStateChange_Internal(AI3DHGeometry* GeometryActor);
    PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
 
    struct HubCameraParameters
    {
        int32 Width;
        int32 Height;
        FMatrix44f ViewMatrix;
        FMatrix44f ProjectionMatrix;
    };
    HubCameraParameters GetHubCameraParamsForPlayer(const APlayerController* PlayerController);
 
    void ViewSyncTimerCallback();
 
private:
    TSharedPtr<class FI3DHEventStreamConnector> EventStreamConnector;
 
private:
    void AddCredentialHeaders(const FString& URL, TMap<FString, FString>& Headers);
    void ToggleDebugStreamOverlayModeInternal();
    void ToggleDebugStreamOverlayEnabledInteral();
 
    TSharedPtr<class FI3DHDebugStreamConnector> DebugStreamConnector;
 
    UPROPERTY(Transient)
    TObjectPtr<class AI3DHDebugStreamOverlay> DebugStreamOverlay;
 
private:
    static bool TestIsValidDrawingMaterial(const UMaterialInterface* DrawingMaterial);
 
};