ProceduralFoliageSpawner.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/ThreadSafeCounter.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Math/RandomStream.h"
#include "ProceduralFoliageInstance.h"
#include "FoliageTypeObject.h"
#include "ProceduralFoliageSpawner.generated.h"
 
class UProceduralFoliageTile;
 
UCLASS(BlueprintType, Blueprintable, MinimalAPI)
class UProceduralFoliageSpawner : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(Category = ProceduralFoliageSimulation, EditAnywhere, BlueprintReadOnly)
    int32 RandomSeed;
 
    UPROPERTY(Category = ProceduralFoliageSimulation, EditAnywhere, BlueprintReadOnly)
    float TileSize;
 
    UPROPERTY(Category = ProceduralFoliageSimulation, EditAnywhere, BlueprintReadOnly)
    int32 NumUniqueTiles;
 
    UPROPERTY(Category = ProceduralFoliageSimulation, EditAnywhere, BlueprintReadOnly)
    float MinimumQuadTreeSize;
 
    FThreadSafeCounter LastCancel;
 
private:
    UPROPERTY(Category = ProceduralFoliageSimulation, EditAnywhere)
    TArray<FFoliageTypeObject> FoliageTypes;
 
    UPROPERTY(Category = ProceduralFoliageSimulation, EditAnywhere)
    bool bUseOverrideFoliageTerrainMaterials = false;
 
    UPROPERTY(Category = ProceduralFoliageSimulation, EditAnywhere)
    TArray<TSoftObjectPtr<UMaterialInterface>> OverrideFoliageTerrainMaterials;
 
public:
    UFUNCTION(BlueprintCallable, Category = ProceduralFoliageSimulation)
    FOLIAGE_API void Simulate(int32 NumSteps = -1);
    FOLIAGE_API void Empty();
 
    FOLIAGE_API int32 GetRandomNumber();
 
    const TArray<FFoliageTypeObject>& GetFoliageTypes() const { return FoliageTypes; }
 
    bool UsesOverrideFoliageTerrainMaterials() const { return bUseOverrideFoliageTerrainMaterials; }
 
    const TArray<TSoftObjectPtr<UMaterialInterface>>& GetFoliageTerrainMaterials() const { return OverrideFoliageTerrainMaterials; }
 
    FOLIAGE_API void GetInstancesToSpawn(TArray<FProceduralFoliageInstance>& OutInstances, const FVector& Min = FVector(-FLT_MAX, -FLT_MAX, -FLT_MAX), const FVector& Max = FVector(FLT_MAX, FLT_MAX, FLT_MAX) ) const;
 
    FOLIAGE_API virtual void Serialize(FArchive& Ar);
 
    FOLIAGE_API const UProceduralFoliageTile* GetRandomTile(int32 X, int32 Y);
 
    FOLIAGE_API UProceduralFoliageTile* CreateTempTile();
 
private:
    FOLIAGE_API void CreateProceduralFoliageInstances();
 
    FOLIAGE_API void SetClean();
private:
    TArray<TWeakObjectPtr<UProceduralFoliageTile>> PrecomputedTiles;
 
    FRandomStream RandomStream;
};