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

Light Theme

Dark Theme

UModelComponent

ModelComponents are PrimitiveComponents that represent elements of BSP geometry in a [ULevel](API\Runtime\Engine\Engine\ULevel) object.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UModelComponent

References

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

Syntax

class UModelComponent :
public UPrimitiveComponent,
public IInterface_CollisionDataProvider

Remarks

ModelComponents are PrimitiveComponents that represent elements of BSP geometry in a ULevel object. They are used exclusively by ULevel and are not intended as general-purpose components.

Variables

		Name	Description
	TObjectPtr< cla...	ModelBodySetup	Description of collision

Constructors

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

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	ApplyTempElements ( bool bLightingWasSuccessful )	Apply all the elements that we were putting into the TempBSPElements map to the Elements arrays in all components
void	BuildRenderData()	Rebuild the model's rendering info.
void	CommitSurfaces()	Commit the editor's changes to BSP surfaces.
void	CopyElementsFrom ( UModelComponent* OtherModelCom... )	Copy model elements from the other component.
void	CreateModelBodySetup()	Ensure ModelBodySetup is present and correctly configured.
FModelElemen...	CreateNewTempElement ( UModelComponent* Component )	Create a new temp FModelElement element for the component, which will be applied when lighting is all done.
bool	GenerateElements ( bool bBuildRenderData )	Generate the Elements array.
const TIndir...	GetElements()
TIndirectArr...	GetElements()
UModel *	GetModel()	Accessors.
void	GetStaticLightingInfo ( FStaticLightingPrimitiveInfo& OutP..., const TArray< ULightComponent*..., const FLightingBuildOptions& Optio... )
void	GetSurfaceLightMapResolution ( int32 SurfaceIndex, int32 QualityScale, int32& Width, int32& Height, FMatrix& WorldToMap, TArray< int32 >* GatheredNodes )	Calculate the lightmap resolution to be used by the given surface.
void	InitializeModelComponent ( UModel* InModel, uint16 InComponentIndex, uint32 MaskedSurfaceFlags, const TArray< uint16 >& InNodes )	Minimal initialization.
void	InvalidateCollisionData()	Invalidate current collision data
void	SelectAllSurfaces()	Selects all surfaces that are part of this model component.
void	ShrinkElements()	Free empty elements.

Overridden from UPrimitiveComponent

	Name	Description
void	AddMapBuildDataGUIDs ( TSet< FGuid >& InGUIDs )	Add the used GUIDs from UMapBuildDataRegistry::MeshBuildData.
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
UBodySetup &...	GetBodySetup()	Return the BodySetup to use for this PrimitiveComponent (single body case)
void	GetLightAndShadowMapMemoryUsage ( int32& LightMapMemoryUsage, int32& ShadowMapMemoryUsage )	Returns the light and shadow map memory for this primitive in its out variables.
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.
UMaterialInt...	GetMaterial ( int32 ElementIndex )	Returns the material used by the element at the specified index
UMaterialInt...	GetMaterialFromCollisionFaceIndex ( int32 FaceIndex, int32& SectionIndex )	Try and retrieve the material applied to a particular collision face of mesh.
int32	GetNumMaterials()	Return number of material elements in this primitive
ELightMapInt...	GetStaticLightingType()	Requests whether the component will use texture, vertex or no lightmaps.
int32	GetStaticLightMapResolution()	Returns the static lightmap resolution used for this primitive.
void	GetStreamingRenderAssetInfo ( FStreamingTextureLevelContext& Lev..., TArray< FStreamingRenderAssetPrimit... )	Enumerates the streaming textures/meshes used by the primitive.
void	GetUsedMaterials ( TArray< UMaterialInterface* > ..., bool bGetDebugMaterials )	Retrieves the materials used in this component
bool	ShouldRecreateProxyOnUpdateTransform()	Determines whether the proxy for this primitive type needs to be recreated whenever the primitive moves.
bool	SupportsStaticLighting()	Whether the component type supports static lighting.

Overridden from USceneComponent

	Name	Description
FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
bool	IsPrecomputedLightingValid()	True if our precomputed lighting is up to date
void	PropagateLightingScenarioChange()	Updates any visuals after the lighting has changed

Overridden from UActorComponent

	Name	Description
void	CreateRenderState_Concurrent ( FRegisterComponentContext* Con... )	Used to create any rendering thread information for this component
void	DestroyRenderState_Concurrent()	Used to shut down any rendering thread structure for this component
void	InvalidateLightingCacheDetailed ( bool bInvalidateBuildEnqueuedLighti..., bool bTranslationOnly )	Called when this actor component has moved, allowing it to discard statically cached lighting information.

Overridden from UObject

	Name	Description
bool	IsNameStableForNetworking()	IsNameStableForNetworking means an object can be referred to its path name (relative to outer) over the network
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_CollisionDataProvider

	Name	Description
bool	ContainsPhysicsTriMeshData ( bool InUseAllTriData )	Interface for checking if the implementing objects contains triangle mesh collision data
bool	GetPhysicsTriMeshData ( FTriMeshCollisionData* Collisi..., bool InUseAllTriData )	Interface for retrieving triangle mesh collision data from the implementing object
bool	GetTriMeshSizeEstimates ( FTriMeshCollisionDataEstimates& Ou..., bool bInUseAllTriData )	Returns an estimate of how much data would be retrieved by GetPhysicsTriMeshData.
bool	WantsNegXTriMesh()	Do we want to create a negative version of this mesh

Constants

Name	Description
TempBSPElements	The new BSP elements that are made during lighting, and will be applied to the components when all lighting is done