FFoliageInfo

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

Windows
MacOS
Linux

References

Module

Foliage

Header

/Engine/Source/Runtime/Foliage/Public/InstancedFoliage.h

Include

#include "InstancedFoliage.h"

Syntax

struct FFoliageInfo

Remarks

Variables

Name Description

Public variable

bool

 

bMovingInstances

Moving instances.

Public variable

TMap< FFoliageI...

 

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

TUniquePtr< FFo...

 

Implementation

Public variable

TUniquePtr< FFo...

 

InstanceHash

Transient, editor-only locality hash of instances.

Public variable

TArray< FFoliag...

 

Instances

Editor-only placed instances.

Public variable

TSet< int32 >

 

SelectedIndices

Transient, editor-only list of selected instances.

Public variable

EFoliageImplTyp...

 

Type

Constructors

Name Description

Public function

FFoliageInfo()

Public function

FFoliageInfo

(
    FFoliageInfo&& Other
)

Public function

FFoliageInfo

(
    const FFoliageInfo&
)

Non-copyable.

Destructors

Name Description

Public function

~FFoliageInfo()

Functions

Name Description

Public function

void

 

AddInstance

(
    AInstancedFoliageActor* InIFA,
    const UFoliageType* InSettings,
    const FFoliageInstance& InNewInsta...,
    UActorComponent* InBaseCompone...
)

Public function

void

 

AddInstance

(
    AInstancedFoliageActor* InIFA,
    const UFoliageType* InSettings,
    const FFoliageInstance& InNewInsta...
)

Public function

void

 

AddInstances

(
    AInstancedFoliageActor* InIFA,
    const UFoliageType* InSettings,
    const TArray< const FFoliageInstanc...
)

Public function

void

 

AddReferencedObjects

(
    UObject* InThis,
    FReferenceCollector& Collector
)

Public function

void

 

AddToBaseHash

(
    int32 InstanceIdx
)

Public function

bool

 

CheckForOverlappingInstanceExcluding

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

Public function

bool

 

CheckForOverlappingSphere

(
    const FSphere& Sphere
)

Public function

void

 

CheckValid()

For debugging. Validate state after editing.

Public function

void

 

ClearSelection()

Public function

void

 

CreateImplementation

(
    const UFoliageType* FoliageTyp...
)

Public function

void

 

CreateImplementation

(
    EFoliageImplType InType
)

Public function

void

 

DuplicateInstances

(
    AInstancedFoliageActor* InIFA,
    UFoliageType* InSettings,
    const TArray< int32 >& InInstances...
)

Public function

void

 

EnterEditMode()

Public function

void

 

ExcludeActors()

Public function

void

 

ExitEditMode()

Public function Const

UHierarchica...

 

GetComponent()

Will only return a valid component in the case of non-actor foliage.

Public function

void

 

GetInstanceAtLocation

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

Public function

void

 

GetInstancesInsideSphere

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

Public function Const

TArray< int3...

 

GetInstancesOverlappingBox

(
    const FBox& Box
)

Public function Const

int32

 

GetOverlappingBoxCount

(
    const FBox& Box
)

Public function Const

void

 

GetOverlappingBoxTransforms

(
    const FBox& Box,
    TArray< FTransform >& OutTransform...
)

Public function Const

void

 

GetOverlappingMeshCount

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

Public function Const

int32

 

GetOverlappingSphereCount

(
    const FSphere& Sphere
)

Public function Const

int32

 

GetPlacedInstanceCount()

Get the number of placed instances.

Public function

void

 

IncludeActor

(
    AInstancedFoliageActor* IFA,
    const UFoliageType* FoliageTyp...,
    AActor* InActor
)

Public function

void

 

Initialize

(
    AInstancedFoliageActor* InIFA,
    const UFoliageType* FoliageTyp...
)

Public function Const

bool

 

IsInitialized()

Public function

void

 

MoveInstances

(
    AInstancedFoliageActor* InFrom...,
    AInstancedFoliageActor* InToIF...,
    const TSet< int32 >& InInstancesTo...,
    bool bKeepSelection
)

Public function

void

 

NotifyFoliageTypeChanged

(
    AInstancedFoliageActor* IFA,
    UFoliageType* FoliageType,
    bool bSourceChanged
)

Public function

void

 

NotifyFoliageTypeWillChange

(
    AInstancedFoliageActor* IFA,
    UFoliageType* FoliageType
)

Public function

void

 

OnHiddenEditorViewMaskChanged

(
    uint64 InHiddenEditorViews
)

Public function

void

 

PostEditUndo

(
    AInstancedFoliageActor* IFA,
    UFoliageType* FoliageType
)

Public function

void

 

PostMoveInstances

(
    AInstancedFoliageActor* InIFA,
    const TArray< int32 >& InInstances...,
    bool bFinished
)

Public function

void

 

PostUpdateInstances

(
    AInstancedFoliageActor* InIFA,
    const TArray< int32 >& InInstances...,
    bool bReAddToHash,
    bool InUpdateSelection
)

Public function

void

 

PreEditUndo

(
    AInstancedFoliageActor* IFA,
    UFoliageType* FoliageType
)

Public function

void

 

PreMoveInstances

(
    AInstancedFoliageActor* InIFA,
    const TArray< int32 >& InInstances...
)

Apply changes in the FoliageType to the component.

Public function

void

 

ReallocateClusters

(
    AInstancedFoliageActor* InIFA,
    UFoliageType* InSettings
)

Destroy existing clusters and reassign all instances to new clusters.

Public function

void

 

Refresh

(
    AInstancedFoliageActor* IFA,
    bool Async,
    bool Force
)

Public function

void

 

RemoveBaseComponentOnInstances()

Public function

void

 

RemoveFromBaseHash

(
    int32 InstanceIdx
)

Public function

void

 

RemoveInstances

(
    AInstancedFoliageActor* InIFA,
    const TArray< int32 >& InInstances...,
    bool RebuildFoliageTree
)

Public function

void

 

ReserveAdditionalInstances

(
    AInstancedFoliageActor* InIFA,
    const UFoliageType* InSettings,
    uint32 ReserveNum
)

Public function

void

 

SelectInstances

(
    AInstancedFoliageActor* InIFA,
    bool bSelect
)

Public function

void

 

SelectInstances

(
    AInstancedFoliageActor* InIFA,
    bool bSelect,
    TArray< int32 >& Instances
)

Public function

void

 

SetInstanceWorldTransform

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

Public function

void

 

SetRandomSeed

(
    int32 seed
)

Public function Const

bool

 

ShouldAttachToBaseComponent()

Public function

void

 

Uninitialize()

Operators

Name Description

Public function

FFoliageInfo...

 

operator=

(
    const FFoliageInfo&
)

Public function

FFoliageInfo...

 

operator=

(
    FFoliageInfo&& Other
)

Typedefs

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss