unreal.GeometryScript_MeshSelection

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

Bases: BlueprintFunctionLibrary

Geometry Script Library Mesh Selection Functions

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingCore

  • File: MeshSelectionFunctions.h

classmethod combine_mesh_selections(selection_a, selection_b, combine_mode=GeometryScriptCombineSelectionMode.ADD) → GeometryScriptMeshSelection

Combine two Mesh Selections into a new Mesh Selection. The two inputs SelectionA and SelectionB must have the same Type.

Parameters:
Returns:

result_selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod convert_index_array_to_mesh_selection(target_mesh, index_array, selection_type) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a Mesh Selection from the IndexArray.

Parameters:
Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod convert_index_list_to_mesh_selection(target_mesh, index_list, selection_type) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a Mesh Selection from the Index List. For cases where the IndexList Type does not match the SelectionType, ConvertMeshSelection with bAllowPartialInclusion=true is used to convert.

Parameters:
Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod convert_index_set_to_mesh_selection(target_mesh, index_set, selection_type) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a Mesh Selection from the IndexSet.

Parameters:
Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod convert_mesh_selection(target_mesh, from_selection, new_type=GeometryScriptMeshSelectionType.TRIANGLES, allow_partial_inclusion=True) -> (DynamicMesh, to_selection=GeometryScriptMeshSelection)

Convert a Mesh Selection to a different Type (eg Vertices to Triangles, etc) By default, Vertices map to Triangle one-rings, and Triangles to all contained vertices. If bAllowPartialInclusion is disabled, then more restrictive conversions are performed, as follows:

For To-Vertices, only include vertices where all one-ring triangles or edges are included in FromSelection. For To-Edges, only include edges where all adjacent triangles or vertices are included in FromSelection For To-Triangles, only include triangles where all tri vertices or edges are included in FromSelection. For To-PolyGroups, only include groups where all group triangles are touched by FromSelection

(Note: The To-PolyGroups rule allows vertex and edge selections that miss some vertices or edges, as long as they touch all the polygroup triangles.)

Parameters:
Returns:

to_selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod convert_mesh_selection_to_index_array(target_mesh, selection) -> (DynamicMesh, index_array=Array[int32], selection_type=GeometryScriptMeshSelectionType)

Convert a Mesh Selection to an Index Array

Parameters:
Returns:

index_array (Array[int32]):

selection_type (GeometryScriptMeshSelectionType):

Return type:

tuple

classmethod convert_mesh_selection_to_index_list(target_mesh, selection, convert_to_type=GeometryScriptIndexType.ANY) -> (DynamicMesh, index_list=GeometryScriptIndexList, result_list_type=GeometryScriptIndexType)

Convert a Mesh Selection to an Index List

Parameters:
Returns:

index_list (GeometryScriptIndexList):

result_list_type (GeometryScriptIndexType):

Return type:

tuple

classmethod create_select_all_mesh_selection(target_mesh, selection_type=GeometryScriptMeshSelectionType.TRIANGLES) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a Selection of the given SelectionType that contains all the mesh elements of TargetMesh

Parameters:
Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod debug_print_mesh_selection(selection, disable=False) → None

Print information about the Mesh Selection to the Output Log

Parameters:
classmethod expand_contract_mesh_selection(target_mesh, selection, iterations=1, contract=False, only_expand_to_face_neighbours=False) -> (DynamicMesh, new_selection=GeometryScriptMeshSelection)

Grow or Shrink the Selection on the TargetMesh to connected neighbours. For Vertex selections, Expand includes vertices in one-ring of selected vertices, and Contract removes any vertices with a one-ring neighbour that is not selected For Triangle selections, Add/Remove Triangles connected to selected Triangles For PolyGroup selections, Add/Remove PolyGroups connected to selected PolyGroups

Parameters:

  • target_mesh (DynamicMesh)

  • selection (GeometryScriptMeshSelection)

  • iterations (int32) – number of times to Expand/Contract the Selection. Valid range is [0,100] where 0 is a no-op.

  • contract (bool) – if true selection contracts instead of growing

  • only_expand_to_face_neighbours (bool) – if true, only adjacent Triangles/PolyGroups directly connected by an edge are added, vs connected to any selected vertex

Returns:

new_selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod expand_mesh_selection_to_connected(target_mesh, selection, connection_type=GeometryScriptTopologyConnectionType.GEOMETRIC) -> (DynamicMesh, new_selection=GeometryScriptMeshSelection)

Expand the Selection on the TargetMesh to connected regions and return the NewSelection

Parameters:
Returns:

new_selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod get_mesh_selection_info(selection) -> (selection_type=GeometryScriptMeshSelectionType, num_selected=int32)

Query information about a Mesh Selection Note that NumSelected may double count some polygroups and (non-border) edges due to their internal representation Use GetMeshUniqueSelectionInfo for an accurate count of unique mesh elements

Parameters:

selection (GeometryScriptMeshSelection)

Returns:

selection_type (GeometryScriptMeshSelectionType):

num_selected (int32):

Return type:

tuple

classmethod get_mesh_unique_selection_info(target_mesh, selection) -> (selection_type=GeometryScriptMeshSelectionType, num_selected=int32)

Query information about a Mesh Selection, and get a count of unique selected elements

Parameters:
Returns:

selection_type (GeometryScriptMeshSelectionType):

num_selected (int32):

Return type:

tuple

classmethod invert_mesh_selection(target_mesh, selection, only_to_connected=False) -> (DynamicMesh, new_selection=GeometryScriptMeshSelection)

Invert the Selection on the TargetMesh, ie select what is not currently selected

Parameters:

  • target_mesh (DynamicMesh)

  • selection (GeometryScriptMeshSelection)

  • only_to_connected (bool) – if true, the inverse is limited to mesh areas geometrically connected to the Selection, instead of the entire mesh

Returns:

new_selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_boundary_edges(target_mesh) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Selection, for the TargetMesh, of all mesh boundary edges

Parameters:

target_mesh (DynamicMesh)

Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_elements_by_material_id(target_mesh, material_id, selection_type=GeometryScriptMeshSelectionType.TRIANGLES) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a Selection of the SelectionType that contains all mesh elements referencing triangles with the given Material ID

Parameters:
Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_elements_by_normal_angle(target_mesh, normal=[0.000000, 0.000000, 1.000000], max_angle_deg=1.000000, selection_type=GeometryScriptMeshSelectionType.TRIANGLES, invert=False, min_num_triangle_points=3) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Mesh Selection of the SelectionType for the TargetMesh by finding all elements that have a normal vector that is within an angular deviation threshold from the given Normal. For Triangle and PolyGroup selections the triangle facet normal is used, for Vertex selections the per-vertex averaged normal is used.

Parameters:

  • target_mesh (DynamicMesh)

  • normal (Vector) – normal/direction vector to measure against

  • max_angle_deg (double) – maximum angular deviation from Normal, in degrees

  • selection_type (GeometryScriptMeshSelectionType)

  • invert (bool) – return a selection of all elements not within the given deviation

  • min_num_triangle_points (int32)

Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_elements_by_polygroup(target_mesh, group_layer, polygroup_id, selection_type=GeometryScriptMeshSelectionType.TRIANGLES) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a Selection of the SelectionType that contains all mesh elements referencing triangles with the given PolyGroup ID in the given GroupLayer

Parameters:
Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_elements_in_box(target_mesh, box, selection_type=GeometryScriptMeshSelectionType.TRIANGLES, invert=False, min_num_triangle_points=3) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Mesh Selection of the SelectionType for the TargetMesh by finding all elements contained in the Box.

Parameters:
Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_elements_in_sphere(target_mesh, sphere_origin=[0.000000, 0.000000, 0.000000], sphere_radius=100.000000, selection_type=GeometryScriptMeshSelectionType.TRIANGLES, invert=False, min_num_triangle_points=3) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Mesh Selection of the SelectionType for the TargetMesh by finding all elements contained in the Sphere.

Parameters:

  • target_mesh (DynamicMesh)

  • sphere_origin (Vector) – center point of the Sphere

  • sphere_radius (double) – radius of the Sphere

  • selection_type (GeometryScriptMeshSelectionType)

  • invert (bool) – return a selection of all elements not in the Sphere

  • min_num_triangle_points (int32)

Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_elements_inside_mesh(target_mesh, selection_mesh, selection_mesh_transform, selection_type=GeometryScriptMeshSelectionType.TRIANGLES, invert=False, shell_distance=0.000000, winding_threshold=0.500000, min_num_triangle_points=3) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Mesh Selection of the SelectionType for the TargetMesh by finding all elements inside a second SelectionMesh For Triangle and PolyGroup selections the triangle facet normal is used, for Vertex selections the per-vertex averaged normal is used.

Parameters:

  • target_mesh (DynamicMesh)

  • selection_mesh (DynamicMesh)

  • selection_mesh_transform (Transform) – Transform applied to SelectionMesh for inside/outside testing

  • selection_type (GeometryScriptMeshSelectionType)

  • invert (bool) – return a selection of all elements not within the given deviation

  • shell_distance (double) – If > 0, points within this distance from SelectionMesh will also be considered “inside”

  • winding_threshold (double) – Threshold used for Fast Mesh Winding Number inside/outside test (range is [0,1], with 1 being “inside”)

  • min_num_triangle_points (int32)

Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_elements_with_plane(target_mesh, plane_origin=[0.000000, 0.000000, 0.000000], plane_normal=[0.000000, 0.000000, 1.000000], selection_type=GeometryScriptMeshSelectionType.TRIANGLES, invert=False, min_num_triangle_points=3) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Mesh Selection of the SelectionType for the TargetMesh by finding all elements on the “positive” side of a Plane

Parameters:

  • target_mesh (DynamicMesh)

  • plane_origin (Vector) – center point of the Plane

  • plane_normal (Vector) – normal vector for the Plane

  • selection_type (GeometryScriptMeshSelectionType)

  • invert (bool) – return a selection of all elements on the other (negative) side of the Plane

  • min_num_triangle_points (int32)

Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_poly_group_boundary_edges(target_mesh, group_layer, exclude_mesh_boundary_edges=False) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Mesh Selection of PolyGroup boundary edges for the TargetMesh

Parameters:

  • target_mesh (DynamicMesh)

  • group_layer (GeometryScriptGroupLayer) – PolyGroup layer to reference

  • exclude_mesh_boundary_edges (bool) – If true, do not include mesh boundary edges in the selection; otherwise, they will be included.

Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_sharp_edges(target_mesh, min_angle_deg=20.000000) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Selection, for the TargetMesh, of all ‘sharp’ edges where the edge’s adjacent triangle normals differ by at least MinAngleDeg

Parameters:
Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_split_normal_edges(target_mesh) -> (DynamicMesh, selection=GeometryScriptMeshSelection)

Create a new Selection, for the TargetMesh, of all edges seams in the mesh normal topology – i.e., where normals can be different across the edge

Parameters:

target_mesh (DynamicMesh)

Returns:

selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection

classmethod select_mesh_uv_seam_edges(target_mesh, uv_channel, exclude_mesh_boundary_edges=False) -> (DynamicMesh, selection=GeometryScriptMeshSelection, have_valid_u_vs=bool)

Create a new Mesh Selection of UV seam edges for the TargetMesh

Parameters:

  • target_mesh (DynamicMesh)

  • uv_channel (int32) – Seams will be found with respect to this UV Channel

  • exclude_mesh_boundary_edges (bool) – If true, do not include mesh boundary edges in the selection; otherwise, they will be included.

Returns:

selection (GeometryScriptMeshSelection):

have_valid_u_vs (bool): If false, the requested UV Channel was not present on the TargetMesh

Return type:

tuple

classmethod select_selection_boundary_edges(target_mesh, selection, exclude_mesh_boundary_edges=False) -> (DynamicMesh, boundary_selection=GeometryScriptMeshSelection)

Create a new BoundarySelection, for the TargetMesh, of the edges on the boundary of another Selection

Parameters:
Returns:

boundary_selection (GeometryScriptMeshSelection):

Return type:

GeometryScriptMeshSelection