LandscapeSplineSegment.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Misc/Guid.h"
#include "Components/SplineMeshComponent.h"
#include "LandscapeSplinesComponent.h"
#include "VT/RuntimeVirtualTextureEnum.h"
#include "LandscapeSplineSegment.generated.h"
 
class ULandscapeSplineControlPoint;
class UStaticMesh;
 
//Forward declarations
class ULandscapeSplineControlPoint;
class ULandscapeSplinesComponent;
 
USTRUCT()
struct FLandscapeSplineInterpPoint
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    FVector Center;
 
    UPROPERTY()
    FVector Left;
 
    UPROPERTY()
    FVector Right;
 
    UPROPERTY()
    FVector FalloffLeft;
 
    UPROPERTY()
    FVector FalloffRight;
 
    UPROPERTY()
    FVector LayerLeft;
 
    UPROPERTY()
    FVector LayerRight;
 
    UPROPERTY()
    FVector LayerFalloffLeft;
 
    UPROPERTY()
    FVector LayerFalloffRight;
 
 
    UPROPERTY()
    float StartEndFalloff;
 
    FLandscapeSplineInterpPoint()
        : Center(ForceInitToZero)
        , Left(ForceInitToZero)
        , Right(ForceInitToZero)
        , FalloffLeft(ForceInitToZero)
        , FalloffRight(ForceInitToZero)
        , LayerLeft(ForceInitToZero)
        , LayerRight(ForceInitToZero)
        , LayerFalloffLeft(ForceInitToZero)
        , LayerFalloffRight(ForceInitToZero)
        , StartEndFalloff(0.0f)
    {
    }
 
    FLandscapeSplineInterpPoint(FVector InCenter, FVector InLeft, FVector InRight, FVector InFalloffLeft, FVector InFalloffRight, FVector InLayerLeft, FVector InLayerRight, FVector InLayerFalloffLeft, FVector InLayerFalloffRight, float InStartEndFalloff) :
        Center(InCenter),
        Left(InLeft),
        Right(InRight),
        FalloffLeft(InFalloffLeft),
        FalloffRight(InFalloffRight),
        LayerLeft(InLayerLeft),
        LayerRight(InLayerRight),
        LayerFalloffLeft(InLayerFalloffLeft),
        LayerFalloffRight(InLayerFalloffRight),
        StartEndFalloff(InStartEndFalloff)
    {
    }
};
 
USTRUCT()
struct FLandscapeSplineSegmentConnection
{
    GENERATED_USTRUCT_BODY()
 
    // Control point connected to this end of the segment
    UPROPERTY()
    TObjectPtr<ULandscapeSplineControlPoint> ControlPoint;
 
    // Tangent length of the connection
    UPROPERTY(EditAnywhere, Category=LandscapeSplineSegmentConnection)
    float TangentLen;
 
    // Socket on the control point that we are connected to
    UPROPERTY(EditAnywhere, Category=LandscapeSplineSegmentConnection)
    FName SocketName;
 
    FLandscapeSplineSegmentConnection()
        : ControlPoint(nullptr)
        , TangentLen(0.0f)
        , SocketName(NAME_None)
    {
    }
};
 
// Deprecated
UENUM()
enum LandscapeSplineMeshOrientation : int
{
    LSMO_XUp,
    LSMO_YUp,
    LSMO_MAX,
};
 
USTRUCT()
struct FLandscapeSplineMeshEntry
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshEntry)
    TObjectPtr<UStaticMesh> Mesh;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshEntry, AdvancedDisplay)
    TArray<TObjectPtr<UMaterialInterface>> MaterialOverrides;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshEntry, meta=(DisplayName="Center Horizontally"))
    uint32 bCenterH:1;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshEntry, AdvancedDisplay, meta=(DisplayName="Center Adjust"))
    FVector2D CenterAdjust;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshEntry)
    uint32 bScaleToWidth:1;
 
    UPROPERTY(EditAnywhere, Category = LandscapeSplineMeshEntry, meta = (EditCondition = "bScaleToWidth"))
    uint32 bNoZScaling:1;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshEntry)
    FVector Scale;
 
    UPROPERTY()
    TEnumAsByte<LandscapeSplineMeshOrientation> Orientation_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshEntry)
    TEnumAsByte<ESplineMeshAxis::Type> ForwardAxis;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshEntry)
    TEnumAsByte<ESplineMeshAxis::Type> UpAxis;
 
    FLandscapeSplineMeshEntry() :
        Mesh(nullptr),
        MaterialOverrides(),
        bCenterH(true),
        CenterAdjust(0, 0),
        bScaleToWidth(true),
        bNoZScaling(false),
        Scale(1,1,1),
        Orientation_DEPRECATED(LSMO_YUp),
        ForwardAxis(ESplineMeshAxis::X),
        UpAxis(ESplineMeshAxis::Z)
    {
    }
 
    bool IsValid() const;
};
 
 
UCLASS(Within=LandscapeSplinesComponent,autoExpandCategories=(LandscapeSplineSegment,LandscapeSplineMeshes),MinimalAPI)
class ULandscapeSplineSegment : public UObject
{
    GENERATED_UCLASS_BODY()
 
// Directly editable data:
    UPROPERTY(EditAnywhere, EditFixedSize, Category=LandscapeSplineSegment)
    FLandscapeSplineSegmentConnection Connections[2];
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category=LandscapeDeformation)
    FName LayerName;
 
    UPROPERTY(EditAnywhere, Category=LandscapeDeformation)
    uint32 bRaiseTerrain:1;
 
    UPROPERTY(EditAnywhere, Category=LandscapeDeformation)
    uint32 bLowerTerrain:1;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshes)
    TArray<FLandscapeSplineMeshEntry> SplineMeshes;
 
    UPROPERTY()
    uint32 bEnableCollision_DEPRECATED:1;
 
    UPROPERTY()
    FName CollisionProfileName_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshes)
    uint32 bCastShadow:1;
 
    UPROPERTY(EditAnywhere, Category = LandscapeSplineMeshes, AdvancedDisplay)
    uint32 bHiddenInGame : 1;
 
    UPROPERTY(EditAnywhere, Category = LandscapeSplineMeshes, AdvancedDisplay)
    uint32 bPlaceSplineMeshesInStreamingLevels : 1;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshes, AdvancedDisplay)
    int32 RandomSeed;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshes, AdvancedDisplay, meta=(DisplayName="Max Draw Distance"))
    float LDMaxDrawDistance;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSplineMeshes, AdvancedDisplay)
    int32 TranslucencySortPriority;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = LandscapeSplineMeshes, meta = (DisplayName = "Render CustomDepth Pass"))
    uint8 bRenderCustomDepth : 1;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = LandscapeSplineMeshes, meta = (editcondition = "bRenderCustomDepth"))
    ERendererStencilMask CustomDepthStencilWriteMask;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = LandscapeSplineMeshes, meta = (UIMin = "0", UIMax = "255", editcondition = "bRenderCustomDepth", DisplayName = "CustomDepth Stencil Value"))
    int32 CustomDepthStencilValue;
 
    UPROPERTY(EditAnywhere, Category = VirtualTexture, meta = (DisplayName = "Draw in Virtual Textures"))
    TArray<TObjectPtr<URuntimeVirtualTexture>> RuntimeVirtualTextures;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = VirtualTexture, meta = (DisplayName = "Virtual Texture LOD Bias", UIMin = "-7", UIMax = "8"))
    int32 VirtualTextureLodBias = 0;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = VirtualTexture, meta = (DisplayName = "Virtual Texture Skip Mips", UIMin = "0", UIMax = "7"))
    int32 VirtualTextureCullMips = 0;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = VirtualTexture, meta = (DisplayName = "Max Draw Distance in Main Pass"))
    float VirtualTextureMainPassMaxDrawDistance = 0.f;
 
    UPROPERTY(EditAnywhere, Category = VirtualTexture, meta = (DisplayName = "Draw in Main Pass"))
    ERuntimeVirtualTextureMainPassType VirtualTextureRenderPassType = ERuntimeVirtualTextureMainPassType::Exclusive;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = Collision, meta = (ShowOnlyInnerProperties))
    FBodyInstance BodyInstance;
 
protected:
    UPROPERTY(Transient)
    uint32 bSelected : 1;
 
    UPROPERTY(Transient)
    uint32 bNavDirty : 1;
#endif
 
// Procedural data:
protected:
    UPROPERTY()
    FInterpCurveVector SplineInfo;
 
    UPROPERTY()
    TArray<FLandscapeSplineInterpPoint> Points;
 
    UPROPERTY()
    FBox Bounds;
 
    UPROPERTY(TextExportTransient)
    TArray<TObjectPtr<USplineMeshComponent>> LocalMeshComponents;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(TextExportTransient, NonPIEDuplicateTransient)
    TArray<TSoftObjectPtr<UWorld>> ForeignWorlds;
 
    UPROPERTY(TextExportTransient, NonPIEDuplicateTransient)
    FGuid ModificationKey;
#endif
 
public:
    const FBox& GetBounds() const { return Bounds; }
    const TArray<FLandscapeSplineInterpPoint>& GetPoints() const { return Points; }
 
#if WITH_EDITOR
    bool SupportsForeignSplineMesh() const;
 
    bool IsSplineSelected() const { return bSelected; }
    virtual void SetSplineSelected(bool bInSelected);
 
    virtual void AutoFlipTangents();
 
    LANDSCAPE_API TMap<ULandscapeSplinesComponent*, TArray<USplineMeshComponent*>> GetForeignMeshComponents();
    TArray<USplineMeshComponent*> GetLocalMeshComponents() const;
    
    virtual void UpdateSplinePoints(bool bUpdateCollision = true, bool bUpdateMeshLevel = false);
    virtual void UpdateSplineMeshSelectionState();
    void UpdateSplineEditorMesh();
    virtual void DeleteSplinePoints();
 
    LANDSCAPE_API FName GetCollisionProfileName() const;
 
    const TArray<TSoftObjectPtr<UWorld>>& GetForeignWorlds() const { return ForeignWorlds; }
    FGuid GetModificationKey() const { return ModificationKey; }
#endif
 
    virtual void FindNearest(const FVector& InLocation, float& t, FVector& OutLocation, FVector& OutTangent);
 
    LANDSCAPE_API FFloatInterval GetKeyInterval() const;
 
    LANDSCAPE_API FVector Evaluate(const float Key, const FVector& Default = FVector::ZeroVector) const;
 
    //~ Begin UObject Interface
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostLoad() override;
#if WITH_EDITOR
    virtual void PostEditUndo() override;
    virtual void PostDuplicate(bool bDuplicateForPIE) override;
    virtual void PostEditImport() override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
protected:
    virtual void PostInitProperties() override;
private:
    void UpdateMeshCollisionProfile(USplineMeshComponent* MeshComponent);
public:
    //~ End UObject Interface
 
    LANDSCAPE_API ULandscapeSplinesComponent* GetOuterSafe() const;
    LANDSCAPE_API ULandscapeSplinesComponent* GetOuterChecked() const;
 
    friend class FLandscapeToolSplines;
    friend class ULandscapeInfo;
};