LandscapeSplineControlPoint.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
// for FLandscapeSplineInterpPoint
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Misc/Guid.h"
#include "LandscapeSplineSegment.h"
 
#include "LandscapeSplineControlPoint.generated.h"
 
class UControlPointMeshComponent;
class ULandscapeSplinesComponent;
class UStaticMesh;
 
USTRUCT()
struct FLandscapeSplineConnection
{
    GENERATED_USTRUCT_BODY()
 
    FLandscapeSplineConnection() : Segment(nullptr), End(0) {}
 
    FLandscapeSplineConnection(ULandscapeSplineSegment* InSegment, int32 InEnd)
        : Segment(InSegment)
        , End(InEnd)
    {
    }
 
    bool operator == (const FLandscapeSplineConnection& rhs) const
    {
        return Segment == rhs.Segment && End == rhs.End;
    }
 
    // Segment connected to this control point
    UPROPERTY()
    TObjectPtr<ULandscapeSplineSegment> Segment;
 
    // Which end of the segment is connected to this control point
    UPROPERTY()
    uint32 End:1;
 
    LANDSCAPE_API FLandscapeSplineSegmentConnection& GetNearConnection() const;
    LANDSCAPE_API FLandscapeSplineSegmentConnection& GetFarConnection() const;
};
 
UCLASS(Within=LandscapeSplinesComponent,autoExpandCategories=LandscapeSplineControlPoint,MinimalAPI)
class ULandscapeSplineControlPoint : public UObject
{
    GENERATED_UCLASS_BODY()
 
// Directly editable data:
    UPROPERTY(EditAnywhere, Category=LandscapeSpline)
    FVector Location;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSpline)
    FRotator Rotation;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSpline, meta = (DisplayName = "Half-Width"))
    float Width;
 
    UPROPERTY(EditAnywhere, Category = LandscapeSpline)
    float LayerWidthRatio = 1.f;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSpline)
    float SideFalloff;
 
    UPROPERTY(EditAnywhere, Category = LandscapeSpline, meta=(UIMin = 0, ClampMin = 0, UIMax = 1, ClampMax = 1))
    float LeftSideFalloffFactor = 1.f;
 
    UPROPERTY(EditAnywhere, Category = LandscapeSpline, meta = (UIMin = 0, ClampMin = 0, UIMax = 1, ClampMax = 1))
    float RightSideFalloffFactor = 1.f;
 
    UPROPERTY(EditAnywhere, Category = LandscapeSpline, meta = (UIMin = 0, ClampMin = 0, UIMax = 1, ClampMax = 1))
    float LeftSideLayerFalloffFactor = 0.5f;
 
    UPROPERTY(EditAnywhere, Category = LandscapeSpline, meta = (UIMin = 0, ClampMin = 0, UIMax = 1, ClampMax = 1))
    float RightSideLayerFalloffFactor = 0.5f;
 
    UPROPERTY(EditAnywhere, Category=LandscapeSpline)
    float EndFalloff;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category=LandscapeSpline, meta=(DisplayName="Mesh Vertical Offset"))
    float SegmentMeshOffset;
 
    UPROPERTY(EditAnywhere, Category=LandscapeDeformation)
    FName LayerName;
 
    UPROPERTY(EditAnywhere, Category=LandscapeDeformation)
    uint32 bRaiseTerrain:1;
 
    UPROPERTY(EditAnywhere, Category=LandscapeDeformation)
    uint32 bLowerTerrain:1;
 
    UPROPERTY(EditAnywhere, Category=Mesh)
    TObjectPtr<UStaticMesh> Mesh;
 
    UPROPERTY(EditAnywhere, Category=Mesh)
    TArray<TObjectPtr<UMaterialInterface>> MaterialOverrides;
 
    UPROPERTY(EditAnywhere, Category=Mesh)
    FVector MeshScale;
 
    UPROPERTY()
    uint32 bEnableCollision_DEPRECATED:1;
 
    UPROPERTY()
    FName CollisionProfileName_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category=Mesh)
    uint32 bCastShadow:1;
 
    UPROPERTY(EditAnywhere, Category = Mesh, AdvancedDisplay)
    uint8 bHiddenInGame : 1;
 
    UPROPERTY(EditAnywhere, Category = Mesh, AdvancedDisplay)
    uint32 bPlaceSplineMeshesInStreamingLevels : 1;
 
    UPROPERTY(EditAnywhere, Category=Mesh, AdvancedDisplay, meta=(DisplayName="Max Draw Distance"))
    float LDMaxDrawDistance;
 
    UPROPERTY(EditAnywhere, Category=Mesh, AdvancedDisplay)
    int32 TranslucencySortPriority;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Mesh, meta = (DisplayName = "Render CustomDepth Pass"))
    uint8 bRenderCustomDepth : 1;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Mesh, meta = (editcondition = "bRenderCustomDepth"))
    ERendererStencilMask CustomDepthStencilWriteMask;
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Mesh, 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:
public:
    UPROPERTY(TextExportTransient)
    TArray<FLandscapeSplineConnection> ConnectedSegments;
 
protected:
    UPROPERTY()
    TArray<FLandscapeSplineInterpPoint> Points;
 
    UPROPERTY()
    FBox Bounds;
 
    UPROPERTY(TextExportTransient)
    TObjectPtr<UControlPointMeshComponent> LocalMeshComponent;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(TextExportTransient, NonPIEDuplicateTransient)
    TSoftObjectPtr<UWorld> ForeignWorld;
 
    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;
 
    // Get the name of the best connection point (socket) to use for a particular destination
    virtual FName GetBestConnectionTo(FVector Destination) const;
 
    // Get the location and rotation of a connection point (socket) in spline space
    virtual void GetConnectionLocalLocationAndRotation(FName SocketName, OUT FVector& OutLocation, OUT FRotator& OutRotation) const;
 
    // Get the location and rotation of a connection point (socket) in spline space
    virtual void GetConnectionLocationAndRotation(FName SocketName, OUT FVector& OutLocation, OUT FRotator& OutRotation) const;
 
    bool IsSplineSelected() const { return bSelected; }
    virtual void SetSplineSelected(bool bInSelected);
 
    virtual void AutoCalcRotation(bool bAlwaysRotateForward);
 
    virtual void AutoFlipTangents();
 
    virtual void AutoSetConnections(bool bIncludingValid);
 
    LANDSCAPE_API TMap<ULandscapeSplinesComponent*, UControlPointMeshComponent*> GetForeignMeshComponents();
 
    virtual void UpdateSplinePoints(bool bUpdateCollision = true, bool bUpdateAttachedSegments = true, bool bUpdateMeshLevel = false);
 
    virtual void UpdateSplineMeshSelectionState();
 
    virtual void DeleteSplinePoints();
 
    const TSoftObjectPtr<UWorld>& GetForeignWorld() const { return ForeignWorld; }
    FGuid GetModificationKey() const { return ModificationKey; }
 
    LANDSCAPE_API FName GetCollisionProfileName() const;
#endif // WITH_EDITOR
 
    //~ 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;
    //~ End UObject Interface
#endif // WITH_EDITOR
 
    LANDSCAPE_API ULandscapeSplinesComponent* GetOuterSafe() const;
    LANDSCAPE_API ULandscapeSplinesComponent* GetOuterChecked() const;
 
    friend class FLandscapeToolSplines;
    friend class ULandscapeInfo;
};