ProceduralFoliageComponent.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 "Misc/Guid.h"
#include "Components/ActorComponent.h"
#include "InstancedFoliage.h"
#include "ProceduralFoliageComponent.generated.h"
 
class AVolume;
class UProceduralFoliageSpawner;
class UDataLayerAsset;
struct FBodyInstance;
 
struct FTileLayout
{
    FTileLayout()
        : BottomLeftX(0), BottomLeftY(0), NumTilesX(0), NumTilesY(0), HalfHeight(0.f)
    {
    }
 
    // The X coordinate (in whole tiles) of the bottom-left-most active tile
    int32 BottomLeftX;
 
    // The Y coordinate (in whole tiles) of the bottom-left-most active tile
    int32 BottomLeftY;
 
    // The total number of active tiles along the x-axis
    int32 NumTilesX;
 
    // The total number of active tiles along the y-axis
    int32 NumTilesY;
    
 
    FVector::FReal HalfHeight;
};
 
UCLASS(BlueprintType, MinimalAPI)
class UProceduralFoliageComponent : public UActorComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(Category = "ProceduralFoliage", BlueprintReadWrite, EditAnywhere)
    TObjectPtr<UProceduralFoliageSpawner> FoliageSpawner;
 
    UPROPERTY(Category = "ProceduralFoliage", BlueprintReadWrite, EditAnywhere)
    float TileOverlap;
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY(Category = "ProceduralFoliage", BlueprintReadWrite, EditAnywhere)
    bool bAllowLandscape;
 
    UPROPERTY(Category = "ProceduralFoliage", BlueprintReadWrite, EditAnywhere)
    bool bAllowBSP;
 
    UPROPERTY(Category = "ProceduralFoliage", BlueprintReadWrite, EditAnywhere)
    bool bAllowStaticMesh;
 
    UPROPERTY(Category = "ProceduralFoliage", BlueprintReadWrite, EditAnywhere)
    bool bAllowTranslucent;
 
    UPROPERTY(Category = "ProceduralFoliage", BlueprintReadWrite, EditAnywhere)
    bool bAllowFoliage;
 
    UPROPERTY(Category = "ProceduralFoliage", BlueprintReadWrite, EditAnywhere)
    bool bShowDebugTiles;
 
#endif
 
    struct FGenerateProceduralContentParams
    {
        FGenerateProceduralContentParams()
            : FoliageSpawner(nullptr)
            , Bounds(EForceInit::ForceInit)
            , TileOverlap(0.f)
            , ProceduralVolumeInstance(nullptr)
        {
        }
 
        TObjectPtr<UProceduralFoliageSpawner> FoliageSpawner;
        FBox Bounds;
        float TileOverlap;
        FGuid ProceduralGuid;
        FBodyInstance* ProceduralVolumeInstance;
    };
                
    // UObject interface
    FOLIAGE_API virtual void PostEditImport() override;
 
    FOLIAGE_API FGenerateProceduralContentParams GetGenerateProceduralContentParams() const;
 
    FOLIAGE_API bool ResimulateProceduralFoliage(TFunctionRef<void(const TArray<FDesiredFoliageInstance>&)> AddInstancesFunc);
 
    FOLIAGE_API bool GenerateProceduralContent(TArray<FDesiredFoliageInstance>& OutInstances);
    static FOLIAGE_API bool GenerateProceduralContent(const FGenerateProceduralContentParams& InParams, TArray<FDesiredFoliageInstance>& OutInstances);
            
    FOLIAGE_API void RemoveProceduralContent(bool bInRebuildTree = true);
    static FOLIAGE_API void RemoveProceduralContent(UWorld* InWorld, const FGuid& InProceduralGuid, bool bInRebuildTree, TSet<AInstancedFoliageActor*>& OutModifiedActors);
 
    FOLIAGE_API bool HasSpawnedAnyInstances();
    
    FOLIAGE_API FVector GetWorldPosition() const;
    static FOLIAGE_API FVector GetWorldPosition(const FGenerateProceduralContentParams& Param);
 
    FOLIAGE_API virtual FBox GetBounds() const;
 
    FOLIAGE_API FBodyInstance* GetBoundsBodyInstance() const;
 
    FOLIAGE_API void GetTileLayout(FTileLayout& OutTileLayout) const;
    static FOLIAGE_API void GetTileLayout(const FGenerateProceduralContentParams& Params, FTileLayout& OutTileLayout);
 
    void SetSpawningVolume(AVolume* InSpawningVolume) { SpawningVolume = InSpawningVolume; }
    const FGuid& GetProceduralGuid() const { return ProceduralGuid; }
 
#if WITH_EDITOR
    FOLIAGE_API void LoadSimulatedRegion();
    FOLIAGE_API void UnloadSimulatedRegion();
    FOLIAGE_API bool IsSimulatedRegionLoaded();
#endif
 
private:
    UPROPERTY()
    TObjectPtr<AVolume> SpawningVolume;
    
    UPROPERTY()
    FGuid ProceduralGuid;
 
#if WITH_EDITORONLY_DATA
    friend class UProceduralFoliageEditorLibrary;
#endif
};