1. Epic GamesDeveloper
  3. UProceduralMeshComponent

UProceduralMeshComponent

Component that allows you to specify custom triangle mesh geometry Beware! This feature is experimental and may be substantially changed in future releases.

API > API/Plugins > API/Plugins/ProceduralMeshComponent

Inheritance Hierarchy

References

   
Module ProceduralMeshComponent
Header /Engine/Plugins/Runtime/ProceduralMeshComponent/Source/ProceduralMeshComponent/Public/ProceduralMeshComponent.h
Include #include "ProceduralMeshComponent.h"

Syntax

UCLASS&40;HideCategories&61;&40;Object, LOD&41;, Meta&61;&40;BlueprintSpawnableComponent&41;, ClassGroup&61;Rendering&41;  
class UProceduralMeshComponent :  
    public UMeshComponent,  
    public IInterface_CollisionDataProvider

Remarks

Component that allows you to specify custom triangle mesh geometry Beware! This feature is experimental and may be substantially changed in future releases.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bUseAsyncCooking Controls whether the physics cooking should be done off the game thread.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bUseComplexAsSimpleCollision Controls whether the complex (Per poly) geometry should be treated as 'simple' collision.
Public variable UProperty instanced TObjectPtr< class UBodySetup > ProcMeshBodySetup Collision data

Constructors

  Type Name Description
Public function  

UProceduralMeshComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddCollisionConvexMesh ( TArray< FVector > ConvexVerts
)

 Add simple collision convex to this component
Public function UFunction BlueprintCallable, Category void Clear all mesh sections and reset to empty state
Public function UFunction BlueprintCallable, Category void Remove collision meshes from this component
Public function UFunction BlueprintCallable, Category void

ClearMeshSection ( int32 SectionIndex
)

 Clear a section of the procedural mesh. Other sections do not change index.
Public function void

CreateMeshSection ( int32 SectionIndex,
const TArray< FVector >& Vertices,
const TArray< int32 >& Triangles,
const TArray< FVector >& Normals,
const TArray< FVector2D >& UV0,
const TArray< FVector2D >& UV1,
const TArray< FVector2D >& UV2,
const TArray< FVector2D >& UV3,
const TArray< FColor >& VertexColors,
const TArray< FProcMeshTangent >& Tangents,
bool bCreateCollision
)

  
Public function UFunction BlueprintCallable, Category, Meta void

CreateMeshSection ( int32 SectionIndex,
const TArray< FVector >& Vertices,
const TArray< int32 >& Triangles,
const TArray< FVector >& Normals,
const TArray< FVector2D >& UV0,
const TArray< FColor >& VertexColors,
const TArray< FProcMeshTangent >& Tangents,
bool bCreateCollision
)

 Create/replace a section for this procedural mesh component.
Public function UFunction BlueprintCallable, Category, Meta void

CreateMeshSection_LinearColor ( int32 SectionIndex,
const TArray< FVector >& Vertices,
const TArray< int32 >& Triangles,
const TArray< FVector >& Normals,
const TArray< FVector2D >& UV0,
const TArray< FVector2D >& UV1,
const TArray< FVector2D >& UV2,
const TArray< FVector2D >& UV3,
const TArray< FLinearColor >& VertexColors,
const TArray< FProcMeshTangent >& Tangents,
bool bCreateCollision,
bool bSRGBConversion
)

 Create/replace a section for this procedural mesh component.
Public function void

CreateMeshSection_LinearColor ( int32 SectionIndex,
const TArray< FVector >& Vertices,
const TArray< int32 >& Triangles,
const TArray< FVector >& Normals,
const TArray< FVector2D >& UV0,
const TArray< FLinearColor >& VertexColors,
const TArray< FProcMeshTangent >& Tangents,
bool bCreateCollision,
bool bSRGBConversion
)

  
Public function Const UFunction BlueprintCallable, Category int32 Returns number of sections currently created for this component
Public function FProcMeshSection *

GetProcMeshSection ( int32 SectionIndex
)

 Get pointer to internal data for one section of this procedural mesh component.
Public function Const UFunction BlueprintCallable, Category bool

IsMeshSectionVisible ( int32 SectionIndex
)

 Returns whether a particular section is currently visible
Public function void

SetCollisionConvexMeshes ( const TArray< TArray< FVector > >& ConvexMeshes
)

 Function to replace all simple collision in one go
Public function UFunction BlueprintCallable, Category void

SetMeshSectionVisible ( int32 SectionIndex,
bool bNewVisibility
)

 Control visibility of a particular section
Public function void

SetProcMeshSection ( int32 SectionIndex,
const FProcMeshSection& Section
)

 Replace a section with new section geometry
Public function UFunction BlueprintCallable, Category, Meta void

UpdateMeshSection ( int32 SectionIndex,
const TArray< FVector >& Vertices,
const TArray< FVector >& Normals,
const TArray< FVector2D >& UV0,
const TArray< FColor >& VertexColors,
const TArray< FProcMeshTangent >& Tangents
)

 Updates a section of this procedural mesh component.
Public function void

UpdateMeshSection ( int32 SectionIndex,
const TArray< FVector >& Vertices,
const TArray< FVector >& Normals,
const TArray< FVector2D >& UV0,
const TArray< FVector2D >& UV1,
const TArray< FVector2D >& UV2,
const TArray< FVector2D >& UV3,
const TArray< FColor >& VertexColors,
const TArray< FProcMeshTangent >& Tangents
)

  
Public function void

UpdateMeshSection_LinearColor ( int32 SectionIndex,
const TArray< FVector >& Vertices,
const TArray< FVector >& Normals,
const TArray< FVector2D >& UV0,
const TArray< FLinearColor >& VertexColors,
const TArray< FProcMeshTangent >& Tangents,
bool bSRGBConversion
)

  
Public function UFunction BlueprintCallable, Category, Meta void

UpdateMeshSection_LinearColor ( int32 SectionIndex,
const TArray< FVector >& Vertices,
const TArray< FVector >& Normals,
const TArray< FVector2D >& UV0,
const TArray< FVector2D >& UV1,
const TArray< FVector2D >& UV2,
const TArray< FVector2D >& UV3,
const TArray< FLinearColor >& VertexColors,
const TArray< FProcMeshTangent >& Tangents,
bool bSRGBConversion
)

 Updates a section of this procedural mesh component.

Overridden from UPrimitiveComponent

  Type Name Description
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 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

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.

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page