I3DHGeometry.h Source File

instant3Dhub: I3DHGeometry.h Source File
instant3Dhub
 
#pragma once
 
#include "CoreMinimal.h"
 
#include "I3DHDataTypes.h"
#include "I3DHVersion.h"
 
#include "GameFramework/Actor.h"
 
#include "I3DHGeometry.generated.h"
 
class AI3DHConnector;
 
class INSTANT3DHUB_EXPERIMENTAL(1.0.0, "Working with the I3DH Geometry class is only necessary for advanced use-cases. How we expose geometry data is suspected to change in the future.") AI3DHGeometry;
 
enum class EI3DHGeometryMaterialFlags : uint16
{
    None = 0,
    OverrideAppearanceRGB = 1u << 0,
    OverrideAppearanceOpacity = 1u << 1,
    Selected = 1u << 2,
    Hovered = 1u << 3,
    
    Appearance = OverrideAppearanceRGB | OverrideAppearanceOpacity,
    Highlight = Selected | Hovered,
};
ENUM_CLASS_FLAGS(EI3DHGeometryMaterialFlags);
UCLASS(NotPlaceable, MinimalAPI, Experimental, meta = (DisplayName = "I3DH Geometry (Experimental)"))
class AI3DHGeometry : public AActor
{
    GENERATED_BODY()
 
public:
    INSTANT3DHUB_API AI3DHGeometry();
 
protected:
    // Begin Actor Interface
    INSTANT3DHUB_API virtual void BeginPlay() override;
    // End Actor Interface
 
public:
    // ----------------------------------------------------------
    // Geometry Public API
    // ----------------------------------------------------------
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Geometry")
    FORCEINLINE AI3DHConnector* GetHubConnector() const { return Connector.Get(); }
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Geometry")
    FORCEINLINE int32 GetNodeId() const { return RootNodeId; }
 
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Geometry")
    FORCEINLINE bool IsSelectedNode() const { return bIsSelected; }
 
    INSTANT3DHUB_DEPRECATED(1.0.0, "Replaced by HoverAPI. Use GetConnector()->GetAPI()->GetHoverAPI()->SetHoveredNode(GetNodeId()) instead.")
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Geometry")
    INSTANT3DHUB_API void OnHoverStart();
 
    INSTANT3DHUB_DEPRECATED(1.0.0, "Replaced by HoverAPI. Use GetConnector()->GetAPI()->GetHoverAPI()->ClearHoveredNodes() instead.")
    UFUNCTION(BlueprintCallable, Category = "{instant3Dhub}|Geometry")
    INSTANT3DHUB_API void OnHoverEnd();
 
protected:
    UPROPERTY(EditDefaultsOnly, Category = "{instant3Dhub}|Geometry")
    UMaterialInterface* GeometryDefaultMaterial;
 
    UPROPERTY(EditDefaultsOnly, Category = "{instant3Dhub}|Geometry")
    UMaterialInterface* GeometryAppearanceMaterial;
 
    UPROPERTY(EditDefaultsOnly, Category = "{instant3Dhub}|Geometry")
    UMaterialInterface* GeometryHighlightMaterial;
 
    UPROPERTY(EditDefaultsOnly, Category = "{instant3Dhub}|Geometry")
    UMaterialInterface* GeometryAppearanceHighlightMaterial;
 
public:
    static constexpr int32 NumReservedCustomPrimitiveDataFloats = 4;
 
public:
    // ----------------------------------------------------------
    // Internal
    // ----------------------------------------------------------
 
    struct FPageInstanceMeshComponent
    {
        FI3DHPageInstanceHandle PageInstanceHandle;
        UStaticMeshComponent* MeshComponent;
    };
 
    void InitializePreSpawn(AI3DHConnector* InConnector, int32 InRootNodeId);
 
    // Called by the HubConnector when a new component is added.
    void OnPageInstanceMeshAttached(FI3DHPageInstanceHandle PageInstanceHandle, UStaticMeshComponent* NewMeshComponent);
 
    const TArray<FPageInstanceMeshComponent>& GetPageInstanceMeshComponents() { return PageInstanceMeshComponents; };
 
    void SetAppearance_GeometryInternal(const FLinearColor& OverrideColor, EAppearanceURIMode OverrideMode);
 
    void SetEnabled_GeometryInternal(bool bNewIsEnabled);
    void SetVariantEnabled_GeometryInternal(bool bNewIsVariantEnabled);
    void SetSelected_GeometryInternal(bool bNewIsSelected);
    void SetHovered_GeometryInternal(bool bNewIsHovered);
 
    bool IsSelected_GeometryInternal() const { return bIsSelected; }
 
private:
    EI3DHGeometryMaterialFlags GetMaterialFlags() const;
    
    UMaterialInterface* GetGeometryMaterialByFlags(EI3DHGeometryMaterialFlags MaterialFlags) const;
 
    void UpdateMaterialsAndPrimitiveData(EI3DHGeometryMaterialFlags MaterialFlags);
    void SetCustomPrimitiveDataByFlags(class UMeshComponent* MeshComponent, EI3DHGeometryMaterialFlags MaterialFlags) const;
 
private:
    TWeakObjectPtr<AI3DHConnector> Connector;
 
    // Note: use int type here to be Blueprint compatible. Range should be enough for NodeIds anyway.
    int32 RootNodeId = 0;
 
    bool bIsEnabled = true;
    bool bIsVariantEnabled = true;
    bool bIsSelected = false;
    bool bIsHovered = false;
 
    TArray<FPageInstanceMeshComponent> PageInstanceMeshComponents;
 
    struct
    {
        FLinearColor OverrideColor{};
        bool bUseOverrideRGB{};
        bool bUseOverrideOpacity{};
    } Appearance;
    
    INSTANT3DHUB_DEPRECATED(1.2.0, "Geometry materials are now grouped by Appearance and Highlight. Please use GeometryDefaultMaterial and its variants (Appearance, Highlight).")
    UPROPERTY()
    UMaterialInterface* DefaultMaterial_DEPRECATED;
 
    INSTANT3DHUB_DEPRECATED(1.2.0, "Geometry materials are now grouped by Appearance and Highlight. Please use GeometryDefaultMaterial and its variants (Appearance, Highlight).")
    UPROPERTY()
    UMaterialInterface* SelectedMaterial_DEPRECATED;
 
    INSTANT3DHUB_DEPRECATED(1.2.0, "Geometry materials are now grouped by Appearance and Highlight. Please use GeometryDefaultMaterial and its variants (Appearance, Highlight).")
    UPROPERTY()
    UMaterialInterface* HoveredMaterial_DEPRECATED;
 
    INSTANT3DHUB_DEPRECATED(1.2.0, "Geometry materials are now grouped by Appearance and Highlight. Please use GeometryDefaultMaterial and its variants (Appearance, Highlight).")
    UPROPERTY()
    UMaterialInterface* HoveredSelectedMaterial_DEPRECATED;
 
};