1. Epic GamesDeveloper
  3. UModelComponent

UModelComponent

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

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

Inheritance Hierarchy

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

  Type Name Description
Public variable TObjectPtr< class UBodySetup > ModelBodySetup Description of collision

Constructors

  Type Name Description
Public function  

UModelComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void  
Public function Static void

ApplyTempElements ( bool bLightingWasSuccessful
)

 Apply all the elements that we were putting into the TempBSPElements map to the Elements arrays in all components
Public function void Rebuild the model's rendering info.
Public function void Commit the editor's changes to BSP surfaces.
Public function void

CopyElementsFrom ( UModelComponent* OtherModelComponent
)

 Copy model elements from the other component.
Public function void Ensure ModelBodySetup is present and correctly configured.
Public function Static FModelElement * Create a new temp FModelElement element for the component, which will be applied when lighting is all done.
Public function Virtual bool

GenerateElements ( bool bBuildRenderData
)

 Generate the Elements array.
Public function Const const TIndirectArray< FModelElement > &  
Public function TIndirectArray< FModelElement > &  
Public function Const UModel * Accessors.
Public function Virtual void

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

  
Public function Const 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.
Public function void

InitializeModelComponent ( UModel* InModel,
uint16 InComponentIndex,
uint32 MaskedSurfaceFlags,
const TArray< uint16 >& InNodes
)

 Minimal initialization.
Public function void Invalidate current collision data
Public function void Selects all surfaces that are part of this model component.
Public function void Free empty elements.

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 FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual UBodySetup * Return the BodySetup to use for this PrimitiveComponent (single body case)
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 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 Enumerates the streaming textures/meshes used by the primitive.
Public function Virtual Const void

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

 Retrieves the materials used in this component
Public function Virtual Const bool Determines whether the proxy for this primitive type needs to be recreated whenever the primitive moves.
Protected function Virtual Const bool Whether the component type supports static lighting.

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 True if our precomputed lighting is up to date
Public function Virtual void Updates any visuals after the lighting has changed

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Used to create any rendering thread information for this component
Public function Virtual void Used to shut down any rendering thread structure for this 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.

Overridden from UObject

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

Overridden from IInterface_CollisionDataProvider

  Type Name Description
Public function Virtual Const bool

ContainsPhysicsTriMeshData ( bool InUseAllTriData
)

 Interface for checking if the implementing objects contains triangle mesh collision data
Public function Virtual bool

GetPhysicsTriMeshData ( FTriMeshCollisionData* CollisionData,
bool InUseAllTriData
)

 Interface for retrieving triangle mesh collision data from the implementing object
Public function Virtual Const bool

GetTriMeshSizeEstimates ( FTriMeshCollisionDataEstimates& OutTriMeshEstimates,
bool bInUseAllTriData
)

 Returns an estimate of how much data would be retrieved by GetPhysicsTriMeshData.
Public function Virtual bool 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

See Also

ULevel

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page