1. Epic GamesDeveloper
  3. UDynamicMesh

UDynamicMesh

[UDynamicMesh](API\Runtime\GeometryFramework\UDynamicMesh) is a [UObject](API\Runtime\CoreUObject\UObject) container for a FDynamicMesh3.

API > API/Runtime > API/Runtime/GeometryFramework

UDynamicMesh is a UObject container for a FDynamicMesh3.

   
Name UDynamicMesh
Type class
Header File /Engine/Source/Runtime/GeometryFramework/Public/UDynamicMesh.h
Include Path #include "UDynamicMesh.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UDynamicMesh :  
    public UObject ,  
    public IMeshVertexCommandChangeTarget ,  
    public IMeshCommandChangeTarget ,  
    public IMeshReplacementCommandChangeTarget

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UDynamicMesh ( const FObjectInitializer& ObjectInitializer
)

   UDynamicMesh.h  

Typedefs

Name Type Remarks Include Path
FOnMeshRealtimeUpdate TMulticastDelegate_OneParam< void, UDynamicMesh * > Realtime Update support. UDynamicMesh.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnableMeshGenerator bool Controls whether the active Generator (if configured) will be applied when rebuilding the mesh UDynamicMesh.h
  • EditAnywhere
  • Category="Dynamic Mesh"
MeshModifiedBPEvent FOnDynamicMeshModifiedBP Blueprintable event called when mesh is modified, in the same cases as OnMeshChanged UDynamicMesh.h
  • BlueprintAssignable
  • Meta=(DisplayName="MeshModified")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ClearMeshGenerator()

 Set the active mesh generator. Clears if nullptr UDynamicMesh.h  

void EditMesh ( TFunctionRef< void(UE::Geometry::FDynamicMesh3&)> EditFunc,
EDynamicMeshChangeType ChangeType,
EDynamicMeshAttributeChangeFlags ChangeFlags,
bool bDeferChangeEvents
)

 Apply EditFunc to the internal mesh. UDynamicMesh.h  
Take ownership of the internal Mesh, and have it replaced with a new mesh UDynamicMesh.h  
Calling ProcessMesh() is preferred! This interface may be removed in the future UDynamicMesh.h  
Calling EditMesh() is preferred! This interface may be removed in the future UDynamicMesh.h  
Calling EditMesh() is preferred! This interface may be removed in the future UDynamicMesh.h  
Calling ProcessMesh() is preferred! This interface may be removed in the future UDynamicMesh.h  

int32 GetTriangleCount()

   UDynamicMesh.h
  • BlueprintCallable
  • Category="Dynamic Mesh"

virtual void InitializeMesh()

 Native access/modification functions Reset the internal mesh data and then optionally run the MeshGenerator UDynamicMesh.h  

bool IsEmpty()

   UDynamicMesh.h
  • BlueprintCallable
  • Category="Dynamic Mesh"

FOnDynamicMeshChanged & OnMeshChanged()

 Broadcast after the internal mesh is modified, in the same cases as OnPreMeshChanged UDynamicMesh.h  

FOnMeshRealtimeUpdate & OnMeshRealtimeUpdate()

 Multicast delegate that is broadcast whenever PostRealtimeUpdate() is called UDynamicMesh.h  

FOnDynamicMeshChanged & OnPreMeshChanged()

 Broadcast before the internal mesh is modified by Reset funcs, SetMesh(), EditMesh(), and ApplyChange()'s above UDynamicMesh.h  

virtual void PostRealtimeUpdate()

 Broadcasts FOnMeshRealtimeUpdate UDynamicMesh.h  

void ProcessMesh ( TFunctionRef< void(const UE::Geometry::FDynamicMesh3&)> ProcessFunc
) const

 Apply ProcessFunc to the internal Mesh UDynamicMesh.h  

virtual void Regenerate()

 Reset() the mesh, which will re-run the active MeshGenerator, if bEnableMeshGenerator UDynamicMesh.h  
Clear the internal mesh to an empty mesh. UDynamicMesh.h
  • BlueprintCallable
  • Category="Dynamic Mesh"
  • Meta=(Keywords="Clear Empty Delete")
Clear the internal mesh to a 100x100x100 cube with base at the origin. UDynamicMesh.h
  • BlueprintCallable
  • Category="Dynamic Mesh"

void SetMesh ( const UE::Geometry::FDynamicMesh3& MoveMesh
)

 Replace the internal mesh with a copy of MoveMesh UDynamicMesh.h  

void SetMesh ( UE::Geometry::FDynamicMesh3&& MoveMesh
)

 Replace the internal mesh with the data in MoveMesh UDynamicMesh.h  

virtual void SetMeshGenerator ( TObjectPtr< UDynamicMeshGenerator > NewGenerator
)

 Set the active mesh generator. Clears if nullptr UDynamicMesh.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

 Serialize Mesh to/from T3D UDynamicMesh.h  

virtual void ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

   UDynamicMesh.h  

virtual void Serialize ( FArchive& Archive
)

 Serialize Mesh to an Archive UDynamicMesh.h  

Overridden from IMeshVertexCommandChangeTarget

Name Remarks Include Path Unreal Specifiers

virtual void ApplyChange ( const FMeshVertexChange* Change,
bool bRevert
)

 IMeshVertexCommandChangeTarget implementation, allows a FVertexChange to be applied to the mesh. UDynamicMesh.h  

Overridden from IMeshCommandChangeTarget

Name Remarks Include Path Unreal Specifiers

virtual void ApplyChange ( const FMeshChange* Change,
bool bRevert
)

 IMeshCommandChangeTarget implementation, allows a FMeshChange to be applied to the mesh. UDynamicMesh.h  

Overridden from IMeshReplacementCommandChangeTarget

Name Remarks Include Path Unreal Specifiers

virtual void ApplyChange ( const FMeshReplacementChange* Change,
bool bRevert
)

 IMeshReplacementCommandChangeTarget implementation, allows a FMeshReplacementChange to be applied to the mesh. UDynamicMesh.h  

Protected

Name Remarks Include Path Unreal Specifiers

void EditMeshInternal ( TFunctionRef< void(UE::Geometry::FDynamicMesh3&)> EditFunc,
const FDynamicMeshChangeInfo& ChangeInfo,
bool bDeferChangeEvents
)

 Internal function that edits the Mesh, but broadcasts PreMeshChangedEvent and MeshChangedEvent, and then MeshModifiedBPEvent UDynamicMesh.h  

void InitializeNewMesh()

 Allocate a new Mesh (ie pointer will change) and then call InitializeMesh() UDynamicMesh.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page