1. Epic GamesDeveloper
  3. AInstancedFoliageActor

AInstancedFoliageActor

API > API/Runtime > API/Runtime/Foliage

Inheritance Hierarchy

  • AISMPartitionActor
  • AInstancedFoliageActor

References

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

Syntax

UCLASS (NotPlaceable, HideCategories=(Object, Rendering, Mobility), MinimalAPI, NotBlueprintable)  
class AInstancedFoliageActor : public AISMPartitionActor

Variables

  Type Name Description
Public variable FFoliageInstanceBaseCache InstanceBaseCache Cross level references cache for instances base.

Constructors

  Type Name Description
Public function  

AInstancedFoliageActor ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function TUniqueObj< FFoliageInfo > &

AddFoliageInfo ( UFoliageType* FoliageType
)

  
Public function TUniqueObj< FFoliageInfo > &

AddFoliageInfo ( UFoliageType* FoliageType,
TUniqueObj< FFoliageInfo >&& FoliageInfo
)

  
Public function UFoliageType *

AddFoliageType ( const UFoliageType* InType,
FFoliageInfo** OutInfo
)

  
Public function Static UFunction BlueprintCallable, Category, Meta void

AddInstances ( UObject* WorldContextObject,
UFoliageType* InFoliageType,
const TArray< FTransform >& InTransforms
)

  
Public function FFoliageInfo *

AddMesh ( UFoliageType* InType
)

  
Public function FFoliageInfo *

AddMesh ( UStaticMesh* InMesh,
UFoliageType** OutSettings,
const UFoliageType_InstancedStaticMesh* DefaultSettings
)

 Add a new static mesh.
Public function Static void

AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

  
Public function void

ApplySelection ( bool bApply
)

 Propagate the selected instances to the actual foliage implementation.
Public function Virtual void  
Public function Const bool

CanDeleteSelectedActor ( FText& OutReason
)

  
Public function Const bool  
Public function Const bool

CanMoveFoliageInstance ( const FFoliageInstanceId& InstanceId,
const ETypedElementWorldType WorldType
)

  
Public function Static bool

CheckCollisionWithWorld ( const UWorld* InWorld,
const UFoliageType* Settings,
const FFoliageInstance& Inst,
const FVector& HitNormal,
const FVector& HitLocation,
UPrimitiveComponent* HitComponent
)

  
Public function void  
Public function bool

ContainsInstancesFromProceduralFoliageComponent ( const FGuid& InProceduralGuid
)

  
Public function bool  
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function bool

DeleteFoliageInstances ( TArrayView< const FFoliageInstanceId > InstanceIds
)

  
Public function bool  
Public function Static void

DeleteInstancesForComponent ( UWorld* InWorld,
UActorComponent* InComponent
)

 Deletes the instances attached to a component, traverses all foliage actors in the world.
Public function void

DeleteInstancesForComponent ( UActorComponent* InComponent,
const UFoliageType* InFoliageType
)

  
Public function void

DeleteInstancesForComponent ( UActorComponent* InComponent
)

 Deletes the instances attached to a component.
Public function bool

DeleteInstancesForProceduralFoliageComponent ( const FGuid& InProceduralGuid,
bool bInRebuildTree
)

  
Public function bool

DeleteInstancesForProceduralFoliageComponent ( const UProceduralFoliageComponent* InProceduralFoliageComponent,
bool bInRebuildTree
)

 Deletes the instances spawned by a procedural component.
Public function Virtual void  
Public function void  
Public function bool

DuplicateFoliageInstances ( TArrayView< const FFoliageInstanceId > InstanceIds,
TArray< FFoliageInstanceId >& OutNewInstanceIds
)

  
Public function void  
Public function void  
Public function Const const UFoliageType *

FindFoliageType ( const FFoliageInfo* InFoliageInfo
)

 Returns FoliageType associated to this FoliageInfo.
Public function FFoliageInfo *  
Public function Const const FFoliageInfo *

FindInfo ( const UFoliageType* InType
)

 Finds a mesh entry.
Public function FFoliageInfo *

FindInfo ( const UFoliageType* InType
)

 Finds a mesh entry.
Public function FFoliageInfo * Finds a mesh entry or adds it if it doesn't already exist.
Public function Static bool

FoliageTrace ( const UWorld* InWorld,
FHitResult& OutHit,
const FDesiredFoliageInstance& DesiredInstance,
FName InTraceTag,
bool InbReturnFaceIndex,
const FFoliageTraceFilterFunc& FilterFunc,
bool bAverageNormal
)

  
Public function bool

ForEachFoliageInfo ( TFunctionRef< bool(UFoliageType*FoliageType, FFoliageInfo&FoliageInfo)> InOperation
)

  
Public function Static AInstancedFoliageActor *

Get ( UWorld* InWorld,
bool bCreateIfNone,
ULevel* InLevelHint,
const FVector& InLocationHint
)

 Get the instanced foliage actor for the specified params
Public function void

GetAllFoliageTypesForSource ( const UObject* InSource,
TArray< const UFoliageType* >& OutFoliageTypes
)

 Performs a reverse lookup from a source object to all the foliage types that are currently using that object (includes assets and blueprint classes)
Public function TMap< UFoliageType *, FFoliageInfo * > Will return all the foliage type used.
Public function Const UActorComponent *  
Public function Static AInstancedFoliageActor *

GetDefault ( UWorld* InWorld
)

  
Public function Virtual Const uint32

GetDefaultGridSize ( UWorld* InWorld
)

  
Public function Const const TMap< UFoliageType *, TUniqueObj< FFoliageInfo > > &  
Public function Const bool

GetFoliageInstanceTransform ( const FFoliageInstanceId& InstanceId,
FTransform& OutInstanceTransform,
bool bWorldSpace
)

  
Public function Const UFoliageType *

GetFoliageTypeForInfo ( const FFoliageInfo* FoliageInfo
)

  
Public function Static AInstancedFoliageActor *

GetInstancedFoliageActorForCurrentLevel ( const UWorld* InWorld,
bool bCreateIfNone
)

 Get the instanced foliage actor for the current streaming level.
Public function Static AInstancedFoliageActor *

GetInstancedFoliageActorForLevel ( ULevel* Level,
bool bCreateIfNone
)

 Get the instanced foliage actor for the specified streaming level.
Public function TMap< UFoliageType *, TArray< const FFoliageInstancePlacementInfo * > >

GetInstancesForComponent ( UActorComponent* InComponent
)

 Returns a map of Static Meshes and their placed instances attached to a component.
Public function UFoliageType *

GetLocalFoliageTypeForSource ( const UObject* InSource,
FFoliageInfo** OutMeshInfo
)

 Performs a reverse lookup from a source object to a local foliage type (i.e. the foliage type owned exclusively by this IFA)
Public function Const int32

GetOverlappingBoxCount ( const UFoliageType* FoliageType,
const FBox& Box
)

 Finds the number of instances overlapping with the box.
Public function Const void

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

 Finds all instances in the provided box and get their transforms.
Public function Const void

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

 Perf Warnin: potentially slow! Dev-only use recommended.
Public function Const int32

GetOverlappingSphereCount ( const UFoliageType* FoliageType,
const FSphere& Sphere
)

 Finds the number of instances overlapping with the sphere.
Public function TMap< UFoliageType *, FFoliageInfo * > Will return all the foliage type used by currently selected instances.
Public function Const FBox Get the bounds of all selected instances.
Public function Const bool

GetSelectionLocation ( FBox& OutLocation
)

 Returns the location for the widget.
Protected function Virtual ISMInstanceManager *

GetSMInstanceManager ( const FSMInstanceId& InstanceId
)

  
Protected function void  
Protected function void  
Public function Static bool

HasFoliageAttached ( UActorComponent* InComponent
)

 Whether there any foliage instances painted on specified component
Public function Const bool Whether actor has selected instances.
Protected function Virtual float

InternalTakeRadialDamage ( float Damage,
FRadialDamageEvent const& RadialDamageEvent,
AController* EventInstigator,
AActor* DamageCauser
)

 Default InternalTakeRadialDamage behavior finds and scales damage for the closest component which isn't appropriate for foliage.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function void Called in response to BSP rebuilds to migrate foliage from obsolete to new components.
Public function void

MoveAllInstancesToLevel ( ULevel* InTargetLevel
)

 Move all instances to a foliage actor in target level.
Public function Static void

MoveInstancesForComponentToCurrentLevel ( UActorComponent* InComponent
)

 Moves instances based on the specified component to the current streaming level.
Public function Static void

MoveInstancesForComponentToLevel ( UActorComponent* InComponent,
ULevel* TargetLevel
)

  
Public function void

MoveInstancesToLevel ( ULevel* InTargetLevel,
TSet< int32 >& InInstanceList,
FFoliageInfo* InCurrentMeshInfo,
UFoliageType* InFoliageType,
bool bSelect
)

 Move instances to a foliage actor in target level.
Public function void

MoveInstancesToNewComponent ( UPrimitiveComponent* InOldComponent,
UPrimitiveComponent* InNewComponent
)

 Change all instances based on one component to a new component (possible in another level).
Public function Static void

MoveInstancesToNewComponent ( UWorld* InWorld,
UPrimitiveComponent* InOldComponent,
UPrimitiveComponent* InNewComponent
)

  
Public function Static void

MoveInstancesToNewComponent ( UWorld* InWorld,
UPrimitiveComponent* InOldComponent,
const FBox& InBoxWithInstancesToMove,
UPrimitiveComponent* InNewComponent
)

  
Public function void

MoveInstancesToNewComponent ( UPrimitiveComponent* InOldComponent,
const FBox& InBoxWithInstancesToMove,
UPrimitiveComponent* InNewComponent
)

  
Public function Static void  
Public function void

MoveSelectedInstancesToLevel ( ULevel* InTargetLevel
)

 Move selected instances to a foliage actor in target level.
Public function void  
Public function void  
Public function void  
Public function void

NotifyFoliageInstanceSelectionChanged ( const FFoliageInstanceId& InstanceId,
const bool bIsSelected
)

  
Public function void

NotifyFoliageTypeChanged ( UFoliageType* FoliageType,
bool bSourceChanged
)

 Called to notify InstancedFoliageActor that a UFoliageType has been modified
Public function void  
Public function FOnFoliageTypeMeshChanged &  
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Static UFunction BlueprintCallable, Category, Meta void

RemoveAllInstances ( UObject* WorldContextObject,
UFoliageType* InFoliageType
)

  
Public function void  
Public function bool

RemoveFoliageInfoAndCopyValue ( UFoliageType* FoliageType,
TUniqueObj< FFoliageInfo >& OutFoliageInfo
)

  
Public function void

RemoveFoliageType ( UFoliageType** InFoliageType,
int32 Num
)

 Remove the FoliageType from the list, and all its instances.
Public function void Fix up a duplicate IFA
Public function Virtual void We don't want to have our components automatically destroyed by the Blueprint code
Public function bool

SelectInstance ( AActor* InActor,
bool bToggle
)

 Select an individual instance.
Public function void

SelectInstance ( UInstancedStaticMeshComponent* InComponent,
int32 InComponentInstanceIndex,
bool bToggle
)

 Select an individual instance.
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function bool

SetFoliageInstanceTransform ( const FFoliageInstanceId& InstanceId,
const FTransform& InstanceTransform,
bool bWorldSpace,
bool bTeleport
)

  
Public function Virtual bool  
Public function Virtual bool

ShouldImport ( FStringView ActorPropString,
bool IsMovingLevel
)

  
Public function Virtual Const bool

ShouldIncludeGridSizeInName ( UWorld* InWorld,
const FActorPartitionIdentifier& InIdentifier
)

  
Public function Static void

UpdateInstancePartitioning ( UWorld* InWorld
)

  

Classes

  Type Name Description
Public class FOnFoliageTypeMeshChanged    

Typedefs

Name Description
FOnInstanceCoundChanged  
FOnSelectionChanged Delegate type for selection change events.

Constants

Name Description
InstanceCountChanged  
SelectionChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page