Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Components > UHierarchicalInstancedStaticMeshComponent

Light Theme

Dark Theme

UHierarchicalInstancedStaticMeshComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

UStaticMeshComponent

UInstancedStaticMeshComponent

UHierarchicalInstancedStaticMeshComponent

UFoliageInstancedStaticMeshComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/HierarchicalInstancedStaticMeshComponent.h
Include	#include "Components/HierarchicalInstancedStaticMeshComponent.h"

Syntax

class UHierarchicalInstancedStaticMeshComponent : public UInstancedStaticMeshComponent

Variables

	Name	Description
FBox	AccumulatedNavigationDirtyArea
bool: 1	bAutoRebuildTreeOnInstanceChanges
bool: 1	bCanEnableDensityScaling	In Editor mode we might disable the density scaling for edition
bool: 1	bConcurrentChanges
bool	bDisableCollision
uint32: 1	bEnableDensityScaling	Enable for detail meshes that don't really affect the game.
bool: 1	bIsAsyncBuilding
bool: 1	bIsOutOfDate
FGraphEventArra...	BuildTreeAsyncTasks
FBox	BuiltInstanceBounds	Bounding box of any built instances (cached from the ClusterTree)
FBoxSphereBound...	CacheMeshExtendedBounds	The last mesh bounds that was cache.
TSharedPtr< TAr...	ClusterTreePtr
float	CurrentDensityScaling	Current value of density scaling applied to this component.
friend	FInstancedLightMap2D
friend	FInstancedShadowMap2D
friend	FStaticLightingTextureMapping_InstancedStaticMesh
int32	InstanceCountToRender	Instances to render (including removed one until the build is complete)
int32	NumBuiltInstances	The number of instances in the ClusterTree. Subsequent instances will always be rendered.
int32	NumBuiltRenderInstances	Normally equal to NumBuiltInstances, but can be lower if density scaling is in effect.
int32	OcclusionLayerNumNodes	The number of nodes in the occlusion layer.
TArray< int32 >	SortedInstances	Table for remaping instances from cluster tree to PerInstanceSMData order.
FBox	UnbuiltInstanceBounds	Bounding box of any unbuilt instances.
TArray< FBox >	UnbuiltInstanceBoundsList	Bounds of each individual unbuilt instance, used for LOD calculation.

Constructors

	Name	Description
	UHierarchicalInstancedStaticMeshComponent ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~UHierarchicalInstancedStaticMeshComponent()

Functions

	Name	Description
void	AcceptPrebuiltTree ( TArray< FClusterNode >& InClusterT..., int32 InOcclusionLayerNumNodes, int32 InNumBuiltRenderInstances )
float	ActualInstancesPerLeaf()	Average number of instances per leaf
void	ApplyBuildTree ( FClusterBuilder& Builder )
void	ApplyBuildTreeAsync ( ENamedThreads::Type CurrentThread, const FGraphEventRef& MyCompletion..., TSharedRef< FClusterBuilder, ESPMod..., double StartTime )	Apply the results of the async build.
void	ApplyEmpty()
void	BuildTree()
void	BuildTreeAnyThread ( TArray< FMatrix >& InstanceTransfo..., TArray< float >& InstanceCustomDat..., int32 NumCustomDataFloats, const FBox& MeshBox, TArray< FClusterNode >& OutCluster..., TArray< int32 >& OutSortedInstance..., TArray< int32 >& OutInstanceReorde..., int32& OutOcclusionLayerNum, int32 MaxInstancesPerLeaf, bool InGenerateInstanceScalingRange )
void	BuildTreeAsync()
bool	BuildTreeIfOutdated ( bool Async, bool ForceUpdate )
int32	DesiredInstancesPerLeaf()	Heuristic for the number of leaves in the tree
void	FlushAccumulatedNavigationUpdates()
void	GetInstanceTransforms ( TArray< FMatrix >& InstanceTransfo... )
int32	GetOverlappingBoxCount ( const FBox& Box )	Get the number of instances that overlap a given box
void	GetOverlappingBoxTransforms ( const FBox& Box, TArray< FTransform >& OutTransform... )	Get the transforms of instances inside the provided box
int32	GetOverlappingSphereCount ( const FSphere& Sphere )	Get the number of instances that overlap a given sphere
int32	GetVertsForLOD ( int32 LODIndex )	Gets and approximate number of verts for each LOD to generate heuristics
void	InitializeInstancingRandomSeed()
bool	IsAsyncBuilding()
bool	IsTreeFullyBuilt()
void	PostBuildStats()	For testing, prints some stats after any kind of build
bool	RemoveInstances ( const TArray< int32 >& InstancesTo... )	Removes all the instances with indices specified in the InstancesToRemove array.
void	RemoveInstancesInternal ( const int32* InstanceIndices, int32 Num )	Removes specified instances
void	SetPerInstanceLightMapAndEditorData ( FStaticMeshInstanceData& PerInstan..., const TArray< TRefCountPtr< HHitPro... )
void	UpdateDensityScaling()	Will apply current density scaling, if enabled

Overridden from UInstancedStaticMeshComponent

	Name	Description
int32	AddInstance ( const FTransform& InstanceTransfor... )	Add an instance to this component. Transform is given in local space of this component.
TArray< int3...	AddInstances ( const TArray< FTransform >& Instan..., bool bShouldReturnIndices )	Add multiple instances to this component. Transform is given in local space of this component.
void	ApplyComponentInstanceData ( FInstancedStaticMeshComponentInstan... )	Applies the cached component instance data to a newly blueprint constructed component.
bool	BatchUpdateInstancesData ( int32 StartInstanceIndex, int32 NumInstances, FInstancedStaticMeshInstanceData&#..., bool bMarkRenderStateDirty, bool bTeleport )
bool	BatchUpdateInstancesTransform ( int32 StartInstanceIndex, int32 NumInstances, const FTransform& NewInstancesTran..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	Update the transform for a number of instances.
bool	BatchUpdateInstancesTransforms ( int32 StartInstanceIndex, const TArray< FTransform >& NewIns..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	Update the transform for an array of instances.
void	ClearInstances()	Clear all instances being rendered by this component.
TArray< int3...	GetInstancesOverlappingBox ( const FBox& Box, bool bBoxInWorldSpace )	Returns the instances with instance bounds overlapping the specified box.
TArray< int3...	GetInstancesOverlappingSphere ( const FVector& Center, float Radius, bool bSphereInWorldSpace )	Returns the instances with instance bounds overlapping the specified sphere.
void	GetNavigationPerInstanceTransforms ( const FBox& AreaBox, TArray< FTransform >& InstanceData )	Handles request from navigation system to gather instance transforms in a specific area box.
int32	GetNumRenderInstances()	Number of instances in the render-side instance buffer.
void	OnPostLoadPerInstanceData()	Creates rendering buffer from serialized data, if any
void	PartialNavigationUpdate ( int32 InstanceIdx )	Request to navigation system to update only part of navmesh occupied by specified instance.
void	PreAllocateInstancesMemory ( int32 AddedInstanceCount )	Preallocated memory to include the new added instances count, to prevent reallloc during the add operation.
bool	RemoveInstance ( int32 InstanceIndex )	Remove the instance specified.
bool	SetCustomData ( int32 InstanceIndex, const TArray< float >& CustomDataF..., bool bMarkRenderStateDirty )	Per Instance Custom Data
bool	SetCustomDataValue ( int32 InstanceIndex, int32 CustomDataIndex, float CustomDataValue, bool bMarkRenderStateDirty )	Update custom data for specific instance
bool	SupportsPartialNavigationUpdate()	Does this component support partial navigation updates
bool	UpdateInstanceTransform ( int32 InstanceIndex, const FTransform& NewInstanceTrans..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	Update the transform for the instance specified.

Overridden from UPrimitiveComponent

		Name	Description
	FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
	void	PropagateLightingScenarioChange()	Updates any visuals after the lighting has changed

Overridden from UActorComponent

		Name	Description
	bool	ShouldCreatePhysicsState()	Return true if CreatePhysicsState() should be called.

Overridden from UObject

	Name	Description
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostEditImport()	Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from INavRelevantInterface

		Name	Description
	FBox	GetNavigationBounds()	Get bounds for navigation octree

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

Take our survey

Dismiss