unreal.GeometryScript_EditorDynamicMeshUtil

class unreal.GeometryScript_EditorDynamicMeshUtil(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Geometry Script Library Editor Dynamic Mesh Functions

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingEditor

  • File: EditorDynamicMeshUtilityFunctions.h

classmethod begin_tracked_mesh_change(target_mesh) -> (DynamicMesh, change_tracker=DynamicMeshChangeContainer)

Save current state of TargetMesh so that an undoable/redoable Change can be emitted after TargetMesh is modified, using EmitTrackedMeshChange().

Parameters:

target_mesh (DynamicMesh) –

Returns:

change_tracker (DynamicMeshChangeContainer): output structure containing initial TargetMesh state

Return type:

DynamicMeshChangeContainer

classmethod emit_tracked_mesh_change(target_mesh, change_tracker) -> (DynamicMesh, change_tracker=DynamicMeshChangeContainer)

Emit an undo/redo Change for a modified TargetMesh, based on the ChangeTracker information that was saved (via call to BeginTrackedMeshChange) before TargetMesh was modified. This function must be called in the context of a Transaction (ie BeginTransaction / EndTransaction pair)

Parameters:
Returns:

change_tracker (DynamicMeshChangeContainer):

Return type:

DynamicMeshChangeContainer

classmethod fetch_debug_mesh(debug_mesh_name, to_target_mesh, clear_debug_mesh) -> (DynamicMesh, debug_mesh_exists=bool)

Fetch a debug FDynamicMesh3 saved with DebugMeshName from the global debug mesh storage and copy to ToTargetMesh. If DebugMeshName does not exist, a cube will be returned.

Parameters:

  • debug_mesh_name (str) –

  • to_target_mesh (DynamicMesh) –

  • clear_debug_mesh (bool) – if true, debug mesh will be removed from global storage

Returns:

debug_mesh_exists (bool): will return as true if DebugMeshName existed

Return type:

bool

classmethod stash_debug_mesh(target_mesh, debug_mesh_name) → DynamicMesh

Store a copy of TargetMesh with name DebugMeshName. The mesh can later be recovered via FetchDebugMesh. warning: This function stores the mesh in a global data structure, the caller must take care to avoid storing large numbers of debug meshes

Parameters:
Return type:

DynamicMesh