unreal.GeometryScript_Polygroups
¶
- class unreal.GeometryScript_Polygroups(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶
Bases:
BlueprintFunctionLibrary
Geometry Script Library Mesh Polygroup Functions
C++ Source:
Plugin: GeometryScripting
Module: GeometryScriptingCore
File: MeshPolygroupFunctions.h
- classmethod clear_polygroups(target_mesh, group_layer, clear_value=0, debug=None) DynamicMesh ¶
Clear Polygroups
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
clear_value (int32) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod compute_polygroups_from_angle_threshold(target_mesh, group_layer, crease_angle=15.000000, min_group_size=2, debug=None) DynamicMesh ¶
Compute Polygroups from Angle Threshold
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
crease_angle (float) –
min_group_size (int32) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod compute_polygroups_from_polygon_detection(target_mesh, group_layer, respect_uv_seams=True, respect_hard_normals=False, quad_adjacency_weight=1.000000, quad_metric_clamp=1.000000, max_search_rounds=1, debug=None) DynamicMesh ¶
Compute Polygroups from Polygon Detection
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
respect_uv_seams (bool) –
respect_hard_normals (bool) –
quad_adjacency_weight (double) –
quad_metric_clamp (double) –
max_search_rounds (int32) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod convert_components_to_polygroups(target_mesh, group_layer, debug=None) DynamicMesh ¶
Convert Components to Polygroups
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod convert_uv_islands_to_polygroups(target_mesh, group_layer, uv_layer=0, debug=None) DynamicMesh ¶
Convert UVIslands to Polygroups
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
uv_layer (int32) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod copy_polygroups_layer(target_mesh, from_group_layer, to_group_layer, debug=None) DynamicMesh ¶
Copy Polygroups Layer
- Parameters:
target_mesh (DynamicMesh) –
from_group_layer (GeometryScriptGroupLayer) –
to_group_layer (GeometryScriptGroupLayer) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod delete_triangles_in_polygroup(target_mesh, group_layer, polygroup_id, defer_change_notifications=False, debug=None) -> (DynamicMesh, num_deleted=int32)¶
Delete Triangles in Polygroup
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
polygroup_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –
- Returns:
num_deleted (int32):
- Return type:
int32
- classmethod enable_polygroups(target_mesh, debug=None) DynamicMesh ¶
Enable Polygroups
- Parameters:
target_mesh (DynamicMesh) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod get_all_triangle_polygroup_i_ds(target_mesh, group_layer, polygroup_i_ds_out) -> (DynamicMesh, polygroup_i_ds_out=GeometryScriptIndexList)¶
Create list of per-triangle Polygroup IDs for the Polygroup in the Mesh warning: if the mesh is not Triangle-Compact (eg GetHasTriangleIDGaps == false) then the returned list will also have the same gaps
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
polygroup_i_ds_out (GeometryScriptIndexList) –
- Returns:
polygroup_i_ds_out (GeometryScriptIndexList):
- Return type:
- classmethod get_polygroup_i_ds_in_mesh(target_mesh, group_layer, polygroup_i_ds_out) -> (DynamicMesh, polygroup_i_ds_out=GeometryScriptIndexList)¶
Create list of all unique Polygroup IDs that exist in the Polygroup Layer in the Mesh
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
polygroup_i_ds_out (GeometryScriptIndexList) –
- Returns:
polygroup_i_ds_out (GeometryScriptIndexList):
- Return type:
- classmethod get_triangle_polygroup_id(target_mesh, group_layer, triangle_id) -> (int32, is_valid_triangle=bool)¶
Get Triangle Polygroup ID
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
triangle_id (int32) –
- Returns:
is_valid_triangle (bool):
- Return type:
- classmethod get_triangles_in_polygroup(target_mesh, group_layer, polygroup_id, triangle_i_ds_out) -> (DynamicMesh, triangle_i_ds_out=GeometryScriptIndexList)¶
Create list of all triangles with the given Polygroup ID in the given GroupLayer (not necessarily a single connected-component)
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
polygroup_id (int32) –
triangle_i_ds_out (GeometryScriptIndexList) –
- Returns:
triangle_i_ds_out (GeometryScriptIndexList):
- Return type:
- classmethod set_num_extended_polygroup_layers(target_mesh, num_layers, debug=None) DynamicMesh ¶
Set Num Extended Polygroup Layers
- Parameters:
target_mesh (DynamicMesh) –
num_layers (int32) –
debug (GeometryScriptDebug) –
- Return type:
- classmethod set_polygroup_for_mesh_selection(target_mesh, group_layer, selection, set_polygroup_id=0, generate_new_polygroup=False, defer_change_notifications=False) -> (DynamicMesh, set_polygroup_id_out=int32)¶
Set a new Polygroup on all the triangles of the given Selection, for the given GroupLayer.
- Parameters:
target_mesh (DynamicMesh) –
group_layer (GeometryScriptGroupLayer) –
selection (GeometryScriptMeshSelection) –
set_polygroup_id (int32) – explicit new PolygroupID to set
generate_new_polygroup (bool) – if true, SetPolygroupID is ignored and a new unique PolygroupID is generated
defer_change_notifications (bool) – if true, the UDynamicMesh does not emit a change event/signal for this modification
- Returns:
set_polygroup_id_out (int32): the PolygroupID that was set on the triangles is returned here (whether explicit or auto-generated)
- Return type:
int32