Navigation
API > API/Runtime > API/Runtime/GeometryFramework
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDynamicMesh
References
| Module | GeometryFramework |
| Header | /Engine/Source/Runtime/GeometryFramework/Public/UDynamicMesh.h |
| Include | #include "UDynamicMesh.h" |
Syntax
class UDynamicMesh :
public UObject,
public IMeshVertexCommandChangeTarget,
public IMeshCommandChangeTarget,
public IMeshReplacementCommandChangeTarget
Remarks
UDynamicMesh is a UObject container for a FDynamicMesh3.
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bEnableMeshGenerator | Controls whether the active Generator (if configured) will be applied when rebuilding the mesh | |
| TUniquePtr< UE::Geometry::FDynamicMesh3 > | Mesh | Mesh data, owned by this object. | |
| FOnDynamicMeshChanged | MeshChangedEvent | Broadcast after the internal mesh is modified, in the same cases as PreMeshChangedEvent | |
| TObjectPtr< UDynamicMeshGenerator > | MeshGenerator | (Preliminary) Procedural Generator support. | |
| FOnDynamicMeshModifiedBP | MeshModifiedBPEvent | Blueprintable event called when mesh is modified, in the same cases as OnMeshChanged | |
| FOnMeshRealtimeUpdate | MeshRealtimeUpdateEvent | ||
| FOnDynamicMeshChanged | PreMeshChangedEvent | Event supportBroadcast before the internal mesh is modified by Reset funcs, SetMesh(), EditMesh(), and ApplyChange()'s above |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UDynamicMesh
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Set the active mesh generator. Clears if nullptr | ||
| void | EditMesh
(
TFunctionRef< void(UE::Geometry::FDynamicMesh3&)> EditFunc, |
Apply EditFunc to the internal mesh. | |
| void | EditMeshInternal
(
TFunctionRef< void(UE::Geometry::FDynamicMesh3&)> EditFunc, |
Internal function that edits the Mesh, but broadcasts PreMeshChangedEvent and MeshChangedEvent, and then MeshModifiedBPEvent | |
| TUniquePtr< UE::Geometry::FDynamicMesh3 > | ExtractMesh () |
Take ownership of the internal Mesh, and have it replaced with a new mesh | |
| const UE::Geometry::FDynamicMesh3 * | GetMeshPtr () |
Calling ProcessMesh() is preferred! This interface may be removed in the future | |
| UE::Geometry::FDynamicMesh3 * | GetMeshPtr () |
Calling EditMesh() is preferred! This interface may be removed in the future | |
| UE::Geometry::FDynamicMesh3 & | GetMeshRef () |
Calling EditMesh() is preferred! This interface may be removed in the future | |
| const UE::Geometry::FDynamicMesh3 & | GetMeshRef () |
Calling ProcessMesh() is preferred! This interface may be removed in the future | |
| int32 | |||
| void | Native access/modification functions Reset the internal mesh data and then optionally run the MeshGenerator | ||
| void | Allocate a new Mesh (ie pointer will change) and then call InitializeMesh() | ||
| bool | IsEmpty () |
||
| FOnDynamicMeshChanged & | Broadcast after the internal mesh is modified, in the same cases as OnPreMeshChanged | ||
| FOnMeshRealtimeUpdate & | Multicast delegate that is broadcast whenever PostRealtimeUpdate() is called | ||
| FOnDynamicMeshChanged & | Broadcast before the internal mesh is modified by Reset funcs, SetMesh(), EditMesh(), and ApplyChange()'s above | ||
| void | Broadcasts FOnMeshRealtimeUpdate | ||
| void | ProcessMesh
(
TFunctionRef< void(const UE::Geometry::FDynamicMesh3&)> ProcessFunc |
Apply ProcessFunc to the internal Mesh | |
| void | Regenerate () |
Reset() the mesh, which will re-run the active MeshGenerator, if bEnableMeshGenerator | |
| UDynamicMesh * | Reset () |
Clear the internal mesh to an empty mesh. | |
| UDynamicMesh * | ResetToCube () |
Clear the internal mesh to a 100x100x100 cube with base at the origin. | |
| void | SetMesh
(
const UE::Geometry::FDynamicMesh3& MoveMesh |
Replace the internal mesh with a copy of MoveMesh | |
| void | SetMesh
(
UE::Geometry::FDynamicMesh3&& MoveMesh |
Replace the internal mesh with the data in MoveMesh | |
| void | SetMeshGenerator
(
TObjectPtr< UDynamicMeshGenerator > NewGenerator |
Set the active mesh generator. Clears if nullptr |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | ExportCustomProperties
(
FOutputDevice& Out, |
Serialize Mesh to/from T3D | |
| void | ImportCustomProperties
(
const TCHAR* SourceText, |
Exports the property values for the specified object as text to the output device. | |
| void | Serialize Mesh to an Archive |
Overridden from IMeshVertexCommandChangeTarget
| Type | Name | Description | |
|---|---|---|---|
| void | ApplyChange
(
const FMeshVertexChange* Change, |
IMeshVertexCommandChangeTarget implementation, allows a FVertexChange to be applied to the mesh. |
Overridden from IMeshCommandChangeTarget
| Type | Name | Description | |
|---|---|---|---|
| void | ApplyChange
(
const FMeshChange* Change, |
IMeshCommandChangeTarget implementation, allows a FMeshChange to be applied to the mesh. |
Overridden from IMeshReplacementCommandChangeTarget
| Type | Name | Description | |
|---|---|---|---|
| void | ApplyChange
(
const FMeshReplacementChange* Change, |
IMeshReplacementCommandChangeTarget implementation, allows a FMeshReplacementChange to be applied to the mesh. |
Typedefs
| Name | Description |
|---|---|
| FOnMeshRealtimeUpdate | Realtime Update support. |