1. Epic GamesDeveloper
  3. UMeshComponent

UMeshComponent

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

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
Protected variable 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
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly uint8: 1 bEnableMaterialParameterCaching  
Protected variable TSortedMap< FName, FMaterialParameterCache, FDefaultAllocator, FNameFastLess > MaterialParameterCache  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly TObjectPtr< class UMaterialInterface > OverlayMaterial Translucent material to blend on top of this mesh.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly float OverlayMaterialMaxDrawDistance The max draw distance for overlay material.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta TArray< TObjectPtr< class UMaterialInterface > > OverrideMaterials Per-Component material overrides.

Constructors

  Type Name Description
Public function  

UMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void Retrieves all the (scalar/vector-)parameters from within the used materials on the SkeletalMesh, and stores material index vs parameter names
Public function void Make sure the Override array is using only the space it should use.
Public function void This empties all override materials and used by editor when replacing preview mesh
Protected function Virtual Const UMaterialInterface * Get the default overlay material used by a mesh
Protected function Virtual Const float Get the default overlay material max draw distance
Public function Virtual Const FMaterialRelevance Accesses the scene relevance information for the materials applied to the mesh.
Public function Virtual Const UFunction BlueprintCallable, Category TArray< class UMaterialInterface * >  
Public function Virtual Const bool

GetMaterialStreamingData ( int32 MaterialIndex,
FPrimitiveMaterialInfo& MaterialData
)

 Get the material info for texture streaming. Return whether the data is valid or not.
Public function Virtual Const int32 Returns override materials count
Public function Const UFunction BlueprintCallable, Category UMaterialInterface * Get the overlay material used by this instance
Public function Const UFunction BlueprintCallable, Category float Get the overlay material used by this instance
Public function float

GetScalarParameterDefaultValue ( const FName ParameterName
)

 Returns default value for the parameter input.
Public function Const void

GetStreamingTextureInfoInner ( FStreamingTextureLevelContext& LevelContext,
const TArray< FStreamingTextureBuildInfo >* PreBuiltData,
float ComponentScaling,
TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingTextures
)

 Generate streaming data for all materials.
Public function bool Returns true if there are any override materials set for this component
Public function Virtual Const void Output to the log which materials and textures are used by this component.
Protected function void Mark cache parameters map as dirty, cache will be rebuild once SetScalar/SetVector functions are called
Public function Virtual UFunction BlueprintCallable, Category bool

PrestreamMeshLODs ( float Seconds
)

 Tell the streaming system to start streaming in all LODs for the mesh.
Public function Virtual UFunction BlueprintCallable, Category void

PrestreamTextures ( float Seconds,
bool bPrioritizeCharacterTextures,
int32 CinematicTextureGroups
)

 Tell the streaming system to start loading all textures with all mip-levels.
Public function Virtual void

RegisterLODStreamingCallback ( FLODStreamingCallback&& Callback,
int32 LODIdx,
float TimeoutSecs,
bool bOnStreamIn
)

 Register a one-time callback that will be called when criteria met
Public function Virtual void

RegisterLODStreamingCallback ( FLODStreamingCallback&& CallbackStreamingStart,
FLODStreamingCallback&& CallbackStreamingDone,
float TimeoutStartSecs,
float TimeoutDoneSecs
)

 Register a one-time callback that will be called when streaming starts or ends.
Public function UFunction BlueprintCallable, Category void

SetOverlayMaterial ( UMaterialInterface* NewOverlayMaterial
)

 Change the overlay material used by this instance
Public function UFunction BlueprintCallable, Category void

SetOverlayMaterialMaxDrawDistance ( float InMaxDrawDistance
)

 Change the overlay material max draw distance used by this instance
Public function UFunction BlueprintCallable, Category 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
Public function Virtual 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.
Public function UFunction BlueprintCallable, Category 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
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 UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

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

GetMaterialByName ( FName MaterialSlotName
)

 Returns the material used by the element in the slot with the specified name.
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const void

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

 Retrieves the materials used in this component
Public function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.
Public function Virtual void

SetMaterialByName ( FName MaterialSlotName,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.

Overridden from UObject

  Type Name Description
Protected function Virtual void Called before destroying the object.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.

Classes

  Type Name Description
Protected struct FMaterialParameterCache Struct containing information about a given parameter name  

See Also

UStaticMeshComponent

USkeletalMeshComponent

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page