unreal.GeometryScript_Materials

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

Bases: BlueprintFunctionLibrary

Geometry Script Library Mesh Material Functions

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingCore

  • File: MeshMaterialFunctions.h

classmethod clear_material_i_ds(target_mesh, clear_value=0, debug=None) → DynamicMesh

Resets all Material IDs on a mesh to the given ClearValue, or 0 if no ClearValue is provided. If Material IDs are not already enabled on the Target Mesh, this function will first enable them and then set the value.

Parameters:
Return type:

DynamicMesh

classmethod compact_material_i_ds(target_mesh, source_material_list, debug=None) -> (DynamicMesh, compacted_material_list=Array[MaterialInterface])

Compact the MaterialIDs of the TargetMesh, ie remove any un-used MaterialIDs and remap the remaining N in-use MaterialIDs to the range [0,N-1]. Optionally compute a Compacted list of Materials.

Parameters:
Returns:

compacted_material_list (Array[MaterialInterface]): new Compacted Material list, one-to-one with new compacted MaterialIDs

Return type:

Array[MaterialInterface]

classmethod delete_triangles_by_material_id(target_mesh, material_id, defer_change_notifications=False, debug=None) -> (DynamicMesh, num_deleted=int32)

Delete all triangles in TargetMesh with the given MaterialID

Parameters:
Returns:

num_deleted (int32): number of deleted triangles is returned here

Return type:

int32

classmethod enable_material_i_ds(target_mesh, debug=None) → DynamicMesh

Enables per-triangle Material IDs on a mesh and initializes the values to 0. If Target Mesh already has Material IDs, this function will do nothing.

Parameters:
Return type:

DynamicMesh

classmethod get_all_triangle_material_i_ds(target_mesh) -> (DynamicMesh, material_id_list=GeometryScriptIndexList, has_material_i_ds=bool)

Returns an Index List of all triangle Material IDs, constructed with one entry for each consecutive Triangle ID. If Material IDs are not enabled on the mesh, bHasMaterialsIDs will be set to false on return and nothing will be added to the Material ID List. warning: if the mesh is not Triangle-Compact (eg GetHasTriangleIDGaps == false) then the returned list will also have the same gaps where the number -1 will be recorded for any missing Triangle IDs.

Parameters:

target_mesh (DynamicMesh) –

Returns:

material_id_list (GeometryScriptIndexList):

has_material_i_ds (bool):

Return type:

tuple

classmethod get_material_i_ds_of_triangles(target_mesh, triangle_id_list, debug=None) -> (DynamicMesh, material_id_list=GeometryScriptIndexList)

This populates the MaterialIDList with Material IDs for each triangle in the TriangleIDList. If a triangle is not present in the Target Mesh the number -1 will be used for the corresponding Material ID. If Material IDs are not enabled on the TargetMesh no Material IDs will be added to the result list.

Parameters:
Returns:

material_id_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

classmethod get_max_material_id(target_mesh) -> (int32, has_material_i_ds=bool)

Get Max Material ID

Parameters:

target_mesh (DynamicMesh) –

Returns:

has_material_i_ds (bool):

Return type:

bool

classmethod get_triangle_material_id(target_mesh, triangle_id) -> (int32, is_valid_triangle=bool)

Returns the current Material ID for a Triangle. If the mesh does not have Material IDs enabled or if the Triangle ID is not an element of the mesh, the value 0 will be returned and bIsValidTriangle will be false.

Parameters:

  • target_mesh (DynamicMesh) –

  • triangle_id (int32) –

Returns:

is_valid_triangle (bool):

Return type:

bool

classmethod get_triangles_by_material_id(target_mesh, material_id, debug=None) -> (DynamicMesh, triangle_id_list=GeometryScriptIndexList)

Populates Triangle ID List with the Triangle IDs of triangles that share the specified Material ID in the Target Mesh.

Parameters:
Returns:

triangle_id_list (GeometryScriptIndexList):

Return type:

GeometryScriptIndexList

classmethod remap_material_i_ds(target_mesh, from_material_id, to_material_id, debug=None) → DynamicMesh

For all triangles with a Material ID matching the given value (From Material ID), update the Material ID to the new value (To Material ID).

Parameters:
Return type:

DynamicMesh

classmethod remap_to_new_material_i_ds_by_material(target_mesh, from_material_list, to_material_list, missing_material_id=-1, debug=None) → DynamicMesh

Remap the Material IDs of the TargetMesh to a new set of Material IDs based on a ‘From’/Current Material List, and a New Material List. For each triangle, the current Material is determined as FromMaterialList[MaterialID], and then the first index of this Material is found in the ToMaterialList, and this index is used as the new MaterialID

If a Material cannot be found in ToMaterialList, a warning will be printed and the MaterialID left unmodified, unless MissingMaterialID is set to a value >= 0, in which case MissingMaterialID will be assigned

Parameters:
Return type:

DynamicMesh

classmethod set_all_triangle_material_i_ds(target_mesh, triangle_material_id_list, defer_change_notifications=False, debug=None) → DynamicMesh

Sets the Material ID of all triangles in a mesh to the values in an input Index List.

Parameters:
Return type:

DynamicMesh

classmethod set_material_id_for_mesh_selection(target_mesh, selection, material_id, defer_change_notifications=False, debug=None) → DynamicMesh

Set a new MaterialID on all the triangles of the given Selection.

Parameters:
Return type:

DynamicMesh

classmethod set_material_id_on_triangles(target_mesh, triangle_id_list, material_id, defer_change_notifications=False, debug=None) → DynamicMesh

Assigns the Material ID to all the triangles specified by the Triangle ID List.

Parameters:

  • target_mesh (DynamicMesh) –

  • triangle_id_list (GeometryScriptIndexList) – the triangles in the target mesh that will be updated with the new Material ID

  • material_id (int32) – the ID to be assigned to each triangle in the input list.

  • defer_change_notifications (bool) – if true, the UDynamicMesh does not emit a change event/signal for this modification.

  • debug (GeometryScriptDebug) –

Return type:

DynamicMesh

classmethod set_polygroup_material_id(target_mesh, group_layer, polygroup_id, material_id, defer_change_notifications=False, debug=None) -> (DynamicMesh, is_valid_polygroup_id=bool)

Set a new MaterialID on all the triangles of TargetMesh with the given PolyGroup.

Parameters:

  • target_mesh (DynamicMesh) –

  • group_layer (GeometryScriptGroupLayer) – PolyGroup Layer to use as basis for PolyGroups

  • polygroup_id (int32) – PolyGroup ID that specifies Triangles to set to new MaterialID

  • material_id (int32) – explicit new MaterialID to set

  • defer_change_notifications (bool) – if true, the UDynamicMesh does not emit a change event/signal for this modification

  • debug (GeometryScriptDebug) –

Returns:

is_valid_polygroup_id (bool):

Return type:

bool

classmethod set_triangle_material_id(target_mesh, triangle_id, material_id, defer_change_notifications=False) -> (DynamicMesh, is_valid_triangle=bool)

Assigns the specified triangle the given Material ID. If the Target Mesh does not have Material IDs enabled, or if the Triangle ID is not an element of the Target Mesh then bIsValidTriangle will be set to false.

Parameters:

  • target_mesh (DynamicMesh) –

  • triangle_id (int32) –

  • material_id (int32) –

  • defer_change_notifications (bool) –

Returns:

is_valid_triangle (bool):

Return type:

bool