1. Epic GamesDeveloper
  3. UProceduralFoliageComponent

UProceduralFoliageComponent

API > API/Runtime > API/Runtime/Foliage

Inheritance Hierarchy

  • UActorComponent
  • UProceduralFoliageComponent

References

   
Module Foliage
Header /Engine/Source/Runtime/Foliage/Public/ProceduralFoliageComponent.h
Include #include "ProceduralFoliageComponent.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UProceduralFoliageComponent : public UActorComponent

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAllowBSP Whether to place foliage on BSP
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAllowFoliage Whether to place foliage on other blocking foliage geometry
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAllowLandscape Whether to place foliage on landscape
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAllowStaticMesh Whether to place foliage on StaticMesh
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAllowTranslucent Whether to place foliage on translucent geometry
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowDebugTiles Whether to visualize the tiles used for the foliage spawner simulation
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UProceduralFoliageSpawner > FoliageSpawner The procedural foliage spawner used to generate foliage instances within this volume.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float TileOverlap The amount of overlap between simulation tiles (in cm).

Constructors

  Type Name Description
Public function  

UProceduralFoliageComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function bool Runs the procedural foliage simulation to generate a list of desired instances to spawn.
Public function Static bool  
Public function Virtual Const FBox  
Public function Const FBodyInstance *  
Public function Const FGenerateProceduralContentParams Returns a params struct based on this component properties.
Public function Const const FGuid &  
Public function Static void

GetTileLayout ( const FGenerateProceduralContentParams& Params,
FTileLayout& OutTileLayout
)

  
Public function Const void

GetTileLayout ( FTileLayout& OutTileLayout
)

 Determines the basic layout of the tiles used in the simulation
Public function Static FVector  
Public function Const FVector  
Public function bool  
Public function bool  
Public function void  
Public function Virtual void  
Public function Static void

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

  
Public function void

RemoveProceduralContent ( bool bInRebuildTree
)

 Removes all spawned foliage instances in the level that were spawned by this component
Public function bool

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

 Runs the procedural foliage simulation, removes the old result, creates instances with the new result
Public function void

SetSpawningVolume ( AVolume* InSpawningVolume
)

  
Public function void  

Classes

  Type Name Description
Public struct FGenerateProceduralContentParams    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page