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 > UInstancedStaticMeshComponent

Light Theme

Dark Theme

UInstancedStaticMeshComponent

A component that efficiently renders multiple instances of the same StaticMesh.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

UStaticMeshComponent

UInstancedStaticMeshComponent

UHierarchicalInstancedStaticMeshComponent

	UFoliageInstancedStaticMeshComponent
	UGrassInstancedStaticMeshComponent

UHLODTemplatedInstancedStaticMeshComponent

UMassInstancedStaticMeshComponent

References

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

Syntax

class UInstancedStaticMeshComponent :
public UStaticMeshComponent,
public ISMInstanceManager

Remarks

A component that efficiently renders multiple instances of the same StaticMesh.

Variables

	Name	Description
TArray< FInstan...	AdditionalRandomSeeds	Additional random seeds ranges.
bool	bForceShowAllInstancesDetails	Indicates that the user has purposedly chosen to show the instance list in the details panel, despite the performance warning.
bool	bSupportRemoveAtSwap	Flag for using RemoveAtSwap on instance removal.
TArray< FInstan...	CachedMappings	The mappings for all the instances of this component.
EInstanceDeleti...	DeletionState	This will be set to the appropriate state when one or more instances are in the process of being deleted.
friend	FInstancedLightMap2D
friend	FInstancedShadowMap2D
friend	FStaticLightingTextureMapping_InstancedStaticMesh
TArray< FBodyIn...	InstanceBodies	Physics representation of the instance bodies.
TUniquePtr< FSt...	InstanceDataBuffers	Buffers with per-instance data laid out for rendering.
int32	InstanceEndCullDistance	Distance from camera at which each instance completely fades out.
TMap< int32, in...	InstanceIdToInstanceIndexMap	Used to cache a unique identifier for each instance.
TArray< int32 >	InstanceReorderTable	Mapping from PerInstanceSMData order to instance render buffer order.
int32	InstanceStartCullDistance	Distance from camera at which each instance begins to fade out.
FInstanceUpdate...	InstanceUpdateCmdBuffer	This is here because in void FScene::UpdatePrimitiveInstance(UPrimitiveComponent* Primitive) we want access to the instances updates through the primitive component in a generic way.
int32	InstancingRandomSeed	Value used to seed the random number stream that generates random numbers for each of this mesh's instances.
int32	NumCustomDataFloats	Defines the number of floats that will be available per instance for custom data
int32	NumPendingLightmaps	Number of pending lightmaps still to be calculated (Apply()'d).
TArray< int32 >	PerInstanceIds
TArray< FMatrix...	PerInstancePrevTransform	TODO: KevinO cleanup.
TSharedPtr< FPe...	PerInstanceRenderData	Render data will be initialized on PostLoad or on demand. Released on the rendering thread.
TArray< float >	PerInstanceSMCustomData	Array of custom data for instances.
TArray< FInstan...	PerInstanceSMData	Array of instances, bulk serialized.
SIZE_T	ProxySize	Tracks outstanding proxysize, as this is a bit hard to do with the fire-and-forget grass.
TBitArray	SelectedInstances	One bit per instance if the instance is selected.

Constructors

	Name	Description
	UInstancedStaticMeshComponent ( const FObjectInitializer& ObjectIn... )
	UInstancedStaticMeshComponent ( FVTableHelper& Helper )	Needs implementation in InstancedStaticMesh.cpp to compile UniquePtr for forward declared class

Destructors

	Name	Description
	~UInstancedStaticMeshComponent()

Functions

	Name	Description
int32	AddInstance ( const FTransform& InstanceTransfor..., bool bWorldSpace )	Add an instance to this component.
int32	AddInstanceInternal ( int32 InstanceIndex, FInstancedStaticMeshInstanceData&#..., const FTransform& InstanceTransfor..., bool bWorldSpace )	Internal version of AddInstance
TArray< int3...	AddInstances ( const TArray< FTransform >& Instan..., bool bShouldReturnIndices, bool bWorldSpace )	Add multiple instances to this component.
TArray< int3...	AddInstancesInternal ( TConstArrayView< FTransform > Insta..., bool bShouldReturnIndices, bool bWorldSpace )	Internal implementation of AddInstances
void	ApplyComponentInstanceData ( FInstancedStaticMeshComponentInstan... )	Applies the cached component instance data to a newly blueprint constructed component.
void	ApplyLightMapping ( FStaticLightingTextureMapping_Insta..., ULevel* LightingScenario )
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..., const TArray< FTransform >& NewIns..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	TODO: KevinO cleanup.
bool	BatchUpdateInstancesTransforms ( int32 StartInstanceIndex, TArrayView< const FTransform > NewI..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	This is array view version of the UFUNCTION, blueprints do not support ArrayViews at the time of adding this one
bool	BatchUpdateInstancesTransforms ( int32 StartInstanceIndex, const TArray< FTransform >& NewIns..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	Update the transform for an array of instances.
void	BuildRenderData ( FStaticMeshInstanceData& OutData, TArray< TRefCountPtr< HHitProxy >> ... )	Build instance buffer for rendering from current component data.
void	ClearAllInstanceBodies()	Terminate all body instances owned by this component.
void	ClearInstances()	Clear all instances being rendered by this component.
void	ClearInstanceSelection()	Deselect all instances.
void	CreateAllInstanceBodies()	Creates body instances for all instances owned by this component.
void	CreateHitProxyData ( TArray< TRefCountPtr< HHitProxy >> ... )
void	FlushInstanceUpdateCommands ( bool bFlushInstanceUpdateCmdBuffer )
void	GetCullDistances ( int32& OutStartCullDistance, int32& OutEndCullDistance )	Gets the fading start and culling end distances for this component.
int32	GetInstanceCount()	Get the number of instances in this component.
bool	GetInstancePrevTransform ( int32 InstanceIndex, FTransform& OutInstanceTransform, bool bWorldSpace )	TODO: KevinO cleanup.
void	GetInstancesMinMaxScale ( FVector& MinScale, FVector& MaxScale )
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.
bool	GetInstanceTransform ( int32 InstanceIndex, FTransform& OutInstanceTransform, bool bWorldSpace )	Get the transform for the instance specified.
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.
int32	GetRenderIndex ( int32 InInstanceIndex )	Returns the render instance buffer index.
FVector	GetTranslatedInstanceSpaceOrigin()	Get the translated space for instance transforms to be passed to the renderer.
void	InitInstanceBody ( int32 InstanceIdx, FBodyInstance* InBodyInstance )	Initializes the body instance for the specified instance of the static mesh.
void	InitPerInstanceRenderData ( bool InitializeFromCurrentData, FStaticMeshInstanceData* InSha..., bool InRequireCPUAccess )	Initialize the Per Instance Render Data
bool	IsInstanceSelected ( int32 InInstanceIndex )	Check to see if an instance is selected.
bool	IsInstanceTouchingSelectionBox ( int32 InstanceIndex, const FBox& InBox, const bool bMustEncompassEntireInst... )
bool	IsInstanceTouchingSelectionFrustum ( int32 InstanceIndex, const FConvexVolume& InFrustum, const bool bMustEncompassEntireInst... )
bool	IsValidInstance ( int32 InstanceIndex )	Does the given index map to a valid instance in this component?
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.
void	ReleasePerInstanceRenderData()	Transfers ownership of instance render data to a render thread.
bool	RemoveInstance ( int32 InstanceIndex )	Remove the instance specified. Returns True on success.
bool	RemoveInstanceInternal ( int32 InstanceIndex, bool InstanceAlreadyRemoved )	Internal version of RemoveInstance
bool	RemoveInstances ( const TArray< int32 >& InstancesTo..., bool bInstanceArrayAlreadySortedInR... )	Remove the instances specified. Returns True on success.
bool	RemoveInstances ( const TArray< int32 >& InstancesTo... )	Remove the instances specified. Returns True on success.
void	SelectInstance ( bool bInSelected, int32 InInstanceIndex, int32 InInstanceCount )	Select/deselect an instance or group of instances.
void	SerializeRenderData ( FArchive& Ar )	Serialize instance buffer that is used for rendering. Only for cooked content
void	SetCullDistances ( int32 StartCullDistance, int32 EndCullDistance )	Sets the fading start and culling end distances for this component.
bool	SetCustomData ( int32 InstanceIndex, TArrayView< const float > CustomDat..., bool bMarkRenderStateDirty )	Per Instance Custom Data
bool	SetCustomDataValue ( int32 InstanceIndex, int32 CustomDataIndex, float CustomDataValue, bool bMarkRenderStateDirty )	Update custom data for specific instance
void	SetNumCustomDataFloats ( int32 InNumCustomDataFloats )	Update number of custom data entries per instance.
void	SetRemoveSwap()	Sets to use RemoveAtSwap on instance removal.
bool	SupportsPartialNavigationUpdate()	Does this component support partial navigation updates
bool	SupportsRemoveSwap()	Returns true if RemoveAtSwap is enabled.
bool	UpdateInstances ( const TArray< int32 >& UpdateInsta..., const TArray< FTransform >& Update..., const TArray< FTransform >& Update..., int32 NumCustomFloats, const TArray< float >& CustomFloat... )	Lightweight interface to add, remove and update instances.
bool	UpdateInstanceTransform ( int32 InstanceIndex, const FTransform& NewInstanceTrans..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	Update the transform for the instance specified.

Overridden from UStaticMeshComponent

	Name	Description
FPrimitiveSc...	CreateStaticMeshSceneProxy ( Nanite::FMaterialAudit& NaniteMate..., bool bCreateNanite )	Overload this in child implementations that wish to extend Static Mesh or Nanite scene proxy implementations.
void	GetStaticLightingInfo ( FStaticLightingPrimitiveInfo& OutP..., const TArray< ULightComponent*..., const FLightingBuildOptions& Optio... )
float	GetTextureStreamingTransformScale()	Get the scale comming form the component, when computing StreamingTexture data.

Overridden from UMeshComponent

		Name	Description
	bool	GetMaterialStreamingData ( int32 MaterialIndex, FPrimitiveMaterialInfo& MaterialDa... )	Get material, UV density and bounds for a given material index.

Overridden from UPrimitiveComponent

	Name	Description
bool	BuildTextureStreamingDataImpl ( ETextureStreamingBuildType BuildTyp..., EMaterialQualityLevel::Type Quality..., ERHIFeatureLevel::Type FeatureLevel, TSet< FGuid >& DependentResources, bool& bOutSupportsBuildTextureStre... )	Build the data to compute accuracte StreaminTexture data.
bool	CanEditSimulatePhysics()	Determines whether or not the simulate physics setting can be edited interactively on this component
void	CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrec..., FComponentPSOPrecacheParamsList& O... )	Precache all PSOs which can be used by the component
bool	ComponentIsTouchingSelectionBox ( const FBox& InSelBBox, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComp... )	Determines whether the supplied bounding box intersects with the component.
bool	ComponentIsTouchingSelectionFrustum ( const FConvexVolume& InFrustum, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComp... )	Determines whether the supplied frustum intersects with the component.
bool	ComponentOverlapComponentImpl ( UPrimitiveComponent* PrimComp, const FVector Pos, const FQuat& Rot, const FCollisionQueryParams& Param... )	Override this method for custom behavior for ComponentOverlapComponent()
bool	ComponentOverlapMultiImpl ( TArray< struct FOverlapResult >& O..., const UWorld* InWorld, const FVector& Pos, const FQuat& Rot, ECollisionChannel TestChannel, const FComponentQueryParams& Param..., const FCollisionObjectQueryParams&... )	Override this method for custom behavior for ComponentOverlapMulti()
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
bool	DoCustomNavigableGeometryExport ( FNavigableGeometryExport& GeomExpo... )	Collects custom navigable geometry of component.
FBodyInstanc...	GetBodyInstance ( FName BoneName, bool bGetWelded, int32 Index )	Returns BodyInstance of the component.
void	GetLightAndShadowMapMemoryUsage ( int32& LightMapMemoryUsage, int32& ShadowMapMemoryUsage )	Returns the light and shadow map memory for this primitive in its out variables.
FMatrix	GetRenderMatrix()	Returns the matrix that should be used to render this component.
void	GetStreamingRenderAssetInfo ( FStreamingTextureLevelContext& Lev..., TArray< FStreamingRenderAssetPrimit... )	Get the StreaminTexture data.
bool	LineTraceComponent ( FHitResult& OutHit, const FVector Start, const FVector End, const FCollisionQueryParams& Param... )	Trace a ray against just this component.
bool	OverlapComponent ( const FVector& Pos, const FQuat& Rot, const FCollisionShape& CollisionSh... )
bool	SupportsStaticLighting()	Whether the component type supports static lighting.
bool	SweepComponent ( FHitResult& OutHit, const FVector Start, const FVector End, const FQuat& ShapeWorldRotation, const FCollisionShape& CollisionSh..., bool bTraceComplex )	Trace a shape against just this component.

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	OnUpdateTransform ( EUpdateTransformFlags UpdateTransfo..., ETeleportType Teleport )	Native callback when this component is moved
void	PropagateLightingScenarioChange()	Updates any visuals after the lighting has changed

Overridden from UActorComponent

	Name	Description
void	GetComponentChildElements ( TArray< FTypedElementHandle >& Out..., const bool bAllowCreate )	Get the logical child elements of this component, if any.
TStructOnSco...	GetComponentInstanceData()	Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
FBox	GetStreamingBounds()
bool	IsHLODRelevant()	Override to specify that a component is relevant to the HLOD generation.
void	OnCreatePhysicsState()	Used to create any physics engine information for this component
void	OnDestroyPhysicsState()	Used to shut down and physics engine structure for this component
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	SendRenderInstanceData_Concurrent()	Called to send instance data for this component to the rendering thread
bool	ShouldCreatePhysicsState()	Return true if CreatePhysicsState() should be called.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
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	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
void	GetNavigationData ( FNavigationRelevantData& Data )	Prepare navigation modifiers
bool	IsNavigationRelevant()	Are modifiers active?

Overridden from ISMInstanceManager

	Name	Description
bool	CanEditSMInstance ( const FSMInstanceId& InstanceId )	Can the given static mesh instance be edited?
bool	CanMoveSMInstance ( const FSMInstanceId& InstanceId, const ETypedElementWorldType WorldT... )	Can the given static mesh instance be moved in the world?
bool	DeleteSMInstances ( TArrayView< const FSMInstanceId > I... )	Attempt to delete the given static mesh instances.
bool	DuplicateSMInstances ( TArrayView< const FSMInstanceId > I..., TArray< FSMInstanceId >& OutNewIns... )	Attempt to duplicate the given static mesh instances, retrieving the IDs of any new instances.
bool	GetSMInstanceTransform ( const FSMInstanceId& InstanceId, FTransform& OutInstanceTransform, bool bWorldSpace )	Attempt to get the transform of the given static mesh instance.
void	NotifySMInstanceMovementEnded ( const FSMInstanceId& InstanceId )	Notify that the given static mesh instance is done being moved.
void	NotifySMInstanceMovementOngoing ( const FSMInstanceId& InstanceId )	Notify that the given static mesh instance is currently being moved.
void	NotifySMInstanceMovementStarted ( const FSMInstanceId& InstanceId )	Notify that the given static mesh instance is about to be moved.
void	NotifySMInstanceSelectionChanged ( const FSMInstanceId& InstanceId, const bool bIsSelected )	Notify that the given static mesh instance selection state has changed.
bool	SetSMInstanceTransform ( const FSMInstanceId& InstanceId, const FTransform& InstanceTransfor..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	Attempt to set the transform of the given static mesh instance.

Enums

	Name	Description
	EInstanceDeletionReason	The reason why a deletion operation is currently happening.

Deprecated Functions

		Name	Description
	int32	AddInstanceWorldSpace ( const FTransform& WorldTransform )	Use AddInstance or AddInstances with bWorldSpace set to true.

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

Take our survey

Cancel