1. Epic GamesDeveloper
  3. UDynamicMesh

UDynamicMesh

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

API > API/Runtime > API/Runtime/GeometryFramework

Inheritance Hierarchy

References

   
Module GeometryFramework
Header /Engine/Source/Runtime/GeometryFramework/Public/UDynamicMesh.h
Include #include "UDynamicMesh.h"

Syntax

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

Remarks

UDynamicMesh is a UObject container for a FDynamicMesh3.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bEnableMeshGenerator Controls whether the active Generator (if configured) will be applied when rebuilding the mesh
Protected variable TUniquePtr< UE::Geometry::FDynamicMesh3 > Mesh Mesh data, owned by this object. By default will have Attributes enabled and MaterialID enabled.
Protected variable FOnDynamicMeshChanged MeshChangedEvent Broadcast after the internal mesh is modified, in the same cases as PreMeshChangedEvent
Protected variable UProperty instanced TObjectPtr< UDynamicMeshGenerator > MeshGenerator (Preliminary) Procedural Generator support.
Public variable UProperty Meta BlueprintAssignable FOnDynamicMeshModifiedBP MeshModifiedBPEvent Blueprintable event called when mesh is modified, in the same cases as OnMeshChanged
Protected variable FOnMeshRealtimeUpdate MeshRealtimeUpdateEvent  
Protected variable FOnDynamicMeshChanged PreMeshChangedEvent Event support Broadcast before the internal mesh is modified by Reset funcs, SetMesh(), EditMesh(), and ApplyChange()'s above

Constructors

  Type Name Description
Public function  

UDynamicMesh ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void Set the active mesh generator. Clears if nullptr
Public function void

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

 Apply EditFunc to the internal mesh.
Protected function 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
Public function Virtual void

ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

 Serialize Mesh to/from T3D
Public function TUniquePtr< UE::Geometry::FDynamicMesh3 > Take ownership of the internal Mesh, and have it replaced with a new mesh
Public function Const const UE::Geometry::FDynamicMesh3 * Calling ProcessMesh() is preferred! This interface may be removed in the future
Public function UE::Geometry::FDynamicMesh3 * Calling EditMesh() is preferred! This interface may be removed in the future
Public function UE::Geometry::FDynamicMesh3 & Calling EditMesh() is preferred! This interface may be removed in the future
Public function Const const UE::Geometry::FDynamicMesh3 & Calling ProcessMesh() is preferred! This interface may be removed in the future
Public function Virtual void

ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

  
Public function Virtual void Native access/modification functions Reset the internal mesh data and then optionally run the MeshGenerator
Protected function void Allocate a new Mesh (ie pointer will change) and then call InitializeMesh()
Public function Const UFunction BlueprintCallable, Category bool

IsEmpty ()

  
Public function FOnDynamicMeshChanged & Broadcast after the internal mesh is modified, in the same cases as OnPreMeshChanged
Public function FOnMeshRealtimeUpdate & Multicast delegate that is broadcast whenever PostRealtimeUpdate() is called
Public function FOnDynamicMeshChanged & Broadcast before the internal mesh is modified by Reset funcs, SetMesh(), EditMesh(), and ApplyChange()'s above
Public function Virtual void Broadcasts FOnMeshRealtimeUpdate
Public function Const void

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

 Apply ProcessFunc to the internal Mesh
Public function Virtual void Reset() the mesh, which will re-run the active MeshGenerator, if bEnableMeshGenerator
Public function Virtual void

Serialize ( FArchive& Archive
)

 Serialize Mesh to an Archive
Public function void

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

 Replace the internal mesh with a copy of MoveMesh
Public function void

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

 Replace the internal mesh with the data in MoveMesh
Public function Virtual void

SetMeshGenerator ( TObjectPtr< UDynamicMeshGenerator > NewGenerator
)

 Set the active mesh generator. Clears if nullptr
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Clear the internal mesh to a 100x100x100 cube with base at the origin.
Public function UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Clear the internal mesh to an empty mesh.
Public function Const UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

  

Overridden from IMeshVertexCommandChangeTarget

  Type Name Description
Public function Virtual void

ApplyChange ( const FMeshVertexChange* Change,
bool bRevert
)

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

Overridden from IMeshCommandChangeTarget

  Type Name Description
Public function Virtual void

ApplyChange ( const FMeshChange* Change,
bool bRevert
)

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

Overridden from IMeshReplacementCommandChangeTarget

  Type Name Description
Public function Virtual void

ApplyChange ( const FMeshReplacementChange* Change,
bool bRevert
)

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

Typedefs

Name Description
FOnMeshRealtimeUpdate Realtime Update support.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page