unreal.GeometryScript_Materials¶
- class unreal.GeometryScript_Materials(outer=None, name='None')¶
Bases:
unreal.BlueprintFunctionLibraryGeometry 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¶
Clear Material IDs
- Parameters
target_mesh (DynamicMesh) –
clear_value (int32) –
debug (GeometryScriptDebug) –
- Return type
- 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
target_mesh (DynamicMesh) –
source_material_list (Array(MaterialInterface)) – Input Material list, assumption is that SourceMaterialList.Num() == number of MaterialIDs on mesh at input
debug (GeometryScriptDebug) –
- Returns
compacted_material_list (Array(MaterialInterface)): new Compacted Material list, one-to-one with new compacted MaterialIDs
- Return type
- classmethod delete_triangles_by_material_id(target_mesh, material_id, defer_change_notifications=False, debug=None) -> (DynamicMesh, num_deleted=int32)¶
Delete Triangles by Material ID
- Parameters
target_mesh (DynamicMesh) –
material_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –
- Returns
num_deleted (int32):
- Return type
int32
- classmethod enable_material_i_ds(target_mesh, debug=None) DynamicMesh¶
Enable Material IDs
- Parameters
target_mesh (DynamicMesh) –
debug (GeometryScriptDebug) –
- Return type
- classmethod get_all_triangle_material_i_ds(target_mesh) -> (DynamicMesh, material_id_list=GeometryScriptIndexList, has_material_i_ds=bool)¶
Get All Triangle Material IDs
- Parameters
target_mesh (DynamicMesh) –
- Returns
material_id_list (GeometryScriptIndexList):
has_material_i_ds (bool):
- Return type
tuple
- 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
- classmethod get_triangle_material_id(target_mesh, triangle_id) -> (int32, is_valid_triangle=bool)¶
Get Triangle Material ID
- Parameters
target_mesh (DynamicMesh) –
triangle_id (int32) –
- Returns
is_valid_triangle (bool):
- Return type
- classmethod remap_material_i_ds(target_mesh, from_material_id, to_material_id, debug=None) DynamicMesh¶
Remap Material IDs
- Parameters
target_mesh (DynamicMesh) –
from_material_id (int32) –
to_material_id (int32) –
debug (GeometryScriptDebug) –
- Return type
- classmethod set_all_triangle_material_i_ds(target_mesh, defer_change_notifications=False, debug=None) -> (DynamicMesh, triangle_material_id_list=GeometryScriptIndexList)¶
Set All Triangle Material IDs
- Parameters
target_mesh (DynamicMesh) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –
- Returns
triangle_material_id_list (GeometryScriptIndexList):
- Return type
- 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 Polygroup Material ID
- Parameters
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
polygroup_id (int32) –
material_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –
- Returns
is_valid_polygroup_id (bool):
- Return type
- classmethod set_triangle_material_id(target_mesh, triangle_id, material_id, defer_change_notifications=False) -> (DynamicMesh, is_valid_triangle=bool)¶
Set Triangle Material ID
- Parameters
target_mesh (DynamicMesh) –
triangle_id (int32) –
material_id (int32) –
defer_change_notifications (bool) –
- Returns
is_valid_triangle (bool):
- Return type