1. Epic GamesDeveloper
  3. UInstancedStaticMeshComponent

UInstancedStaticMeshComponent

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

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function  

UInstancedStaticMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  
Public function   Needs implementation in InstancedStaticMesh.cpp to compile UniquePtr for forward declared class

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual int32

AddInstance ( const FTransform& InstanceTransform,
bool bWorldSpace
)

 Add an instance to this component.
Protected function int32

AddInstanceInternal ( int32 InstanceIndex,
FInstancedStaticMeshInstanceData* InNewInstanceData,
const FTransform& InstanceTransform,
bool bWorldSpace
)

 Internal version of AddInstance
Public function Virtual TArray< int32 >

AddInstances ( const TArray< FTransform >& InstanceTransforms,
bool bShouldReturnIndices,
bool bWorldSpace
)

 Add multiple instances to this component.
Protected function TArray< int32 >

AddInstancesInternal ( TConstArrayView< FTransform > InstanceTransforms,
bool bShouldReturnIndices,
bool bWorldSpace
)

 Internal implementation of AddInstances
Public function Virtual void Applies the cached component instance data to a newly blueprint constructed component.
Protected function void  
Public function Virtual bool

BatchUpdateInstancesData ( int32 StartInstanceIndex,
int32 NumInstances,
FInstancedStaticMeshInstanceData* StartInstanceData,
bool bMarkRenderStateDirty,
bool bTeleport
)

  
Public function Virtual bool

BatchUpdateInstancesTransform ( int32 StartInstanceIndex,
int32 NumInstances,
const FTransform& NewInstancesTransform,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 Update the transform for a number of instances.
Public function Virtual bool

BatchUpdateInstancesTransforms ( int32 StartInstanceIndex,
const TArray< FTransform >& NewInstancesTransforms,
const TArray< FTransform >& NewInstancesPrevTransforms,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 TODO: KevinO cleanup.
Public function Virtual bool

BatchUpdateInstancesTransforms ( int32 StartInstanceIndex,
TArrayView< const FTransform > NewInstancesTransforms,
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
Public function Virtual bool

BatchUpdateInstancesTransforms ( int32 StartInstanceIndex,
const TArray< FTransform >& NewInstancesTransforms,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 Update the transform for an array of instances.
Protected function void Build instance buffer for rendering from current component data.
Protected function void Terminate all body instances owned by this component.
Public function Virtual void Clear all instances being rendered by this component.
Public function void Deselect all instances.
Protected function void Creates body instances for all instances owned by this component.
Protected function void  
Public function void

FlushInstanceUpdateCommands ( bool bFlushInstanceUpdateCmdBuffer
)

  
Public function Const void

GetCullDistances ( int32& OutStartCullDistance,
int32& OutEndCullDistance
)

 Gets the fading start and culling end distances for this component.
Public function Const int32 Get the number of instances in this component.
Public function Const bool

GetInstancePrevTransform ( int32 InstanceIndex,
FTransform& OutInstanceTransform,
bool bWorldSpace
)

 TODO: KevinO cleanup.
Public function Const void

GetInstancesMinMaxScale ( FVector& MinScale,
FVector& MaxScale
)

  
Public function Virtual Const TArray< int32 >

GetInstancesOverlappingBox ( const FBox& Box,
bool bBoxInWorldSpace
)

 Returns the instances with instance bounds overlapping the specified box.
Public function Virtual Const TArray< int32 >

GetInstancesOverlappingSphere ( const FVector& Center,
float Radius,
bool bSphereInWorldSpace
)

 Returns the instances with instance bounds overlapping the specified sphere.
Public function Const bool

GetInstanceTransform ( int32 InstanceIndex,
FTransform& OutInstanceTransform,
bool bWorldSpace
)

 Get the transform for the instance specified.
Protected function Virtual Const void

GetNavigationPerInstanceTransforms ( const FBox& AreaBox,
TArray< FTransform >& InstanceData
)

 Handles request from navigation system to gather instance transforms in a specific area box.
Public function Virtual Const int32 Number of instances in the render-side instance buffer.
Public function Const int32

GetRenderIndex ( int32 InInstanceIndex
)

 Returns the render instance buffer index.
Public function Virtual Const FVector Get the translated space for instance transforms to be passed to the renderer.
Protected function void

InitInstanceBody ( int32 InstanceIdx,
FBodyInstance* InBodyInstance
)

 Initializes the body instance for the specified instance of the static mesh.
Public function void

InitPerInstanceRenderData ( bool InitializeFromCurrentData,
FStaticMeshInstanceData* InSharedInstanceBufferData,
bool InRequireCPUAccess
)

 Initialize the Per Instance Render Data
Public function Const bool

IsInstanceSelected ( int32 InInstanceIndex
)

 Check to see if an instance is selected.
Public function Virtual Const bool

IsInstanceTouchingSelectionBox ( int32 InstanceIndex,
const FBox& InBox,
const bool bMustEncompassEntireInstance
)

  
Public function Virtual Const bool

IsInstanceTouchingSelectionFrustum ( int32 InstanceIndex,
const FConvexVolume& InFrustum,
const bool bMustEncompassEntireInstance
)

  
Public function Const bool

IsValidInstance ( int32 InstanceIndex
)

 Does the given index map to a valid instance in this component?
Protected function Virtual void Creates rendering buffer from serialized data, if any
Protected function Virtual void

PartialNavigationUpdate ( int32 InstanceIdx
)

 Request to navigation system to update only part of navmesh occupied by specified instance.
Public function Virtual void

PreAllocateInstancesMemory ( int32 AddedInstanceCount
)

 Preallocated memory to include the new added instances count, to prevent reallloc during the add operation.
Public function void Transfers ownership of instance render data to a render thread.
Public function Virtual bool

RemoveInstance ( int32 InstanceIndex
)

 Remove the instance specified. Returns True on success.
Protected function bool

RemoveInstanceInternal ( int32 InstanceIndex,
bool InstanceAlreadyRemoved
)

 Internal version of RemoveInstance
Public function Virtual bool

RemoveInstances ( const TArray< int32 >& InstancesToRemove,
bool bInstanceArrayAlreadySortedInReverseOrder
)

 Remove the instances specified. Returns True on success.
Public function Virtual bool

RemoveInstances ( const TArray< int32 >& InstancesToRemove
)

 Remove the instances specified. Returns True on success.
Public function void

SelectInstance ( bool bInSelected,
int32 InInstanceIndex,
int32 InInstanceCount
)

 Select/deselect an instance or group of instances.
Protected function void Serialize instance buffer that is used for rendering. Only for cooked content
Public function void

SetCullDistances ( int32 StartCullDistance,
int32 EndCullDistance
)

 Sets the fading start and culling end distances for this component.
Public function Virtual bool

SetCustomData ( int32 InstanceIndex,
TArrayView< const float > CustomDataFloats,
bool bMarkRenderStateDirty
)

 Per Instance Custom Data
Public function Virtual bool

SetCustomDataValue ( int32 InstanceIndex,
int32 CustomDataIndex,
float CustomDataValue,
bool bMarkRenderStateDirty
)

 Update custom data for specific instance
Public function Virtual void

SetNumCustomDataFloats ( int32 InNumCustomDataFloats
)

 Update number of custom data entries per instance.
Public function void Sets to use RemoveAtSwap on instance removal.
Protected function Virtual Const bool Does this component support partial navigation updates
Public function Virtual Const bool Returns true if RemoveAtSwap is enabled.
Public function Virtual bool

UpdateInstances ( const TArray< int32 >& UpdateInstanceIds,
const TArray< FTransform >& UpdateInstanceTransforms,
const TArray< FTransform >& UpdateInstancePreviousTransforms,
int32 NumCustomFloats,
const TArray< float >& CustomFloatData
)

 Lightweight interface to add, remove and update instances.
Public function Virtual bool

UpdateInstanceTransform ( int32 InstanceIndex,
const FTransform& NewInstanceTransform,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 Update the transform for the instance specified.

Overridden from UStaticMeshComponent

  Type Name Description
Protected function Virtual FPrimitiveSceneProxy *

CreateStaticMeshSceneProxy ( Nanite::FMaterialAudit& NaniteMaterials,
bool bCreateNanite
)

 Overload this in child implementations that wish to extend Static Mesh or Nanite scene proxy implementations.
Public function Virtual void

GetStaticLightingInfo ( FStaticLightingPrimitiveInfo& OutPrimitiveInfo,
const TArray< ULightComponent* >& InRelevantLights,
const FLightingBuildOptions& Options
)

  
Public function Virtual Const float Get the scale comming form the component, when computing StreamingTexture data.

Overridden from UMeshComponent

  Type Name Description
Public function Virtual Const bool

GetMaterialStreamingData ( int32 MaterialIndex,
FPrimitiveMaterialInfo& MaterialData
)

 Get material, UV density and bounds for a given material index.

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual bool

BuildTextureStreamingDataImpl ( ETextureStreamingBuildType BuildType,
EMaterialQualityLevel::Type QualityLevel,
ERHIFeatureLevel::Type FeatureLevel,
TSet< FGuid >& DependentResources,
bool& bOutSupportsBuildTextureStreamingData
)

 Build the data to compute accuracte StreaminTexture data.
Public function Virtual bool Determines whether or not the simulate physics setting can be edited interactively on this component
Public function Virtual void

CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FComponentPSOPrecacheParamsList& OutParams
)

 Precache all PSOs which can be used by the component
Public function Virtual Const bool

ComponentIsTouchingSelectionBox ( const FBox& InSelBBox,
const bool bConsiderOnlyBSP,
const bool bMustEncompassEntireComponent
)

 Determines whether the supplied bounding box intersects with the component.
Public function Virtual Const bool

ComponentIsTouchingSelectionFrustum ( const FConvexVolume& InFrustum,
const bool bConsiderOnlyBSP,
const bool bMustEncompassEntireComponent
)

 Determines whether the supplied frustum intersects with the component.
Protected function Virtual bool

ComponentOverlapComponentImpl ( UPrimitiveComponent* PrimComp,
const FVector Pos,
const FQuat& Rot,
const FCollisionQueryParams& Params
)

 Override this method for custom behavior for ComponentOverlapComponent()
Protected function Virtual Const bool

ComponentOverlapMultiImpl ( TArray< struct FOverlapResult >& OutOverlaps,
const UWorld* InWorld,
const FVector& Pos,
const FQuat& Rot,
ECollisionChannel TestChannel,
const FComponentQueryParams& Params,
const FCollisionObjectQueryParams& ObjectQueryParams
)

 Override this method for custom behavior for ComponentOverlapMulti()
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const bool Collects custom navigable geometry of component.
Public function Virtual Const FBodyInstance *

GetBodyInstance ( FName BoneName,
bool bGetWelded,
int32 Index
)

 Returns BodyInstance of the component.
Public function Virtual Const void

GetLightAndShadowMapMemoryUsage ( int32& LightMapMemoryUsage,
int32& ShadowMapMemoryUsage
)

 Returns the light and shadow map memory for this primitive in its out variables.
Public function Virtual Const FMatrix Returns the matrix that should be used to render this component.
Public function Virtual Const void Get the StreaminTexture data.
Public function Virtual bool

LineTraceComponent ( FHitResult& OutHit,
const FVector Start,
const FVector End,
const FCollisionQueryParams& Params
)

 Trace a ray against just this component.
Public function Virtual Const bool

OverlapComponent ( const FVector& Pos,
const FQuat& Rot,
const FCollisionShape& CollisionShape
)

  
Public function Virtual Const bool Whether the component type supports static lighting.
Public function Virtual bool

SweepComponent ( FHitResult& OutHit,
const FVector Start,
const FVector End,
const FQuat& ShapeWorldRotation,
const FCollisionShape& CollisionShape,
bool bTraceComplex
)

 Trace a shape against just this component.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual void

OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

 Native callback when this component is moved
Public function Virtual void Updates any visuals after the lighting has changed

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

GetComponentChildElements ( TArray< FTypedElementHandle >& OutElementHandles,
const bool bAllowCreate
)

 Get the logical child elements of this component, if any.
Public function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
Public function Virtual Const FBox  
Public function Virtual Const bool Override to specify that a component is relevant to the HLOD generation.
Protected function Virtual void Used to create any physics engine information for this component
Protected function Virtual void Used to shut down and physics engine structure for this component
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called to send instance data for this component to the rendering thread
Public function Virtual Const bool Return true if CreatePhysicsState() should be called.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 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).
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from INavRelevantInterface

  Type Name Description
Public function Virtual Const FBox Get bounds for navigation octree
Public function Virtual Const void Prepare navigation modifiers
Public function Virtual Const bool Are modifiers active?

Overridden from ISMInstanceManager

  Type Name Description
Protected function Virtual Const bool

CanEditSMInstance ( const FSMInstanceId& InstanceId
)

 Can the given static mesh instance be edited?
Protected function Virtual Const bool

CanMoveSMInstance ( const FSMInstanceId& InstanceId,
const ETypedElementWorldType WorldType
)

 Can the given static mesh instance be moved in the world?
Protected function Virtual bool

DeleteSMInstances ( TArrayView< const FSMInstanceId > InstanceIds
)

 Attempt to delete the given static mesh instances.
Protected function Virtual bool

DuplicateSMInstances ( TArrayView< const FSMInstanceId > InstanceIds,
TArray< FSMInstanceId >& OutNewInstanceIds
)

 Attempt to duplicate the given static mesh instances, retrieving the IDs of any new instances.
Protected function Virtual Const bool

GetSMInstanceTransform ( const FSMInstanceId& InstanceId,
FTransform& OutInstanceTransform,
bool bWorldSpace
)

 Attempt to get the transform of the given static mesh instance.
Protected function Virtual void Notify that the given static mesh instance is done being moved.
Protected function Virtual void Notify that the given static mesh instance is currently being moved.
Protected function Virtual void Notify that the given static mesh instance is about to be moved.
Protected function Virtual void

NotifySMInstanceSelectionChanged ( const FSMInstanceId& InstanceId,
const bool bIsSelected
)

 Notify that the given static mesh instance selection state has changed.
Protected function Virtual bool

SetSMInstanceTransform ( const FSMInstanceId& InstanceId,
const FTransform& InstanceTransform,
bool bWorldSpace,
bool bMarkRenderStateDirty,
bool bTeleport
)

 Attempt to set the transform of the given static mesh instance.

Enums

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

Deprecated Functions

  Type Name Description
Public function int32

AddInstanceWorldSpace ( const FTransform& WorldTransform
)

 Use AddInstance or AddInstances with bWorldSpace set to true.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page