1. Epic GamesDeveloper
  3. FFoliageInfo

FFoliageInfo

[FFoliageInfo](API\Runtime\Foliage\FFoliageInfo)

API > API/Runtime > API/Runtime/Foliage

References

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

Syntax

struct FFoliageInfo

Remarks

FFoliageInfo

Variables

  Type Name Description
Public variable TMap< FFoliageInstanceBaseId, TSet< int32 > > ComponentHash Transient, editor-only set of instances per component.
Public variable FGuid FoliageTypeUpdateGuid Allows us to detect if FoliageType was updated while this level wasn't loaded.
Public variable AInstancedFoliageActor * IFA Owning IFA.
Public variable TUniquePtr< FFoliageImpl > Implementation  
Public variable TUniquePtr< FFoliageInstanceHash > InstanceHash Transient, editor-only locality hash of instances.
Public variable TArray< FFoliageInstance > Instances Editor-only placed instances.
Public variable TSet< int32 > MovingInstances Moving instances.
Public variable TSet< int32 > SelectedIndices Transient, editor-only list of selected instances.
Public variable EFoliageImplType Type  

Constructors

  Type Name Description
Public function    
Public function    
Public function   Non-copyable.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddInstance ( const UFoliageType* InSettings,
const FFoliageInstance& InNewInstance,
UActorComponent* InBaseComponent
)

  
Public function void

AddInstance ( const UFoliageType* InSettings,
const FFoliageInstance& InNewInstance
)

  
Public function void

AddInstances ( const UFoliageType* InSettings,
const TArray< const FFoliageInstance* >& InNewInstances
)

  
Public function void  
Public function void

AddToBaseHash ( int32 InstanceIdx
)

  
Public function Const bool

CheckForOverlappingInstanceExcluding ( int32 TestInstanceIdx,
float Radius,
TSet< int32 >& ExcludeInstances
)

  
Public function Const bool

CheckForOverlappingSphere ( const FSphere& Sphere
)

  
Public function void For debugging. Validate state after editing.
Public function void  
Public function void

CreateImplementation ( const UFoliageType* FoliageType
)

  
Public function void

CreateImplementation ( EFoliageImplType InType
)

  
Public function void

DuplicateInstances ( UFoliageType* InSettings,
TArrayView< const int32 > InInstancesToDuplicate
)

  
Public function void  
Public function void  
Public function void  
Public function Const void

ForEachSMInstance ( int32 InstanceIndex,
TFunctionRef< bool(FSMInstanceId)> Callback
)

  
Public function Const void  
Public function Const FBox  
Public function Const UHierarchicalInstancedStaticMeshComponent * Will only return a valid component in the case of non-actor foliage.
Public function Const EFoliageImplType

GetImplementationType ( const UFoliageType* FoliageType
)

  
Public function Const void

GetInstanceAtLocation ( const FVector& Location,
int32& OutInstance,
bool& bOutSucess
)

  
Public function Const void

GetInstancesInsideBounds ( const FBox& Box,
TArray< int32 >& OutInstances
)

  
Public function Const void

GetInstancesInsideSphere ( const FSphere& Sphere,
TArray< int32 >& OutInstances
)

  
Public function Const TArray< int32 >

GetInstancesOverlappingBox ( const FBox& Box
)

  
Public function Const int32

GetOverlappingBoxCount ( const FBox& Box
)

  
Public function Const void

GetOverlappingBoxTransforms ( const FBox& Box,
TArray< FTransform >& OutTransforms
)

  
Public function Const void

GetOverlappingMeshCount ( const FSphere& Sphere,
TMap< UStaticMesh*, int32 >& OutCounts
)

  
Public function Const int32

GetOverlappingSphereCount ( const FSphere& Sphere
)

  
Public function Const int32 Get the number of placed instances.
Public function Const FBox  
Public function void
IncludeActor

( const UFoliageType* FoliageType,
AActor* InActor
)

  
Public function void

Initialize ( const UFoliageType* FoliageType
)

  
Public function Const bool  
Public function void

MoveInstances ( AInstancedFoliageActor* InToIFA,
const TSet< int32 >& InInstancesToMove,
bool bKeepSelection
)

  
Public function void

NotifyFoliageTypeChanged ( UFoliageType* FoliageType,
bool bSourceChanged
)

  
Public function void  
Public function void

OnHiddenEditorViewMaskChanged ( uint64 InHiddenEditorViews
)

  
Public function void

PostEditUndo ( UFoliageType* FoliageType
)

  
Public function void  
Public function void

PostMoveInstances ( TArrayView< const int32 > InInstancesMoved,
bool bFinished
)

  
Public function void  
Public function void

PostUpdateInstances ( TArrayView< const int32 >,
bool bReAddToHash,
bool InUpdateSelection
)

  
Public function void

PreEditUndo ( UFoliageType* FoliageType
)

  
Public function void

PreMoveInstances ( TArrayView< const int32 > InInstancesMoved
)

 Apply changes in the FoliageType to the component.
Public function void Destroy existing clusters and reassign all instances to new clusters.
Public function void  
Public function void

Refresh ( bool Async,
bool Force
)

  
Public function void  
Public function void

RemoveFromBaseHash ( int32 InstanceIdx
)

  
Public function void

RemoveInstances ( TArrayView< const int32 > InInstancesToRemove,
bool RebuildFoliageTree
)

  
Public function void

ReserveAdditionalInstances ( const UFoliageType* InSettings,
uint32 ReserveNum
)

  
Public function void

SelectInstances ( bool bSelect
)

  
Public function void

SelectInstances ( bool bSelect,
TArrayView< const int32 > Instances
)

  
Public function void

SetInstanceWorldTransform ( int32 InstanceIndex,
const FTransform& Transform,
bool bTeleport
)

  
Public function void

SetRandomSeed ( int32 seed
)

  
Public function Const bool  
Public function void  

Operators

  Type Name Description
Public function FFoliageInfo &

operator= ( const FFoliageInfo&
)

  
Public function FFoliageInfo &

operator= ( FFoliageInfo&& Other
)

  

Typedefs

Name Description
FAddImplementationFunc  
FRemoveImplementationFunc  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page