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

Light Theme

Dark Theme

UMeshComponent

MeshComponent is an abstract base for any component that is an instance of a renderable collection of triangles.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

PAPER2UPaperFlipbookComponent

PAPER2UPaperGroupedSpriteComponent

PAPER2UPaperSpriteComponent

PAPER2UPaperTileMapComponent

UBaseDynamicMeshComponent

	UDynamicMeshComponent
	UOctreeDynamicMeshComponent

UBasicLineSetComponentBase

	UBasic2DLineSetComponent
	UBasic3DLineSetComponent

UBasicPointSetComponentBase

	UBasic2DPointSetComponent
	UBasic3DPointSetComponent

UBasicTriangleSetComponentBase

	UBasic2DTriangleSetComponent
	UBasic3DTriangleSetComponent

UCableComponent

UCustomMeshComponent

UGeometryCacheComponent

	UGeometryCacheAbcFileComponent
	UGeometryCacheUsdComponent

UGeometryCollectionComponent

UGroomComponent

ULidarPointCloudComponent

ULineSetComponent

UMeshWireframeComponent

UPointCloudComponent

UPointSetComponent

UProceduralMeshComponent

	UAppleARKitFaceMeshComponent
	UCalibrationPointComponent
	UDEPRECATED_GoogleARCoreFaceMeshComponent

USkinnedMeshComponent

UDestructibleComponent

UPoseableMeshComponent

UDEPRECATED_UOculusHandComponent

USkeletalMeshComponent

	UDebugSkelMeshComponent
	UInsightsSkeletalMeshComponent
	USkeletalMeshComponentBudgeted

UStaticMeshComponent

UControlPointMeshComponent

UDisplayClusterScreenComponent

UGizmoHandleMeshComponent

UInstancedStaticMeshComponent

UHierarchicalInstancedStaticMeshComponent

	UFoliageInstancedStaticMeshComponent
	UGrassInstancedStaticMeshComponent

ULandscapeMeshProxyComponent

ULandscapeNaniteComponent

UMaterialEditorMeshComponent

UNaniteDisplacedMeshComponent

USplineMeshComponent

UXRDeviceVisualizationComponent

UTriangleSetComponent

UWaterMeshComponent

UWidgetComponent

References

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

Syntax

class UMeshComponent : public UPrimitiveComponent

Remarks

MeshComponent is an abstract base for any component that is an instance of a renderable collection of triangles.

Variables

	Name	Description
uint8: 1	bCachedMaterialParameterIndicesAreDirty	Flag whether or not the cached material parameter indices map is dirty (defaults to true, and is set from SetMaterial/Set(Skeletal)Mesh
uint8: 1	bEnableMaterialParameterCaching
TSortedMap< FNa...	MaterialParameterCache
TObjectPtr< cla...	OverlayMaterial	Translucent material to blend on top of this mesh.
float	OverlayMaterialMaxDrawDistance	The max draw distance for overlay material.
TArray< TObject...	OverrideMaterials	Per-Component material overrides.

Constructors

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

Functions

	Name	Description
void	CacheMaterialParameterNameIndices()	Retrieves all the (scalar/vector-)parameters from within the used materials on the SkeletalMesh, and stores material index vs parameter names
void	CleanUpOverrideMaterials()	Make sure the Override array is using only the space it should use.
void	EmptyOverrideMaterials()	This empties all override materials and used by editor when replacing preview mesh
int32	GetMaterialIndex ( FName MaterialSlotName )
FMaterialRel...	GetMaterialRelevance ( ERHIFeatureLevel::Type InFeatureLev... )	Accesses the scene relevance information for the materials applied to the mesh.
TArray< clas...	GetMaterials()
TArray< FNam...	GetMaterialSlotNames()
bool	GetMaterialStreamingData ( int32 MaterialIndex, FPrimitiveMaterialInfo& MaterialDa... )	Get the material info for texture streaming. Return whether the data is valid or not.
int32	GetNumOverrideMaterials()	Returns override materials count
UMaterialInt...	GetOverlayMaterial()	Get the overlay material used by this instance
float	GetScalarParameterDefaultValue ( const FName ParameterName )	Returns default value for the parameter input.
void	GetStreamingTextureInfoInner ( FStreamingTextureLevelContext& Lev..., const TArray< FStreamingTextureBuil..., float ComponentScaling, TArray< FStreamingRenderAssetPrimit... )	Generate streaming data for all materials.
bool	HasOverrideMaterials()	Returns true if there are any override materials set for this component
bool	IsMaterialSlotNameValid ( FName MaterialSlotName )
void	LogMaterialsAndTextures ( FOutputDevice& Ar, int32 Indent )	Output to the log which materials and textures are used by this component.
void	MarkCachedMaterialParameterNameIndicesDirty()	Mark cache parameters map as dirty, cache will be rebuild once SetScalar/SetVector functions are called
void	PrestreamTextures ( float Seconds, bool bPrioritizeCharacterTextures, int32 CinematicTextureGroups )	Tell the streaming system to start loading all textures with all mip-levels.
void	RegisterLODStreamingCallback ( FLODStreamingCallback&& Callback, int32 LODIdx, float TimeoutSecs, bool bOnStreamIn )	Register a one-time callback that will be called when criteria met
void	SetOverlayMaterial ( UMaterialInterface* NewOverlay... )	Change the overlay material used by this instance
void	SetOverlayMaterialMaxDrawDistance ( float InMaxDrawDistance )	Change the overlay material max draw distance used by this instance
void	SetScalarParameterValueOnMaterials ( const FName ParameterName, const float ParameterValue )	Material parameter setting and caching Set all occurrences of Scalar Material Parameters with ParameterName in the set of materials of the SkeletalMesh to ParameterValue
void	SetTextureForceResidentFlag ( bool bForceMiplevelsToBeResident )	Tell the streaming system whether or not all mip levels of all textures used by this component should be loaded and remain loaded.
void	SetVectorParameterValueOnMaterials ( const FName ParameterName, const FVector ParameterValue )	Set all occurrences of Vector Material Parameters with ParameterName in the set of materials of the SkeletalMesh to ParameterValue
bool	UseNaniteOverrideMaterials()	Determines if we use the nanite overrides from any materials

Overridden from UPrimitiveComponent

	Name	Description
UMaterialInt...	GetMaterial ( int32 ElementIndex )	Returns the material used by the element at the specified index
int32	GetNumMaterials()	Return number of material elements in this primitive
void	GetUsedMaterials ( TArray< UMaterialInterface* > ..., bool bGetDebugMaterials )	Retrieves the materials used in this component
void	SetMaterial ( int32 ElementIndex, UMaterialInterface* Material )	Changes the material applied to an element of the mesh.
void	SetMaterialByName ( FName MaterialSlotName, UMaterialInterface* Material )	Changes the material applied to an element of the mesh.

Overridden from UObject

		Name	Description
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.

Classes

	Name	Description
	FMaterialParameterCache	Struct containing information about a given parameter name