Navigation
API > API/Runtime > API/Runtime/Foliage
| Name | FFoliageInfo |
| Type | struct |
| Header File | /Engine/Source/Runtime/Foliage/Public/InstancedFoliage.h |
| Include Path | #include "InstancedFoliage.h" |
Syntax
struct FFoliageInfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFoliageInfo
(
const FFoliageInfo& |
Non-copyable. | InstancedFoliage.h | |
FFoliageInfo
(
FFoliageInfo&& Other |
InstancedFoliage.h | ||
FFoliageInfo () |
InstancedFoliage.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FFoliageInfo() |
InstancedFoliage.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAddImplementationFunc | TFunctionRef< void(FFoliageImpl *, AInstancedFoliageActor *, const FFoliageInstance &)> | InstancedFoliage.h | |
| FRemoveImplementationFunc | TFunctionRef< void(FFoliageImpl *, int32)> | InstancedFoliage.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ComponentHash | TMap< FFoliageInstanceBaseId, TSet< int32 > > | Transient, editor-only set of instances per component. | InstancedFoliage.h | |
| FoliageTypeUpdateGuid | FGuid | Allows us to detect if FoliageType was updated while this level wasn't loaded. | InstancedFoliage.h | |
| IFA | AInstancedFoliageActor * | Owning IFA. | InstancedFoliage.h | |
| Implementation | TUniquePtr< FFoliageImpl > | InstancedFoliage.h | ||
| InstanceHash | TUniquePtr< FFoliageInstanceHash > | Transient, editor-only locality hash of instances. | InstancedFoliage.h | |
| Instances | TArray< FFoliageInstance > | Editor-only placed instances. | InstancedFoliage.h | |
| MovingInstances | TSet< int32 > | Moving instances. | InstancedFoliage.h | |
| SelectedIndices | TSet< int32 > | Transient, editor-only list of selected instances. | InstancedFoliage.h | |
| Type | EFoliageImplType | InstancedFoliage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddInstance
(
const UFoliageType* InSettings, |
InstancedFoliage.h | ||
void AddInstance
(
const UFoliageType* InSettings, |
InstancedFoliage.h | ||
void AddInstances
(
const UFoliageType* InSettings, |
InstancedFoliage.h | ||
void AddReferencedObjects
(
UObject* InThis, |
InstancedFoliage.h | ||
void AddToBaseHash
(
int32 InstanceIdx |
InstancedFoliage.h | ||
bool CheckForOverlappingInstanceExcluding
(
int32 TestInstanceIdx, |
InstancedFoliage.h | ||
bool CheckForOverlappingSphere
(
const FSphere& Sphere |
InstancedFoliage.h | ||
void CheckValid() |
For debugging. Validate state after editing. | InstancedFoliage.h | |
void ClearSelection() |
InstancedFoliage.h | ||
void CreateImplementation
(
const UFoliageType* FoliageType |
InstancedFoliage.h | ||
void CreateImplementation
(
EFoliageImplType InType |
InstancedFoliage.h | ||
void DuplicateInstances
(
UFoliageType* InSettings, |
InstancedFoliage.h | ||
void EnterEditMode() |
InstancedFoliage.h | ||
void ExcludeActors() |
InstancedFoliage.h | ||
void ExitEditMode() |
InstancedFoliage.h | ||
void ForEachSMInstance
(
int32 InstanceIndex, |
InstancedFoliage.h | ||
void ForEachSMInstance
(
TFunctionRef< bool(FSMInstanceId)> Callback |
InstancedFoliage.h | ||
FBox GetApproximatedInstanceBounds() |
InstancedFoliage.h | ||
UHierarchicalInstancedStaticMeshComponent * GetComponent() |
Will only return a valid component in the case of non-actor foliage. | InstancedFoliage.h | |
EFoliageImplType GetImplementationType
(
const UFoliageType* FoliageType |
InstancedFoliage.h | ||
void GetInstanceAtLocation
(
const FVector& Location, |
InstancedFoliage.h | ||
void GetInstancesInsideBounds
(
const FBox& Box, |
InstancedFoliage.h | ||
void GetInstancesInsideSphere
(
const FSphere& Sphere, |
InstancedFoliage.h | ||
TArray< int32 > GetInstancesOverlappingBox
(
const FBox& Box |
InstancedFoliage.h | ||
int32 GetOverlappingBoxCount
(
const FBox& Box |
InstancedFoliage.h | ||
void GetOverlappingBoxTransforms
(
const FBox& Box, |
InstancedFoliage.h | ||
void GetOverlappingMeshCount
(
const FSphere& Sphere, |
InstancedFoliage.h | ||
int32 GetOverlappingSphereCount
(
const FSphere& Sphere |
InstancedFoliage.h | ||
int32 GetPlacedInstanceCount() |
Get the number of placed instances. | InstancedFoliage.h | |
FBox GetSelectionBoundingBox() |
InstancedFoliage.h | ||
void IncludeActor
(
const UFoliageType* FoliageType, |
InstancedFoliage.h | ||
void Initialize
(
const UFoliageType* FoliageType |
InstancedFoliage.h | ||
bool IsInitialized() |
InstancedFoliage.h | ||
void MoveInstances
(
AInstancedFoliageActor* InToIFA, |
InstancedFoliage.h | ||
void NotifyFoliageTypeChanged
(
UFoliageType* FoliageType, |
InstancedFoliage.h | ||
void NotifyFoliageTypeWillChange
(
UFoliageType* FoliageType |
InstancedFoliage.h | ||
void OnHiddenEditorViewMaskChanged
(
uint64 InHiddenEditorViews |
InstancedFoliage.h | ||
void PostEditUndo
(
UFoliageType* FoliageType |
InstancedFoliage.h | ||
void PostLoad() |
InstancedFoliage.h | ||
void PostMoveInstances
(
TArrayView< const int32 > InInstancesMoved, |
InstancedFoliage.h | ||
void PostSerialize
(
FArchive& Ar |
InstancedFoliage.h | ||
void PostUpdateInstances
(
TArrayView< const int32 >, |
InstancedFoliage.h | ||
void PreEditUndo
(
UFoliageType* FoliageType |
InstancedFoliage.h | ||
void PreMoveInstances
(
TArrayView< const int32 > InInstancesMoved |
Apply changes in the FoliageType to the component. | InstancedFoliage.h | |
void ReallocateClusters
(
UFoliageType* InSettings |
Destroy existing clusters and reassign all instances to new clusters. | InstancedFoliage.h | |
void RecomputeHash() |
InstancedFoliage.h | ||
void Refresh
(
bool Async, |
InstancedFoliage.h | ||
void RemoveBaseComponentOnInstances() |
InstancedFoliage.h | ||
void RemoveFromBaseHash
(
int32 InstanceIdx |
InstancedFoliage.h | ||
void RemoveInstances
(
TArrayView< const int32 > InInstancesToRemove, |
InstancedFoliage.h | ||
void ReserveAdditionalInstances
(
const UFoliageType* InSettings, |
InstancedFoliage.h | ||
void SelectInstances
(
bool bSelect |
InstancedFoliage.h | ||
void SelectInstances
(
bool bSelect, |
InstancedFoliage.h | ||
void SetInstanceWorldTransform
(
int32 InstanceIndex, |
InstancedFoliage.h | ||
void SetRandomSeed
(
int32 seed |
InstancedFoliage.h | ||
bool ShouldAttachToBaseComponent() |
InstancedFoliage.h | ||
void Uninitialize() |
InstancedFoliage.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFoliageInfo & operator=
(
const FFoliageInfo& |
InstancedFoliage.h | ||
FFoliageInfo & operator=
(
FFoliageInfo&& Other |
InstancedFoliage.h |