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.

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/InstancedStaticMeshComponent.h
Include	#include "Components/InstancedStaticMeshComponent.h"

Syntax

class UInstancedStaticMeshComponent : public UStaticMeshComponent

Remarks

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

Variables

	Name	Description
TArray< FInstan...	CachedMappings	The mappings for all the instances of this component.
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.
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	Recorded modifications to per-instance data
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).
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... )	Add an instance to this component. Transform is given in local space of this component.
int32	AddInstanceInternal ( int32 InstanceIndex, FInstancedStaticMeshInstanceData&#..., const FTransform& InstanceTransfor... )	Internal version of AddInstance
int32	AddInstanceWorldSpace ( const FTransform& WorldTransform )	Add an instance to this component. Transform is given in world space.
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..., 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 >> ... )
int32	GetInstanceCount()	Get the number of instances in this component.
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.
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.
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.
bool	RemoveInstanceInternal ( int32 InstanceIndex, bool InstanceAlreadyRemoved )	Internal version of RemoveInstance
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, 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	UpdateInstanceTransform ( int32 InstanceIndex, const FTransform& NewInstanceTrans..., bool bWorldSpace, bool bMarkRenderStateDirty, bool bTeleport )	Update the transform for the instance specified.

Overridden from UStaticMeshComponent

		Name	Description
	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	BuildTextureStreamingData ( ETextureStreamingBuildType BuildTyp..., EMaterialQualityLevel::Type Quality..., ERHIFeatureLevel::Type FeatureLevel, TSet< FGuid >& DependentResources )	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
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.
void	GetLightAndShadowMapMemoryUsage ( int32& LightMapMemoryUsage, int32& ShadowMapMemoryUsage )	Returns the light and shadow map memory for this primitive in its out variables.
void	GetStreamingRenderAssetInfo ( FStreamingTextureLevelContext& Lev..., TArray< FStreamingRenderAssetPrimit... )	Get the StreaminTexture data.
bool	SupportsStaticLighting()	Whether the component type supports static lighting.

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
TStructOnSco...	GetComponentInstanceData()	Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
void	OnComponentCreated()	Called when a component is created (not loaded). This can happen in the editor or during gameplay
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
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	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
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

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

Take our survey

Dismiss