1. Epic GamesDeveloper
  3. UProceduralFoliageComponent

UProceduralFoliageComponent

API > API/Runtime > API/Runtime/Foliage

   
Name UProceduralFoliageComponent
Type class
Header File /Engine/Source/Runtime/Foliage/Public/ProceduralFoliageComponent.h
Include Path #include "ProceduralFoliageComponent.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UProceduralFoliageComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UProceduralFoliageComponent ( const FObjectInitializer& ObjectInitializer
)

   ProceduralFoliageComponent.h  

Structs

Name Remarks
FGenerateProceduralContentParams  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowBSP bool Whether to place foliage on BSP ProceduralFoliageComponent.h
  • Category="ProceduralFoliage"
  • BlueprintReadWrite
  • EditAnywhere
bAllowFoliage bool Whether to place foliage on other blocking foliage geometry ProceduralFoliageComponent.h
  • Category="ProceduralFoliage"
  • BlueprintReadWrite
  • EditAnywhere
bAllowLandscape bool Whether to place foliage on landscape ProceduralFoliageComponent.h
  • Category="ProceduralFoliage"
  • BlueprintReadWrite
  • EditAnywhere
bAllowStaticMesh bool Whether to place foliage on StaticMesh ProceduralFoliageComponent.h
  • Category="ProceduralFoliage"
  • BlueprintReadWrite
  • EditAnywhere
bAllowTranslucent bool Whether to place foliage on translucent geometry ProceduralFoliageComponent.h
  • Category="ProceduralFoliage"
  • BlueprintReadWrite
  • EditAnywhere
bShowDebugTiles bool Whether to visualize the tiles used for the foliage spawner simulation ProceduralFoliageComponent.h
  • Category="ProceduralFoliage"
  • BlueprintReadWrite
  • EditAnywhere
FoliageSpawner TObjectPtr< UProceduralFoliageSpawner > The procedural foliage spawner used to generate foliage instances within this volume. ProceduralFoliageComponent.h
  • Category="ProceduralFoliage"
  • BlueprintReadWrite
  • EditAnywhere
TileOverlap float The amount of overlap between simulation tiles (in cm). ProceduralFoliageComponent.h
  • Category="ProceduralFoliage"
  • BlueprintReadWrite
  • EditAnywhere

Protected

Name Type Remarks Include Path Unreal Specifiers
ProceduralGuid FGuid   ProceduralFoliageComponent.h  
SpawningVolume TObjectPtr< AVolume >   ProceduralFoliageComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GenerateProceduralContent ( TArray< FDesiredFoliageInstance >& OutInstances
)

 Runs the procedural foliage simulation to generate a list of desired instances to spawn. ProceduralFoliageComponent.h  

virtual FBox GetBounds()

   ProceduralFoliageComponent.h  

FBodyInstance * GetBoundsBodyInstance()

   ProceduralFoliageComponent.h  

FGenerateProceduralContentParams GetGenerateProceduralContentParams()

 Returns a params struct based on this component properties. ProceduralFoliageComponent.h  

const FGuid & GetProceduralGuid()

   ProceduralFoliageComponent.h  

void GetTileLayout ( FTileLayout& OutTileLayout
) const

 Determines the basic layout of the tiles used in the simulation ProceduralFoliageComponent.h  

FVector GetWorldPosition ()

   ProceduralFoliageComponent.h  

bool HasSpawnedAnyInstances()

   ProceduralFoliageComponent.h  

bool IsSimulatedRegionLoaded()

   ProceduralFoliageComponent.h  

void LoadSimulatedRegion()

   ProceduralFoliageComponent.h  

virtual void PostEditImport()

   ProceduralFoliageComponent.h  

void RemoveProceduralContent ( bool bInRebuildTree
)

 Removes all spawned foliage instances in the level that were spawned by this component ProceduralFoliageComponent.h  

bool ResimulateProceduralFoliage ( TFunctionRef< void(const TArray< FDesiredFoliageInstance >&)> AddInstancesFunc
)

 Runs the procedural foliage simulation, removes the old result, creates instances with the new result ProceduralFoliageComponent.h  

void SetSpawningVolume ( AVolume* InSpawningVolume
)

   ProceduralFoliageComponent.h  

void UnloadSimulatedRegion()

   ProceduralFoliageComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool GenerateProceduralContent ( const FGenerateProceduralContentParams& InParams,
TArray< FDesiredFoliageInstance >& OutInstances
)

   ProceduralFoliageComponent.h  

static void GetTileLayout ( const FGenerateProceduralContentParams& Params,
FTileLayout& OutTileLayout
)

   ProceduralFoliageComponent.h  

static FVector GetWorldPosition ( const FGenerateProceduralContentParams& Param
)

   ProceduralFoliageComponent.h  

static void RemoveProceduralContent ( UWorld* InWorld,
const FGuid& InProceduralGuid,
bool bInRebuildTree,
TSet< AInstancedFoliageActor* >& OutModifiedActors
)

   ProceduralFoliageComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page