UMeshComponent

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

Inheritance Hierarchy

References


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

Syntax

UCLASS (Abstract, ShowCategories=(VirtualTexture), MinimalAPI)  
class UMeshComponent : public UPrimitiveComponent

Remarks

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

Variables

Type	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< FName, FMaterialParameterCache, FDefaultAllocator, FNameFastLess >	MaterialParameterCache
TObjectPtr< class UMaterialInterface >	OverlayMaterial	Translucent material to blend on top of this mesh.
float	OverlayMaterialMaxDrawDistance	The max draw distance for overlay material.
TArray< TObjectPtr< class UMaterialInterface > >	OverrideMaterials	Per-Component material overrides.

Constructors

	Type	Name	Description
		UMeshComponent ( const FObjectInitializer& ObjectInitializer )

Functions

Type	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
UMaterialInterface *	GetDefaultOverlayMaterial ()	Get the default overlay material used by a mesh
float	GetDefaultOverlayMaterialMaxDrawDistance ()	Get the default overlay material max draw distance
FMaterialRelevance	GetMaterialRelevance ( ERHIFeatureLevel::Type InFeatureLevel )	Accesses the scene relevance information for the materials applied to the mesh.
TArray< class UMaterialInterface * >	GetMaterials ()
bool	GetMaterialStreamingData ( int32 MaterialIndex, FPrimitiveMaterialInfo& MaterialData )	Get the material info for texture streaming. Return whether the data is valid or not.
UTexture *	GetMeshPaintTexture ()	Get the mesh paint texture set on this component.
int32	GetMeshPaintTextureCoordinateIndex ()	Get the default coordinate index for painting to the mesh paint texture on this component.
int32	GetNumOverrideMaterials ()	Returns override materials count
UMaterialInterface *	GetOverlayMaterial ()	Get the overlay material used by this instance
float	GetOverlayMaterialMaxDrawDistance ()	Get the overlay material used by this instance
float	GetScalarParameterDefaultValue ( const FName ParameterName )	Returns default value for the parameter input.
void	GetStreamingTextureInfoInner ( FStreamingTextureLevelContext& LevelContext, const TArray< FStreamingTextureBuildInfo >* PreBuiltData, float ComponentScaling, TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingTextures )	Generate streaming data for all materials.
FColor	GetWireframeColorForSceneProxy ()	Returns the wireframe color to use for this component.
bool	HasOverrideMaterials ()	Returns true if there are any override materials set for this component
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
bool	PrestreamMeshLODs ( float Seconds )	Tell the streaming system to start streaming in all LODs for the mesh.
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	RegisterLODStreamingCallback ( FLODStreamingCallback&& CallbackStreamingStart, FLODStreamingCallback&& CallbackStreamingDone, float TimeoutStartSecs, float TimeoutDoneSecs )	Register a one-time callback that will be called when streaming starts or ends.
void	SetColorParameterValueOnMaterials ( const FName ParameterName, const FLinearColor ParameterValue )	Set all occurrences of Vector Material Parameters with ParameterName in the set of materials of the SkeletalMesh to ParameterValue
void	SetMeshPaintTexture ( UTexture* Texture )	Set the mesh paint texture on this component.
void	SetMeshPaintTextureOverride ( UTexture* OverrideTexture )	Set a transient override mesh paint texture on this component.
void	SetOverlayMaterial ( UMaterialInterface* NewOverlayMaterial )	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

Type	Name	Description
UMaterialInterface *	GetMaterial ( int32 ElementIndex )	Returns the material used by the element at the specified index
UMaterialInterface *	GetMaterialByName ( FName MaterialSlotName )	Returns the material used by the element in the slot with the specified name.
int32	GetNumMaterials ()	Return number of material elements in this primitive
void	GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials, 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

	Type	Name	Description
	void	BeginDestroy ()	Called before destroying the object.
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent )	This alternate version of PostEditChange is called when properties inside structs are modified.