1. Epic GamesDeveloper
  3. UStaticMeshComponent

UStaticMeshComponent

StaticMeshComponent is used to create an instance of a [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh).

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

Inheritance Hierarchy

References

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

Syntax

class UStaticMeshComponent : public UMeshComponent

Remarks

StaticMeshComponent is used to create an instance of a UStaticMesh. A static mesh is a piece of geometry that consists of a static set of polygons.

Variables

  Type Name Description
Public variable uint8: 1 bCastDistanceFieldIndirectShadow Whether to use the mesh distance field representation (when present) for shadowing indirect lighting (from lightmaps or skylight) on Movable components.
Public variable uint8: 1 bCustomOverrideVertexColorPerLOD The component has some custom painting on LODs or not.
Public variable uint8: 1 bDisallowMeshPaintPerInstance If true, mesh painting is disallowed on this instance.
Public variable uint8: 1 bDisallowNanite Forces this component to use fallback mesh for rendering if Nanite is enabled on the mesh.
Public variable uint8: 1 bDisplayNaniteFallbackMesh For Nanite enabled meshes, we'll only show the proxy mesh if this is true
Public variable uint8: 1 bDisplayPhysicalMaterialMasks  
Public variable uint8: 1 bDisplayVertexColors  
Public variable uint8: 1 bDrawMeshCollisionIfComplex Draw mesh collision if used for complex collision
Public variable uint8: 1 bDrawMeshCollisionIfSimple Draw mesh collision if used for simple collision
Public variable uint8: 1 bEvaluateWorldPositionOffset Whether to evaluate World Position Offset. This is only used when running with r.OptimizedWPO=1
Public variable uint8: 1 bEvaluateWorldPositionOffsetInRayTracing Whether to evaluate World Position Offset for ray tracing.
Public variable uint8: 1 bForceDisableNanite Forces this component to use fallback mesh for rendering if Nanite is enabled on the mesh (run-time override)
Public variable uint8: 1 bForceNaniteForMasked Forces this component to always use Nanite for masked materials, even if FNaniteSettings::bAllowMaskedMaterials=false
Public variable uint8: 1 bForceNavigationObstacle Allows overriding navigation export behavior per component: full collisions or dynamic obstacle
Public variable uint8: 1 bIgnoreInstanceForTextureStreaming Ignore this instance of this static mesh when calculating streaming information.
Protected variable uint8: 1 bInitialEvaluateWorldPositionOffset Initial value of bEvaluateWorldPositionOffset when BeginPlay() was called.
Public variable uint8: 1 bOverrideDistanceFieldSelfShadowBias Whether to override the DistanceFieldSelfShadowBias setting of the static mesh asset with the DistanceFieldSelfShadowBias of this component.
Public variable uint8: 1 bOverrideLightMapRes Whether to override the lightmap resolution defined in the static mesh.
Public variable uint8: 1 bOverrideMinLOD Whether to override the MinLOD setting of the static mesh asset with the MinLOD of this component.
Public variable uint8: 1 bOverrideNavigationExport If true, bForceNavigationObstacle flag will take priority over navigation data stored in StaticMesh
Public variable uint8: 1 bOverrideWireframeColor If true, WireframeColorOverride will be used.
Public variable uint8: 1 bReverseCulling Controls whether the static mesh component's backface culling should be reversed
Public variable uint8: 1 bSortTriangles Enable dynamic sort mesh's triangles to remove ordering issue when rendered with a translucent material
Public variable uint8: 1 bUseDefaultCollision Use the collision profile specified in the StaticMesh asset.
Public variable uint8: 1 bUseSubDivisions Whether to use subdivisions or just the triangle's vertices.
Public variable uint8: 1 bWorldPositionOffsetWritesVelocity Whether world position offset turns on velocity writes.
Public variable float DistanceFieldIndirectShadowMinVisibility Controls how dark the dynamic indirect shadow can be.
Public variable float DistanceFieldSelfShadowBias Useful for reducing self shadowing from distance field methods when using world position offset to animate the mesh's vertices.
Public variable int32 ForcedLodModel If 0, auto-select LOD level. if >0, force to (ForcedLodModel-1).
Public variable FLightmassPrimitiveSettings LightmassSettings The Lightmass settings for this object.
Public variable TArray< struct FStaticMeshComponentLODInfo > LODData Static mesh LOD data. Contains static lighting data along with instanced mesh vertex colors.
Public variable int32 MaterialIndexPreview Index of the material to preview.
Public variable TArray< uint32 > MaterialStreamingRelativeBoxes Material Bounds used for texture streaming.
Public variable int32 MinLOD Specifies the smallest LOD that will be used for this component.
Public variable int32 OverriddenLightMapRes Light map resolution to use on this component, used if bOverrideLightMapRes is true and there is a valid StaticMesh.
Public variable int32 SectionIndexPreview Index of the section to preview.
Public variable int32 SelectedEditorMaterial The material currently selected in the Editor. Used for highlighting
Public variable int32 SelectedEditorSection The section currently selected in the Editor. Used for highlighting
Public variable FString StaticMeshDerivedDataKey Derived data key of the static mesh, used to determine if an update from the source static mesh is required.
Public variable int32 StaticMeshImportVersion The import version of the static mesh when it was assign this is update when:
Public variable float StreamingDistanceMultiplier Allows adjusting the desired streaming distance of streaming textures that uses UV 0.
Public variable TArray< FStreamingTextureBuildInfo > StreamingTextureData The list of texture, bounds and scales. As computed in the texture streaming build process.
Public variable int32 SubDivisionStepSize Subdivision step size for static vertex lighting.
Public variable FColor WireframeColorOverride Wireframe color to use if bOverrideWireframeColor is true
Public variable int32 WorldPositionOffsetDisableDistance Distance at which to disable World Position Offset for an entire instance (0 = Never disable WPO).

Constructors

  Type Name Description
Public function  

UStaticMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void  
Public function Virtual FStaticMeshStaticLightingMesh *

AllocateStaticLightingMesh ( int32 LODIndex,
const TArray< ULightComponent* >& InRelevantLights
)

 Allocates an implementation of FStaticLightingMesh that will handle static lighting for this component
Public function void  
Public function void Save off the data painted on to this mesh per LOD if necessary
Protected function Const void

CollectPSOPrecacheDataImpl ( const FVertexFactoryType* VFType,
const FPSOPrecacheParams& BasePrecachePSOParams,
GetPSOVertexElementsFn GetVertexElements,
FComponentPSOPrecacheParamsList& OutParams
)

  
Public function void Copies instance vertex colors from the SourceComponent into this component
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 bool

FixupOverrideColorsIfNecessary ( bool bRebuildingStaticMesh
)

 Update the vertex override colors if necessary (i.e. vertices from source mesh have changed from override colors)
Public function Const int32 Get this components index in its parents blueprint created components array (used for matching instance data)
Public function Virtual Const bool

GetEstimatedLightAndShadowMapMemoryUsage ( int32& TextureLightMapMemoryUsage,
int32& TextureShadowMapMemoryUsage,
int32& VertexLightMapMemoryUsage,
int32& VertexShadowMapMemoryUsage,
int32& StaticLightingResolution,
bool& bIsUsingTextureMapping,
bool& bHasLightmapTexCoords
)

 Returns the light and shadow map memory for this primite in its out variables.
Public function Virtual Const void

GetEstimatedLightMapResolution ( int32& Width,
int32& Height
)

 Returns the lightmap resolution used for this primitive instance in the case of it supporting texture light/ shadow maps.
Public function bool Get the initial value of bEvaluateWorldPositionOffset.
Public function Const void

GetLocalBounds ( FVector& Min,
FVector& Max
)

 Get Local bounds
Public function Static const FName Helper function to get the FName of the private static mesh member
Public function Const const FMeshMapBuildData *

GetMeshMapBuildData ( const FStaticMeshComponentLODInfo& LODInfo,
bool bCheckForResourceCluster
)

  
Public function Const UMaterialInterface *

GetNaniteAuditMaterial ( int32 MaterialIndex
)

  
Public function Virtual Const const Nanite::FResources *  
Public function Const UStaticMeshSocket const *

GetSocketByName ( FName InSocketName
)

 Returns the named socket on the static mesh component.
Public function Virtual void

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

  
Public function Const TObjectPtr< UStaticMesh > Get the StaticMesh used by this instance.
Public function Virtual Const void

GetTextureLightAndShadowMapMemoryUsage ( int32 InWidth,
int32 InHeight,
int32& OutLightMapMemoryUsage,
int32& OutShadowMapMemoryUsage
)

 Get the memory used for texture-based light and shadow maps of the given width and height
Public function Virtual Const float Get the scale comming form the component, when computing StreamingTexture data.
Public function Const FColor Returns the wireframe color to use for this component.
Public function Virtual Const bool Returns true if the static mesh the component uses has valid lightmap texture coordinates
Public function Virtual Const bool Returns true if the component has valid Nanite render data.
Public function Virtual FOnGetNaniteResources &  
Public function Virtual Const const FOnGetNaniteResources &  
Public function void

OnRep_StaticMesh ( UStaticMesh* OldStaticMesh
)

  
Public function Virtual FOnStaticMeshChanged &  
Public function Virtual void  
Public function void  
Public function void Removes instance vertex colors from all LODs
Public function void

RemoveInstanceVertexColorsFromLOD ( int32 LODToRemoveColorsFrom
)

 Removes instance vertex colors from the specified LOD
Public function bool Determines whether any of the component's LODs require override vertex color fixups
Public function void

SetDistanceFieldSelfShadowBias ( float NewValue
)

 Sets the component's DistanceFieldSelfShadowBias.
Public function void

SetEvaluateWorldPositionOffset ( bool NewValue
)

  
Public function void  
Public function void

SetForceDisableNanite ( bool bInForceDisableNanite
)

 Force disabling of Nanite rendering. When true, Will swap to the the fallback mesh instead.
Public function void

SetForcedLodModel ( int32 NewForcedLodModel
)

  
Public function bool

SetLODDataCount ( const uint32 MinSize,
const uint32 MaxSize
)

 Add or remove elements to have the size in the specified range.
Public function void

SetMaterialPreview ( int32 InMaterialIndexPreview
)

 Sets the value of the MaterialIndexPreview flag and reattaches the component as necessary.
Public function void

SetReverseCulling ( bool ReverseCulling
)

 Set forced reverse culling
Public function void

SetSectionPreview ( int32 InSectionIndexPreview
)

 Sets the value of the SectionIndexPreview flag and reattaches the component as necessary.
Public function Virtual bool

SetStaticLightingMapping ( bool bTextureMapping,
int32 ResolutionToUse
)

 Switches the static mesh component to use either Texture or Vertex static lighting.
Public function Virtual bool

SetStaticMesh ( UStaticMesh* NewMesh
)

 Change the StaticMesh used by this instance.
Public function void  
Protected function Const bool  
Public function Virtual bool Whether or not the component supports default collision from its static mesh asset
Public function Virtual bool Whether we can support dithered LOD transitions (default behavior checks all materials).
Public function void Sets the BodyInstance to use the mesh's body setup for external collision information
Public function Virtual Const bool

UsesTextureLightmaps ( int32 InWidth,
int32 InHeight
)

 Returns true if the component uses texture lightmaps

Overridden from UMeshComponent

  Type Name Description
Public function Virtual Const int32

GetMaterialIndex ( FName MaterialSlotName
)

  
Public function Virtual Const TArray< FName >  
Public function Virtual Const bool

GetMaterialStreamingData ( int32 MaterialIndex,
FPrimitiveMaterialInfo& MaterialData
)

 Get material, UV density and bounds for a given material index.
Public function Virtual Const bool

IsMaterialSlotNameValid ( FName MaterialSlotName
)

  
Public function Virtual Const bool Determines if we use the nanite overrides from any materials

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual Const void

AddMapBuildDataGUIDs ( TSet< FGuid >& InGUIDs
)

 Add the used GUIDs from UMapBuildDataRegistry::MeshBuildData.
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
Protected function Virtual void

CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams,
FComponentPSOPrecacheParamsList& OutParams
)

 Collect all the PSO precache data used by the static mesh 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.
Public function Virtual Const uint32 Computes a hash of component's texture streaming built data.
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 UBodySetup * Return the BodySetup to use for this PrimitiveComponent (single body case)
Public function Virtual Const float

GetDiffuseBoost ( int32 ElementIndex
)

 Gets the diffuse boost for the primitive component.
Public function Virtual Const UMaterialInterface *

GetEditorMaterial ( int32 ElementIndex
)

 Returns the material to show in the editor details panel as being used.
Public function Virtual Const float

GetEmissiveBoost ( int32 ElementIndex
)

 Gets the emissive boost for the primitive 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 bool

GetLightMapResolution ( int32& Width,
int32& Height
)

 Returns the lightmap resolution used for this primitive instance in the case of it supporting texture light/ shadow maps.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const UMaterialInterface *

GetMaterialFromCollisionFaceIndex ( int32 FaceIndex,
int32& SectionIndex
)

 Try and retrieve the material applied to a particular collision face of mesh.
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const bool Disable dynamic shadow casting if the primitive only casts indirect shadows, since dynamic shadows are always shadowing direct lighting
Public function Virtual Const ELightMapInteractionType Requests whether the component will use texture, vertex or no lightmaps.
Public function Virtual Const int32 Returns the static lightmap resolution used for this primitive.
Public function Virtual Const void Get the StreaminTexture data.
Public function Virtual Const float  
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

 Retrieves the materials used in this component
Public function Virtual Const bool

HasValidSettingsForStaticLighting ( bool bOverlookInvalidComponents
)

 Returns true if the component is static AND has the right static mesh setup to support lightmaps.
Public function Virtual Const bool

IsShown ( const FEngineShowFlags& ShowFlags
)

 Would this primitive be shown with these rendering flags.
Public function Virtual bool Remaps the texture streaming built data that was built for the actor back to the level.
Public function Virtual void

SetCollisionProfileName ( FName InCollisionProfileName,
bool bUpdateOverlaps
)

 Set Collision Profile Name This function is called by constructors when they set ProfileName This will change current CollisionProfileName to be this, and overwrite Collision Setting
Public function Virtual Const bool Determines whether the proxy for this primitive type needs to be recreated whenever the primitive moves.
Public function Virtual Const bool Return true if the owner is selected and this component is selectable
Protected function Virtual Const bool Whether the component type supports static lighting.
Public function Virtual Const bool Returns false if this primitive should never output velocity based on its WPO state.
Public function Virtual Const bool Returns true if only unlit materials are used for rendering, false otherwise.

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 Const bool

DoesSocketExist ( FName InSocketName
)

 Return true if socket with the given name exists
Public function Virtual bool

GetMaterialPropertyPath ( int32 ElementIndex,
UObject*& OutOwner,
FString& OutPropertyPath,
FProperty*& OutProperty
)

 Returns full material property path and UObject owner property object Path examples: Material property path with array element and inner struct Materials[0].InnerStruct.Material Material property path with array element Materials[0] Simple material property path Materials
Public function Virtual Const FTransform

GetSocketTransform ( FName InSocketName,
ERelativeTransformSpace TransformSpace
)

 Get world-space socket transform.
Public function Virtual Const bool Returns true if this component has any sockets
Public function Virtual Const bool True if our precomputed lighting is up to date
Public function Virtual void Updates any visuals after the lighting has changed
Public function Virtual Const void Get a list of sockets this component contains
Public function Virtual Const bool If true, bounds should be used when placing component/actor in level. Does not affect spawning.
Public function Virtual void Update the Bounds of the component.

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const UObject const * Give a readable name for this component, including asset name if applicable
Protected function Virtual void Used to detach physics objects before simulation begins.
Public function Virtual void Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
Protected function Virtual void Used to create any rendering thread information for this component
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 void Initializes the component.
Public function Virtual void

InvalidateLightingCacheDetailed ( bool bInvalidateBuildEnqueuedLighting,
bool bTranslationOnly
)

 Called when this actor component has moved, allowing it to discard statically cached lighting information.
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
Protected function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Protected function Virtual void Called when a component is unregistered.
Public function Virtual void Called after ApplyToComponent has run.
Protected function Virtual Const bool Return true if this component requires end of frame recreates to happen from the game thread.
Protected function Virtual Const bool Return true if CreatePhysicsState() should be called.
Protected function Virtual Const bool Return true if CreateRenderState() should be called

Overridden from UObject

  Type Name Description
Public function Virtual Const bool Returns whether native properties are identical to the one of the passed in component.
Public function Virtual void Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void

ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

 Exports the property values for the specified object as text to the output device.
Public function Virtual Const FString This function actually does the work for the GetDetailedInfo() and is virtual.
Public function Virtual void

ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

 Exports the property values for the specified object as text to the output device.
Public function Virtual bool Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
Public function Virtual Const bool Called during async load to determine if PostLoad can be called on the loading thread.
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void 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
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Called after properties are overwritten, including after subobjects initialization from a CDO.
Public function Virtual void Called before applying a transaction to the object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from INavRelevantInterface

  Type Name Description
Public function Virtual Const void Prepare navigation modifiers
Public function Virtual Const bool Are modifiers active?

Overridden from IInterface_AsyncCompilation

  Type Name Description
Public function Virtual Const bool Returns whether this component is still being compiled or dependent on other objects being compiled.

Classes

  Type Name Description
Public class FOnStaticMeshChanged Called when the static mesh changes  

Typedefs

Name Description
FOnGetNaniteResources Called during scene proxy creation to get the Nanite resource data
GetPSOVertexElementsFn Shared implementation for all StaticMesh derived components

Deprecated Variables

  Type Name Description
Public variable TArray< FGuid > IrrelevantLights_DEPRECATED  
Public variable int32 PreviousLODLevel_DEPRECATED LOD that was desired for rendering this StaticMeshComponent last frame.

Deprecated Functions

  Type Name Description
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( const ITargetPlatform* TargetPlatform
)

 Use version that takes FObjectPreSaveContext instead.
Public function void

UpdatePreCulledData ( int32 LODIndex,
const TArray< uint32 >& PreCulledData,
const TArray< int32 >& NumTrianglesPerSection
)

 This function is no longer used

See Also

https://docs.unrealengine.com/latest/INT/Engine/Content/Types/StaticMeshes/

UStaticMesh

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page