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

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

   
Name UProceduralMeshComponent
Type class
Header File /Engine/Plugins/Runtime/ProceduralMeshComponent/Source/ProceduralMeshComponent/Public/ProceduralMeshComponent.h
Include Path #include "ProceduralMeshComponent.h"

Syntax

UCLASS (MinimalAPI, HideCategories=(Object, LOD), Meta=(BlueprintSpawnableComponent),  
       ClassGroup=Rendering)  
class UProceduralMeshComponent :  
    public UMeshComponent ,  
    public IInterface_CollisionDataProvider

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UProceduralMeshComponent ( const FObjectInitializer& ObjectInitializer
)

   ProceduralMeshComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bUseAsyncCooking bool Controls whether the physics cooking should be done off the game thread. ProceduralMeshComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Procedural Mesh"
bUseComplexAsSimpleCollision bool Controls whether the complex (Per poly) geometry should be treated as 'simple' collision. ProceduralMeshComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Procedural Mesh"
ProcMeshBodySetup TObjectPtr< class UBodySetup > Collision data ProceduralMeshComponent.h
  • Instanced

Protected

Name Type Remarks Include Path Unreal Specifiers
AsyncBodySetupQueue TArray< TObjectPtr< UBodySetup > > Queue for async body setups that are being cooked ProceduralMeshComponent.h
  • Transient
CollisionConvexElems TArray< FKConvexElem > Convex shapes used for simple collision ProceduralMeshComponent.h  
LocalBounds FBoxSphereBounds Local space bounds of mesh ProceduralMeshComponent.h  
ProcMeshSections TArray< FProcMeshSection > Array of sections of mesh ProceduralMeshComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCollisionConvexMesh ( TArray< FVector > ConvexVerts
)

 Add simple collision convex to this component ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"

void ClearAllMeshSections()

 Clear all mesh sections and reset to empty state ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"

void ClearCollisionConvexMeshes()

 Remove collision meshes from this component ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"

void ClearMeshSection ( int32 SectionIndex
)

 Clear a section of the procedural mesh. Other sections do not change index. ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"

virtual bool ContainsPhysicsTriMeshData ( bool InUseAllTriData
) const

   ProceduralMeshComponent.h  

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
)

   ProceduralMeshComponent.h  

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. ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is deprecated for Blueprints because it uses the unsupported 'Color' type. Use new 'Create Mesh Section' function which uses LinearColor instead.", DisplayName="Create Mesh Section FColor", AutoCreateRefTerm="Normals,UV0,VertexColors,Tangents")

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,
UPARAM(DisplayName="SRGB Conversion") bool bSRGBConversion
)

 Create/replace a section for this procedural mesh component. ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"
  • Meta=(DisplayName="Create Mesh Section", AutoCreateRefTerm="Normals,UV0,UV1,UV2,UV3,VertexColors,Tangents", AdvancedDisplay="UV1,UV2,UV3")

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
)

   ProceduralMeshComponent.h  

int32 GetNumSections()

 Returns number of sections currently created for this component ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"

virtual bool GetPhysicsTriMeshData ( FTriMeshCollisionData* CollisionData,
bool InUseAllTriData
)

   ProceduralMeshComponent.h  

FProcMeshSection * GetProcMeshSection ( int32 SectionIndex
)

 Get pointer to internal data for one section of this procedural mesh component. ProceduralMeshComponent.h  

virtual bool GetTriMeshSizeEstimates ( FTriMeshCollisionDataEstimates& OutTriMeshEstimates,
bool bInUseAllTriData
) const

   ProceduralMeshComponent.h  

bool IsMeshSectionVisible ( int32 SectionIndex
) const

 Returns whether a particular section is currently visible ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"

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

 Function to replace all simple collision in one go ProceduralMeshComponent.h  

void SetMeshSectionVisible ( int32 SectionIndex,
bool bNewVisibility
)

 Control visibility of a particular section ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"

void SetProcMeshSection ( int32 SectionIndex,
const FProcMeshSection& Section
)

 Replace a section with new section geometry ProceduralMeshComponent.h  

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. ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is deprecated for Blueprints because it uses the unsupported 'Color' type. Use new 'Update Mesh Section' function which uses LinearColor instead.", DisplayName="Update Mesh Section FColor", AutoCreateRefTerm="Normals,UV0,VertexColors,Tangents")

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
)

   ProceduralMeshComponent.h  

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
)

   ProceduralMeshComponent.h  

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,
UPARAM(DisplayName="SRGB Conversion") bool bSRGBConversion
)

 Updates a section of this procedural mesh component. ProceduralMeshComponent.h
  • BlueprintCallable
  • Category="Components|ProceduralMesh"
  • Meta=(DisplayName="Update Mesh Section", AutoCreateRefTerm="Normals,UV0,UV1,UV2,UV3,VertexColors,Tangents", AdvancedDisplay="UV1,UV2,UV3")

virtual bool WantsNegXTriMesh()

   ProceduralMeshComponent.h  

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   ProceduralMeshComponent.h  

virtual UBodySetup * GetBodySetup()

   ProceduralMeshComponent.h  

virtual UMaterialInterface * GetMaterialFromCollisionFaceIndex ( int32 FaceIndex,
int32& SectionIndex
) const

   ProceduralMeshComponent.h  

virtual int32 GetNumMaterials()

   ProceduralMeshComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   ProceduralMeshComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   ProceduralMeshComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page