unreal.GeometryScript_MeshModeling
¶
- class unreal.GeometryScript_MeshModeling(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
BlueprintFunctionLibrary
Geometry Script Library Mesh Modeling Functions
C++ Source:
Plugin: GeometryScripting
Module: GeometryScriptingCore
File: MeshModelingFunctions.h
- classmethod apply_mesh_bevel_selection(target_mesh, selection, bevel_mode, bevel_options, debug=None) DynamicMesh ¶
Apply a Mesh Bevel operation to parts of TargetMesh using the BevelOptions settings.
- Parameters:
target_mesh (DynamicMesh) –
selection (GeometryScriptMeshSelection) – specifies which mesh edges to Bevel
bevel_mode (GeometryScriptMeshBevelSelectionMode) – specifies how Selection should be converted to a Triangle Region or set of PolyGroup Edges
bevel_options (GeometryScriptMeshBevelSelectionOptions) – settings for the Bevel Operation
debug (GeometryScriptDebug) –
- Return type:
- classmethod apply_mesh_disconnect_faces(target_mesh, selection, allow_bowties_in_output=True, debug=None) DynamicMesh ¶
Disconnect the triangles of TargetMesh identified by the Selection. The input Selection will still identify the same geometric elements after Disconnecting.
- Parameters:
target_mesh (DynamicMesh) –
selection (GeometryScriptMeshSelection) –
allow_bowties_in_output (bool) – if false, any bowtie vertices resulting created in the Duplicate area will be disconnected into unique vertices
debug (GeometryScriptDebug) –
- Return type:
- classmethod apply_mesh_duplicate_faces(target_mesh, selection, group_options=[GeometryScriptMeshEditPolygroupMode.PRESERVE_EXISTING, 0], debug=None) -> (DynamicMesh, new_triangles=GeometryScriptMeshSelection)¶
Duplicate the triangles of TargetMesh identified by the Selection
- Parameters:
target_mesh (DynamicMesh) –
selection (GeometryScriptMeshSelection) –
group_options (GeometryScriptMeshEditPolygroupOptions) –
debug (GeometryScriptDebug) –
- Returns:
new_triangles (GeometryScriptMeshSelection): a Mesh Selection of the duplicate triangles is returned here (with type Triangles)
- Return type:
- classmethod apply_mesh_extrude(target_mesh: DynamicMesh, options: GeometryScriptMeshExtrudeOptions, debug: GeometryScriptDebug = Ellipsis) DynamicMesh ¶
deprecated: ‘apply_mesh_extrude’ was renamed to ‘apply_mesh_extrude_compatibility_5p0’.
- classmethod apply_mesh_extrude_compatibility_5p0(target_mesh, options, debug=None) DynamicMesh ¶
Backwards-Compatibility implementations¶
These are versions/variants of the above functions that were released in previous UE 5.x versions, that have since been updated. To avoid breaking user scripts, these previous versions are currently kept and called via redirectors registered in GeometryScriptingCoreModule.cpp.
These functions may be deprecated in future UE releases.
- param target_mesh:
- type target_mesh:
DynamicMesh
- param options:
- type options:
GeometryScriptMeshExtrudeOptions
- param debug:
- type debug:
GeometryScriptDebug
- rtype:
DynamicMesh
- classmethod apply_mesh_inset_outset_faces(target_mesh, options, selection, debug=None) DynamicMesh ¶
Apply an Inset or Outset to the faces of TargetMesh identified by the Selection, or all faces if the Selection is empty.
- Parameters:
target_mesh (DynamicMesh) –
options (GeometryScriptMeshInsetOutsetFacesOptions) –
selection (GeometryScriptMeshSelection) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod apply_mesh_linear_extrude_faces(target_mesh, options, selection, debug=None) DynamicMesh ¶
Apply Linear Extrusion (ie extrusion in a single direction) to the triangles of TargetMesh identified by the Selection. The input Selection will still identify the same geometric elements after the Extrusion
- Parameters:
target_mesh (DynamicMesh) –
options (GeometryScriptMeshLinearExtrudeOptions) –
selection (GeometryScriptMeshSelection) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod apply_mesh_offset(target_mesh, options, debug=None) DynamicMesh ¶
Offset the vertices of TargetMesh from their initial positions based on averaged vertex normals. This function is intended for high-res meshes, for polymodeling-style offsets, ApplyMeshOffsetFaces will produce better results.
- Parameters:
target_mesh (DynamicMesh) –
options (GeometryScriptMeshOffsetOptions) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod apply_mesh_offset_faces(target_mesh, options, selection, debug=None) DynamicMesh ¶
Apply an Offset to the faces of TargetMesh identified by the Selection, or all faces if the Selection is empty. The Offset direction at each vertex can be derived from the averaged vertex normals or per-triangle normals.
- Parameters:
target_mesh (DynamicMesh) –
options (GeometryScriptMeshOffsetFacesOptions) –
selection (GeometryScriptMeshSelection) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod apply_mesh_polygroup_bevel(target_mesh, options, debug=None) DynamicMesh ¶
Apply a Mesh Bevel operation to all PolyGroup Edges.
- Parameters:
target_mesh (DynamicMesh) –
options (GeometryScriptMeshBevelOptions) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod apply_mesh_shell(target_mesh, options, debug=None) DynamicMesh ¶
Create a thickened shell from TargetMesh by offsetting the vertex positions along averaged vertex normals, inwards or outwards. Similar to ApplyMeshOffset but also includes the initial mesh (possibly flipped, if the offset is positive)
- Parameters:
target_mesh (DynamicMesh) –
options (GeometryScriptMeshOffsetOptions) –
debug (GeometryScriptDebug) –
- Return type: