`unreal.DynamicMesh`¶

class unreal.DynamicMesh(outer=None, name='None')¶

Bases: unreal.Object

UDynamicMesh is a UObject container for a FDynamicMesh3.

C++ Source:

Module: GeometryFramework
File: UDynamicMesh.h

Editor Properties: (see get_editor_property/set_editor_property)

enable_mesh_generator (bool): [Read-Write] Enable Mesh Generator: Controls whether the active Generator (if configured) will be applied when rebuilding the mesh
mesh_modified_bp_event (OnDynamicMeshModifiedBP): [Read-Write] Mesh Modified BPEvent: Blueprintable event called when mesh is modified, in the same cases as OnMeshChanged

add_triangle_to_mesh(new_triangle, new_triangle_group_id=0, defer_change_notifications=False, debug=None) -> (DynamicMesh, new_triangle_index=int32)¶

Add Triangle to Mesh

Parameters

new_triangle (IntVector) –
new_triangle_group_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Returns

new_triangle_index (int32):

Return type

int32

add_triangles_to_mesh(new_triangles_list, new_triangle_group_id=0, defer_change_notifications=False, debug=None) -> (DynamicMesh, new_indices_list=GeometryScriptIndexList)¶

Add Triangles to Mesh

Parameters

new_triangles_list (GeometryScriptTriangleList) –
new_triangle_group_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Returns

new_indices_list (GeometryScriptIndexList):

Return type

GeometryScriptIndexList

add_vertex_to_mesh(new_position, defer_change_notifications=False) -> (DynamicMesh, new_vertex_index=int32)¶

Add Vertex to Mesh

Parameters

new_position (Vector) –
defer_change_notifications (bool) –

Returns

new_vertex_index (int32):

Return type

int32

add_vertices_to_mesh(new_positions_list, defer_change_notifications=False) -> (DynamicMesh, new_indices_list=GeometryScriptIndexList)¶

Add Vertices to Mesh

Parameters

new_positions_list (GeometryScriptVectorList) –
defer_change_notifications (bool) –

Returns

new_indices_list (GeometryScriptIndexList):

Return type

GeometryScriptIndexList

append_box(primitive_options, transform, dimension_x=100.000000, dimension_y=100.000000, dimension_z=100.000000, steps_x=0, steps_y=0, steps_z=0, origin=GeometryScriptPrimitiveOriginMode.BASE, debug=None) → DynamicMesh¶

Append Box

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
dimension_x (float) –
dimension_y (float) –
dimension_z (float) –
steps_x (int32) –
steps_y (int32) –
steps_z (int32) –
origin (GeometryScriptPrimitiveOriginMode) –
debug (GeometryScriptDebug) –

Return type

append_buffers_to_mesh(buffers, material_id=0, defer_change_notifications=False, debug=None) -> (DynamicMesh, new_triangle_indices_list=GeometryScriptIndexList)¶

Append Buffers to Mesh

Parameters

buffers (GeometryScriptSimpleMeshBuffers) –
material_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Returns

new_triangle_indices_list (GeometryScriptIndexList):

Return type

GeometryScriptIndexList

append_capsule(primitive_options, transform, radius=30.000000, line_length=75.000000, hemisphere_steps=5, circle_steps=8, origin=GeometryScriptPrimitiveOriginMode.BASE, debug=None) → DynamicMesh¶

Append Capsule

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
radius (float) –
line_length (float) –
hemisphere_steps (int32) –
circle_steps (int32) –
origin (GeometryScriptPrimitiveOriginMode) –
debug (GeometryScriptDebug) –

Return type

append_cone(primitive_options, transform, base_radius=50.000000, top_radius=5.000000, height=100.000000, radial_steps=12, height_steps=4, capped=True, origin=GeometryScriptPrimitiveOriginMode.BASE, debug=None) → DynamicMesh¶

Append Cone

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
base_radius (float) –
top_radius (float) –
height (float) –
radial_steps (int32) –
height_steps (int32) –
capped (bool) –
origin (GeometryScriptPrimitiveOriginMode) –
debug (GeometryScriptDebug) –

Return type

append_curved_stairs(primitive_options, transform, step_width=100.000000, step_height=20.000000, inner_radius=150.000000, curve_angle=90.000000, num_steps=8, floating=False, debug=None) → DynamicMesh¶

Append Curved Stairs

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
step_width (float) –
step_height (float) –
inner_radius (float) –
curve_angle (float) –
num_steps (int32) –
floating (bool) –
debug (GeometryScriptDebug) –

Return type

append_cylinder(primitive_options, transform, radius=50.000000, height=100.000000, radial_steps=12, height_steps=0, capped=True, origin=GeometryScriptPrimitiveOriginMode.BASE, debug=None) → DynamicMesh¶

Append Cylinder

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
radius (float) –
height (float) –
radial_steps (int32) –
height_steps (int32) –
capped (bool) –
origin (GeometryScriptPrimitiveOriginMode) –
debug (GeometryScriptDebug) –

Return type

append_disc(primitive_options, transform, radius=50.000000, angle_steps=16, spoke_steps=0, start_angle=0.000000, end_angle=360.000000, hole_radius=0.000000, debug=None) → DynamicMesh¶

Append Disc

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
radius (float) –
angle_steps (int32) –
spoke_steps (int32) –
start_angle (float) –
end_angle (float) –
hole_radius (float) –
debug (GeometryScriptDebug) –

Return type

append_linear_stairs(primitive_options, transform, step_width=100.000000, step_height=20.000000, step_depth=30.000000, num_steps=8, floating=False, debug=None) → DynamicMesh¶

Append Linear Stairs

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
step_width (float) –
step_height (float) –
step_depth (float) –
num_steps (int32) –
floating (bool) –
debug (GeometryScriptDebug) –

Return type

append_mesh(append_mesh, append_transform, defer_change_notifications=False, debug=None) → DynamicMesh¶

Append Mesh

Parameters

append_mesh (DynamicMesh) –
append_transform (Transform) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Return type

append_mesh_repeated(append_mesh, append_transform, repeat_count=1, apply_transform_to_first_instance=True, defer_change_notifications=False, debug=None) → DynamicMesh¶

Append Mesh Repeated

Parameters

append_mesh (DynamicMesh) –
append_transform (Transform) –
repeat_count (int32) –
apply_transform_to_first_instance (bool) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Return type

append_rectangle(primitive_options, transform, dimension_x=100.0, dimension_y=100.0, steps_width=0, steps_height=0, debug=None)¶: deprecated: ‘append_rectangle’ was renamed to ‘append_rectangle_compatibility_5_0’.

append_rectangle_compatibility_5_0(primitive_options, transform, dimension_x=100.000000, dimension_y=100.000000, steps_width=0, steps_height=0, debug=None) → DynamicMesh¶

5.0 Preview 1 Compatibility version of AppendRectangleXY. Incorrectly interprets the input dimensions. Incorrectly divides the input DimensionX and DimensionY by 2. warning: It is strongly recommended that callers of this function update to the current AppendRectangleXY function!

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
dimension_x (float) –
dimension_y (float) –
steps_width (int32) –
steps_height (int32) –
debug (GeometryScriptDebug) –

Return type

append_rectangle_xy(primitive_options, transform, dimension_x=100.000000, dimension_y=100.000000, steps_width=0, steps_height=0, debug=None) → DynamicMesh¶

Append Rectangle XY

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
dimension_x (float) –
dimension_y (float) –
steps_width (int32) –
steps_height (int32) –
debug (GeometryScriptDebug) –

Return type

append_revolve_path(primitive_options, transform, path_vertices, revolve_options, steps=8, capped=True, debug=None) → DynamicMesh¶

Append Revolve Path

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
path_vertices (Array(Vector2D)) –
revolve_options (GeometryScriptRevolveOptions) –
steps (int32) –
capped (bool) –
debug (GeometryScriptDebug) –

Return type

append_revolve_polygon(primitive_options, transform, polygon_vertices, revolve_options, radius=100.000000, steps=8, debug=None) → DynamicMesh¶

In the coordinate system of the revolve polygon, +X is towards the “outside” of the revolve donut, and +Y is “up” (ie +Z in local space) Polygon should be oriented counter-clockwise to produce a correctly-oriented shape, otherwise it will be inside-out Polygon endpoint is not repeated.

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
polygon_vertices (Array(Vector2D)) –
revolve_options (GeometryScriptRevolveOptions) –
radius (float) –
steps (int32) –
debug (GeometryScriptDebug) –

Return type

append_round_rectangle(primitive_options, transform, dimension_x=100.0, dimension_y=100.0, corner_radius=5.0, steps_width=0, steps_height=0, steps_round=4, debug=None)¶: deprecated: ‘append_round_rectangle’ was renamed to ‘append_round_rectangle_compatibility_5_0’.

append_round_rectangle_compatibility_5_0(primitive_options, transform, dimension_x=100.000000, dimension_y=100.000000, corner_radius=5.000000, steps_width=0, steps_height=0, steps_round=4, debug=None) → DynamicMesh¶

5.0 Preview 1 Compatibility version of AppendRoundRectangleXY. Incorrectly divides the input DimensionX and DimensionY by 2. warning: It is strongly recommended that callers of this function update to the current AppendRoundRectangleXY function!

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
dimension_x (float) –
dimension_y (float) –
corner_radius (float) –
steps_width (int32) –
steps_height (int32) –
steps_round (int32) –
debug (GeometryScriptDebug) –

Return type

append_round_rectangle_xy(primitive_options, transform, dimension_x=100.000000, dimension_y=100.000000, corner_radius=5.000000, steps_width=0, steps_height=0, steps_round=4, debug=None) → DynamicMesh¶

Append Round Rectangle XY

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
dimension_x (float) –
dimension_y (float) –
corner_radius (float) –
steps_width (int32) –
steps_height (int32) –
steps_round (int32) –
debug (GeometryScriptDebug) –

Return type

append_simple_extrude_polygon(primitive_options, transform, polygon_vertices, height=100.000000, height_steps=0, capped=True, origin=GeometryScriptPrimitiveOriginMode.BASE, debug=None) → DynamicMesh¶

Polygon should be oriented counter-clockwise to produce a correctly-oriented shape, otherwise it will be inside-out Polygon endpoint is not repeated.

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
polygon_vertices (Array(Vector2D)) –
height (float) –
height_steps (int32) –
capped (bool) –
origin (GeometryScriptPrimitiveOriginMode) –
debug (GeometryScriptDebug) –

Return type

append_simple_swept_polygon(primitive_options, transform, polygon_vertices, sweep_path, loop=False, capped=True, start_scale=1.000000, end_scale=1.000000, debug=None) → DynamicMesh¶

Append Simple Swept Polygon

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
polygon_vertices (Array(Vector2D)) –
sweep_path (Array(Vector)) –
loop (bool) –
capped (bool) –
start_scale (float) –
end_scale (float) –
debug (GeometryScriptDebug) –

Return type

append_sphere_box(primitive_options, transform, radius=50.000000, steps_x=6, steps_y=6, steps_z=6, origin=GeometryScriptPrimitiveOriginMode.CENTER, debug=None) → DynamicMesh¶

Append Sphere Box

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
radius (float) –
steps_x (int32) –
steps_y (int32) –
steps_z (int32) –
origin (GeometryScriptPrimitiveOriginMode) –
debug (GeometryScriptDebug) –

Return type

append_sphere_lat_long(primitive_options, transform, radius=50.000000, steps_phi=10, steps_theta=16, origin=GeometryScriptPrimitiveOriginMode.CENTER, debug=None) → DynamicMesh¶

Append Sphere Lat Long

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
radius (float) –
steps_phi (int32) –
steps_theta (int32) –
origin (GeometryScriptPrimitiveOriginMode) –
debug (GeometryScriptDebug) –

Return type

append_spiral_revolve_polygon(primitive_options, transform, polygon_vertices, revolve_options, radius=100.000000, steps=18, rise_per_revolution=50.000000, debug=None) → DynamicMesh¶

Append Spiral Revolve Polygon

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
polygon_vertices (Array(Vector2D)) –
revolve_options (GeometryScriptRevolveOptions) –
radius (float) –
steps (int32) –
rise_per_revolution (float) –
debug (GeometryScriptDebug) –

Return type

append_torus(primitive_options, transform, revolve_options, major_radius=50.000000, minor_radius=25.000000, major_steps=16, minor_steps=8, origin=GeometryScriptPrimitiveOriginMode.BASE, debug=None) → DynamicMesh¶

Append Torus

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
revolve_options (GeometryScriptRevolveOptions) –
major_radius (float) –
minor_radius (float) –
major_steps (int32) –
minor_steps (int32) –
origin (GeometryScriptPrimitiveOriginMode) –
debug (GeometryScriptDebug) –

Return type

append_triangulated_polygon(primitive_options, transform, polygon_vertices, allow_self_intersections=True, debug=None) → DynamicMesh¶

Polygon should be oriented counter-clockwise to produce a correctly-oriented shape, otherwise it will be inside-out Polygon endpoint is not repeated.

Parameters

primitive_options (GeometryScriptPrimitiveOptions) –
transform (Transform) –
polygon_vertices (Array(Vector2D)) –
allow_self_intersections (bool) –
debug (GeometryScriptDebug) –

Return type

apply_bend_warp_to_mesh(options, bend_orientation, bend_angle=45.000000, bend_extent=50.000000, debug=None) → DynamicMesh¶

Apply Bend Warp to Mesh

Parameters

options (GeometryScriptBendWarpOptions) –
bend_orientation (Transform) –
bend_angle (float) –
bend_extent (float) –
debug (GeometryScriptDebug) –

Return type

apply_displace_from_texture_map(texture, options, uv_layer=0, debug=None) → DynamicMesh¶

Apply Displace from Texture Map

Parameters

texture (Texture2D) –
options (GeometryScriptDisplaceFromTextureOptions) –
uv_layer (int32) –
debug (GeometryScriptDebug) –

Return type

apply_flare_warp_to_mesh(options, flare_orientation, flare_percent_x=0.000000, flare_percent_y=0.000000, flare_extent=50.000000, debug=None) → DynamicMesh¶

Apply Flare Warp to Mesh

Parameters

options (GeometryScriptFlareWarpOptions) –
flare_orientation (Transform) –
flare_percent_x (float) –
flare_percent_y (float) –
flare_extent (float) –
debug (GeometryScriptDebug) –

Return type

apply_iterative_smoothing_to_mesh(options, debug=None) → DynamicMesh¶

Apply Iterative Smoothing to Mesh

Parameters

options (GeometryScriptIterativeMeshSmoothingOptions) –
debug (GeometryScriptDebug) –

Return type

apply_math_warp_to_mesh(warp_orientation, warp_type, options, debug=None) → DynamicMesh¶

Apply Math Warp to Mesh

Parameters

warp_orientation (Transform) –
warp_type (GeometryScriptMathWarpType) –
options (GeometryScriptMathWarpOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_boolean(target_transform, tool_mesh, tool_transform, operation, options, debug=None) → DynamicMesh¶

Apply Mesh Boolean

Parameters

target_transform (Transform) –
tool_mesh (DynamicMesh) –
tool_transform (Transform) –
operation (GeometryScriptBooleanOperation) –
options (GeometryScriptMeshBooleanOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_extrude(options, debug=None) → DynamicMesh¶

Apply Mesh Extrude

Parameters

options (GeometryScriptMeshExtrudeOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_mirror(mirror_frame, options, debug=None) → DynamicMesh¶

Apply Mesh Mirror

Parameters

mirror_frame (Transform) –
options (GeometryScriptMeshMirrorOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_morphology(options, debug=None) → DynamicMesh¶

Apply Mesh Morphology

Parameters

options (GeometryScriptMorphologyOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_offset(options, debug=None) → DynamicMesh¶

Apply Mesh Offset

Parameters

options (GeometryScriptMeshOffsetOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_plane_cut(cut_frame, options, debug=None) → DynamicMesh¶

Apply Mesh Plane Cut

Parameters

cut_frame (Transform) –
options (GeometryScriptMeshPlaneCutOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_plane_slice(cut_frame, options, debug=None) → DynamicMesh¶

Apply Mesh Plane Slice

Parameters

cut_frame (Transform) –
options (GeometryScriptMeshPlaneSliceOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_polygroup_bevel(options, debug=None) → DynamicMesh¶

Apply Mesh Polygroup Bevel

Parameters

options (GeometryScriptMeshBevelOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_self_union(options, debug=None) → DynamicMesh¶

Apply Mesh Self Union

Parameters

options (GeometryScriptMeshSelfUnionOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_shell(options, debug=None) → DynamicMesh¶

Apply Mesh Shell

Parameters

options (GeometryScriptMeshOffsetOptions) –
debug (GeometryScriptDebug) –

Return type

apply_mesh_solidify(options, debug=None) → DynamicMesh¶

Apply Mesh Solidify

Parameters

options (GeometryScriptSolidifyOptions) –
debug (GeometryScriptDebug) –

Return type

apply_perlin_noise_to_mesh(options, debug=None) → DynamicMesh¶

Apply Perlin Noise to Mesh

Parameters

options (GeometryScriptPerlinNoiseOptions) –
debug (GeometryScriptDebug) –

Return type

apply_pn_tessellation(options, tessellation_level=3, debug=None) → DynamicMesh¶

Apply PNTessellation

Parameters

options (GeometryScriptPNTessellateOptions) –
tessellation_level (int32) –
debug (GeometryScriptDebug) –

Return type

apply_polygroup_catmull_clark_sub_d(subdivisions, group_layer, debug=None) → DynamicMesh¶

Apply Polygroup Catmull Clark Sub D

Parameters

subdivisions (int32) –
group_layer (GeometryScriptGroupLayer) –
debug (GeometryScriptDebug) –

Return type

apply_recursive_pn_tessellation(options, num_iterations=3, debug=None) → DynamicMesh¶

Apply Recursive PNTessellation deprecated: Use ‘Apply PN Tessellation’ instead; this deprecated version recursively subdivided the mesh NumIterations times while the new version splits every triangle into (TessellationLevel+1)^2 smaller triangles.

Parameters

options (GeometryScriptPNTessellateOptions) –
num_iterations (int32) –
debug (GeometryScriptDebug) –

Return type

apply_simplify_to_planar(options, debug=None) → DynamicMesh¶

Apply Simplify to Planar

Parameters

options (GeometryScriptPlanarSimplifyOptions) –
debug (GeometryScriptDebug) –

Return type

apply_simplify_to_polygroup_topology(options, group_layer, debug=None) → DynamicMesh¶

Apply Simplify to Polygroup Topology

Parameters

options (GeometryScriptPolygroupSimplifyOptions) –
group_layer (GeometryScriptGroupLayer) –
debug (GeometryScriptDebug) –

Return type

apply_simplify_to_tolerance(tolerance, options, debug=None) → DynamicMesh¶

Apply Simplify to Tolerance

Parameters

tolerance (float) –
options (GeometryScriptSimplifyMeshOptions) –
debug (GeometryScriptDebug) –

Return type

apply_simplify_to_triangle_count(triangle_count, options, debug=None) → DynamicMesh¶

Apply Simplify to Triangle Count

Parameters

triangle_count (int32) –
options (GeometryScriptSimplifyMeshOptions) –
debug (GeometryScriptDebug) –

Return type

apply_simplify_to_vertex_count(vertex_count, options, debug=None) → DynamicMesh¶

Apply Simplify to Vertex Count

Parameters

vertex_count (int32) –
options (GeometryScriptSimplifyMeshOptions) –
debug (GeometryScriptDebug) –

Return type

apply_triangle_loop_sub_d(subdivisions, debug=None) → DynamicMesh¶

Apply Triangle Loop Sub D

Parameters

subdivisions (int32) –
debug (GeometryScriptDebug) –

Return type

apply_twist_warp_to_mesh(options, twist_orientation, twist_angle=45.000000, twist_extent=50.000000, debug=None) → DynamicMesh¶

Apply Twist Warp to Mesh

Parameters

options (GeometryScriptTwistWarpOptions) –
twist_orientation (Transform) –
twist_angle (float) –
twist_extent (float) –
debug (GeometryScriptDebug) –

Return type

apply_uniform_tessellation(tessellation_level=3, debug=None) → DynamicMesh¶

Apply Uniform Tessellation

Parameters

tessellation_level (int32) –
debug (GeometryScriptDebug) –

Return type

auto_generate_patch_builder_mesh_u_vs(uv_set_index, options, debug=None) → DynamicMesh¶

Auto Generate Patch Builder Mesh UVs

Parameters

uv_set_index (int32) –
options (GeometryScriptPatchBuilderOptions) –
debug (GeometryScriptDebug) –

Return type

auto_generate_x_atlas_mesh_u_vs(uv_set_index, options, debug=None) → DynamicMesh¶

Auto Generate XAtlas Mesh UVs

Parameters

uv_set_index (int32) –
options (GeometryScriptXAtlasOptions) –
debug (GeometryScriptDebug) –

Return type

auto_repair_normals(debug=None) → DynamicMesh¶

Auto Repair Normals

Parameters: debug (GeometryScriptDebug) –
Return type: DynamicMesh

build_bvh_for_mesh(debug=None) -> (DynamicMesh, output_bvh=GeometryScriptDynamicMeshBVH)¶

Build BVHFor Mesh

Parameters: debug (GeometryScriptDebug) –
Returns: output_bvh (GeometryScriptDynamicMeshBVH):
Return type: GeometryScriptDynamicMeshBVH

clear_material_i_ds(clear_value=0, debug=None) → DynamicMesh¶

Clear Material IDs

Parameters

clear_value (int32) –
debug (GeometryScriptDebug) –

Return type

clear_polygroups(group_layer, clear_value=0, debug=None) → DynamicMesh¶

Clear Polygroups

Parameters

group_layer (GeometryScriptGroupLayer) –
clear_value (int32) –
debug (GeometryScriptDebug) –

Return type

compact_material_i_ds(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

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

Array(MaterialInterface)

compact_mesh(debug=None) → DynamicMesh¶

Compact Mesh

Parameters: debug (GeometryScriptDebug) –
Return type: DynamicMesh

compute_mesh_convex_hull(copy_to_mesh, options, debug=None) -> (DynamicMesh, copy_to_mesh=DynamicMesh, copy_to_mesh_out=DynamicMesh)¶

Compute Mesh Convex Hull

Parameters

copy_to_mesh (DynamicMesh) –
options (GeometryScriptConvexHullOptions) –
debug (GeometryScriptDebug) –

Returns

copy_to_mesh (DynamicMesh):

copy_to_mesh_out (DynamicMesh):

Return type

tuple

compute_mesh_swept_hull(copy_to_mesh, projection_frame, options, debug=None) -> (DynamicMesh, copy_to_mesh=DynamicMesh, copy_to_mesh_out=DynamicMesh)¶

Compute Mesh Swept Hull

Parameters

copy_to_mesh (DynamicMesh) –
projection_frame (Transform) –
options (GeometryScriptSweptHullOptions) –
debug (GeometryScriptDebug) –

Returns

copy_to_mesh (DynamicMesh):

copy_to_mesh_out (DynamicMesh):

Return type

tuple

compute_polygroups_from_angle_threshold(group_layer, crease_angle=15.000000, min_group_size=2, debug=None) → DynamicMesh¶

Compute Polygroups from Angle Threshold

Parameters

group_layer (GeometryScriptGroupLayer) –
crease_angle (float) –
min_group_size (int32) –
debug (GeometryScriptDebug) –

Return type

compute_split_normals(split_options, calculate_options, debug=None) → DynamicMesh¶

Compute Split Normals

Parameters

split_options (GeometryScriptSplitNormalsOptions) –
calculate_options (GeometryScriptCalculateNormalsOptions) –
debug (GeometryScriptDebug) –

Return type

compute_tangents(options, debug=None) → DynamicMesh¶

Compute Tangents

Parameters

options (GeometryScriptTangentsOptions) –
debug (GeometryScriptDebug) –

Return type

convert_components_to_polygroups(group_layer, debug=None) → DynamicMesh¶

Convert Components to Polygroups

Parameters

group_layer (GeometryScriptGroupLayer) –
debug (GeometryScriptDebug) –

Return type

convert_uv_islands_to_polygroups(group_layer, uv_layer=0, debug=None) → DynamicMesh¶

Convert UVIslands to Polygroups

Parameters

group_layer (GeometryScriptGroupLayer) –
uv_layer (int32) –
debug (GeometryScriptDebug) –

Return type

copy_mesh_to_mesh(copy_to_mesh, debug=None) -> (DynamicMesh, copy_to_mesh=DynamicMesh, copy_to_mesh_out=DynamicMesh)¶

Copy Mesh to Mesh

Parameters

copy_to_mesh (DynamicMesh) –
debug (GeometryScriptDebug) –

Returns

copy_to_mesh (DynamicMesh):

copy_to_mesh_out (DynamicMesh):

Return type

tuple

copy_polygroups_layer(from_group_layer, to_group_layer, debug=None) → DynamicMesh¶

Copy Polygroups Layer

Parameters

from_group_layer (GeometryScriptGroupLayer) –
to_group_layer (GeometryScriptGroupLayer) –
debug (GeometryScriptDebug) –

Return type

copy_uv_set(from_uv_set, to_uv_set, debug=None) → DynamicMesh¶

Copy UVSet

Parameters

from_uv_set (int32) –
to_uv_set (int32) –
debug (GeometryScriptDebug) –

Return type

delete_triangle_from_mesh(triangle_id, defer_change_notifications=False) -> (DynamicMesh, was_triangle_deleted=bool)¶

Delete Triangle from Mesh

Parameters

triangle_id (int32) –
defer_change_notifications (bool) –

Returns

was_triangle_deleted (bool):

Return type

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

Delete Triangles by Material ID

Parameters

material_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Returns

num_deleted (int32):

Return type

int32

delete_triangles_from_mesh(triangle_list, defer_change_notifications=False) -> (DynamicMesh, num_deleted=int32)¶

Delete Triangles from Mesh

Parameters

triangle_list (GeometryScriptIndexList) –
defer_change_notifications (bool) –

Returns

num_deleted (int32):

Return type

int32

delete_triangles_in_polygroup(group_layer, polygroup_id, defer_change_notifications=False, debug=None) -> (DynamicMesh, num_deleted=int32)¶

Delete Triangles in Polygroup

Parameters

group_layer (GeometryScriptGroupLayer) –
polygroup_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Returns

num_deleted (int32):

Return type

int32

delete_vertex_from_mesh(vertex_id, defer_change_notifications=False) -> (DynamicMesh, was_vertex_deleted=bool)¶

Delete Vertex from Mesh

Parameters

vertex_id (int32) –
defer_change_notifications (bool) –

Returns

was_vertex_deleted (bool):

Return type

delete_vertices_from_mesh(vertex_list, defer_change_notifications=False) -> (DynamicMesh, num_deleted=int32)¶

Delete Vertices from Mesh

Parameters

vertex_list (GeometryScriptIndexList) –
defer_change_notifications (bool) –

Returns

num_deleted (int32):

Return type

int32

discard_mesh_attributes(defer_change_notifications=False) → DynamicMesh¶

Discard Mesh Attributes

Parameters: defer_change_notifications (bool) –
Return type: DynamicMesh

enable_material_i_ds(debug=None) → DynamicMesh¶

Enable Material IDs

Parameters: debug (GeometryScriptDebug) –
Return type: DynamicMesh

enable_polygroups(debug=None) → DynamicMesh¶

Enable Polygroups

Parameters: debug (GeometryScriptDebug) –
Return type: DynamicMesh

fill_all_mesh_holes(fill_options, debug=None) -> (DynamicMesh, num_filled_holes=int32, num_failed_hole_fills=int32)¶

Fill All Mesh Holes

Parameters

fill_options (GeometryScriptFillHolesOptions) –
debug (GeometryScriptDebug) –

Returns

num_filled_holes (int32):

num_failed_hole_fills (int32):

Return type

tuple

find_nearest_point_on_mesh(query_bvh, query_point, options, debug=None) -> (DynamicMesh, nearest_result=GeometryScriptTrianglePoint, outcome=GeometryScriptSearchOutcomePins)¶

Find Nearest Point on Mesh

Parameters

query_bvh (GeometryScriptDynamicMeshBVH) –
query_point (Vector) –
options (GeometryScriptSpatialQueryOptions) –
debug (GeometryScriptDebug) –

Returns

nearest_result (GeometryScriptTrianglePoint):

outcome (GeometryScriptSearchOutcomePins):

Return type

tuple

find_nearest_ray_intersection_with_mesh(query_bvh, ray_origin, ray_direction, options, debug=None) -> (DynamicMesh, hit_result=GeometryScriptRayHitResult, outcome=GeometryScriptSearchOutcomePins)¶

Find Nearest Ray Intersection with Mesh

Parameters

query_bvh (GeometryScriptDynamicMeshBVH) –
ray_origin (Vector) –
ray_direction (Vector) –
options (GeometryScriptSpatialQueryOptions) –
debug (GeometryScriptDebug) –

Returns

hit_result (GeometryScriptRayHitResult):

outcome (GeometryScriptSearchOutcomePins):

Return type

tuple

flip_normals(debug=None) → DynamicMesh¶

Flip Normals

Parameters: debug (GeometryScriptDebug) –
Return type: DynamicMesh

get_all_triangle_i_ds() -> (DynamicMesh, triangle_id_list=GeometryScriptIndexList, has_triangle_id_gaps=bool)¶

Get All Triangle IDs

Returns

triangle_id_list (GeometryScriptIndexList):

has_triangle_id_gaps (bool):

Return type

tuple

get_all_triangle_indices(skip_gaps) -> (DynamicMesh, triangle_list=GeometryScriptTriangleList, has_triangle_id_gaps=bool)¶

Get All Triangle Indices

Parameters

skip_gaps (bool) –

Returns

triangle_list (GeometryScriptTriangleList):

has_triangle_id_gaps (bool):

Return type

tuple

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

Get All Triangle Material IDs

Returns

material_id_list (GeometryScriptIndexList):

has_material_i_ds (bool):

Return type

tuple

get_all_triangle_polygroup_i_ds(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

group_layer (GeometryScriptGroupLayer) –
polygroup_i_ds_out (GeometryScriptIndexList) –

Returns

polygroup_i_ds_out (GeometryScriptIndexList):

Return type

GeometryScriptIndexList

get_all_vertex_i_ds() -> (DynamicMesh, vertex_id_list=GeometryScriptIndexList, has_vertex_id_gaps=bool)¶

Get All Vertex IDs

Returns

vertex_id_list (GeometryScriptIndexList):

has_vertex_id_gaps (bool):

Return type

tuple

get_all_vertex_positions(skip_gaps) -> (DynamicMesh, position_list=GeometryScriptVectorList, has_vertex_id_gaps=bool)¶

Get All Vertex Positions

Parameters

skip_gaps (bool) –

Returns

position_list (GeometryScriptVectorList):

has_vertex_id_gaps (bool):

Return type

tuple

get_has_material_i_ds() → bool¶

Get Has Material IDs

Return type: bool

get_has_polygroups() → bool¶

Get Has Polygroups

Return type: bool

get_has_triangle_id_gaps() → bool¶

Get Has Triangle IDGaps

Return type: bool

get_has_vertex_id_gaps() → bool¶

Get Has Vertex IDGaps

Return type: bool

get_is_closed_mesh() → bool¶

Get Is Closed Mesh

Return type: bool

get_is_dense_mesh() → bool¶

Get Is Dense Mesh

Return type: bool

get_max_material_id() -> (int32, has_material_i_ds=bool)¶

Get Max Material ID

Returns: has_material_i_ds (bool):
Return type: bool

get_mesh_bounding_box() → Box¶

Get Mesh Bounding Box

Return type: Box

get_mesh_has_attribute_set() → bool¶

Get Mesh Has Attribute Set

Return type: bool

get_mesh_volume_area() -> (surface_area=float, volume=float)¶

Get Mesh Volume Area

Returns

surface_area (float):

volume (float):

Return type

tuple

get_num_connected_components() → int32¶

Get Num Connected Components

Return type: int32

get_num_extended_polygroup_layers() → int32¶

Get Num Extended Polygroup Layers

Return type: int32

get_num_open_border_edges() → int32¶

Get Num Open Border Edges

Return type: int32

get_num_open_border_loops() -> (int32, ambiguous_topology_found=bool)¶

Get Num Open Border Loops

Returns: ambiguous_topology_found (bool):
Return type: bool

get_num_triangle_i_ds() → int32¶

UDynamicMesh already has this function UFUNCTION(BlueprintPure, Category = “GeometryScript|MeshQueries”, meta=(ScriptMethod)) static UPARAM(DisplayName = “Triangle Count”) int32 GetTriangleCount( UDynamicMesh* TargetMesh );

Return type: int32

get_num_uv_sets() → int32¶

Get Num UVSets

Return type: int32

get_num_vertex_i_ds() → int32¶

Get Num Vertex IDs

Return type: int32

get_polygroup_i_ds_in_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

group_layer (GeometryScriptGroupLayer) –
polygroup_i_ds_out (GeometryScriptIndexList) –

Returns

polygroup_i_ds_out (GeometryScriptIndexList):

Return type

GeometryScriptIndexList

get_sub_mesh_from_mesh(store_to_submesh, triangle_list, debug=None) -> (DynamicMesh, store_to_submesh=DynamicMesh, store_to_submesh_out=DynamicMesh)¶

Get Sub Mesh from Mesh

Parameters

store_to_submesh (DynamicMesh) –
triangle_list (GeometryScriptIndexList) –
debug (GeometryScriptDebug) –

Returns

store_to_submesh (DynamicMesh):

store_to_submesh_out (DynamicMesh):

Return type

tuple

get_triangle_count() → int32¶

Returns: number of triangles in the mesh
Return type: int32

get_triangle_face_normal(triangle_id) -> (Vector, is_valid_triangle=bool)¶

Get Triangle Face Normal

Parameters: triangle_id (int32) –
Returns: is_valid_triangle (bool):
Return type: bool

get_triangle_indices(triangle_id) -> (IntVector, is_valid_triangle=bool)¶

Get Triangle Indices

Parameters: triangle_id (int32) –
Returns: is_valid_triangle (bool):
Return type: bool

get_triangle_material_id(triangle_id) -> (int32, is_valid_triangle=bool)¶

Get Triangle Material ID

Parameters: triangle_id (int32) –
Returns: is_valid_triangle (bool):
Return type: bool

get_triangle_polygroup_id(group_layer, triangle_id) -> (int32, is_valid_triangle=bool)¶

Get Triangle Polygroup ID

Parameters

group_layer (GeometryScriptGroupLayer) –
triangle_id (int32) –

Returns

is_valid_triangle (bool):

Return type

get_triangle_positions(triangle_id) -> (is_valid_triangle=bool, vertex1=Vector, vertex2=Vector, vertex3=Vector)¶

Get Triangle Positions

Parameters

triangle_id (int32) –

Returns

is_valid_triangle (bool):

vertex1 (Vector):

vertex2 (Vector):

vertex3 (Vector):

Return type

tuple

get_triangle_u_vs(uv_set_index, triangle_id) -> (uv1=Vector2D, uv2=Vector2D, uv3=Vector2D, have_valid_u_vs=bool)¶

Get Triangle UVs

Parameters

uv_set_index (int32) –
triangle_id (int32) –

Returns

uv1 (Vector2D):

uv2 (Vector2D):

uv3 (Vector2D):

have_valid_u_vs (bool):

Return type

tuple

get_triangles_in_polygroup(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

group_layer (GeometryScriptGroupLayer) –
polygroup_id (int32) –
triangle_i_ds_out (GeometryScriptIndexList) –

Returns

triangle_i_ds_out (GeometryScriptIndexList):

Return type

GeometryScriptIndexList

get_uv_set_bounding_box(uv_set_index) -> (Box2D, is_valid_uv_set=bool, uv_set_is_empty=bool)¶

Get UVSet Bounding Box

Parameters

uv_set_index (int32) –

Returns

is_valid_uv_set (bool):

uv_set_is_empty (bool):

Return type

tuple

get_vertex_count() → int32¶

Get Vertex Count

Return type: int32

get_vertex_position(vertex_id) -> (Vector, is_valid_vertex=bool)¶

Get Vertex Position

Parameters: vertex_id (int32) –
Returns: is_valid_vertex (bool):
Return type: bool

is_bvh_valid_for_mesh(test_bvh, debug=None) -> (DynamicMesh, is_valid=bool)¶

Is BVHValid for Mesh

Parameters

test_bvh (GeometryScriptDynamicMeshBVH) –
debug (GeometryScriptDebug) –

Returns

is_valid (bool):

Return type

is_empty() → bool¶

Returns: true if the mesh has no triangles
Return type: bool

is_intersecting_mesh(target_transform, other_mesh, other_transform, debug=None) -> (DynamicMesh, is_intersecting=bool)¶

Is Intersecting Mesh

Parameters

target_transform (Transform) –
other_mesh (DynamicMesh) –
other_transform (Transform) –
debug (GeometryScriptDebug) –

Returns

is_intersecting (bool):

Return type

is_point_inside_mesh(query_bvh, query_point, options, debug=None) -> (DynamicMesh, is_inside=bool, outcome=GeometryScriptContainmentOutcomePins)¶

Is Point Inside Mesh

Parameters

query_bvh (GeometryScriptDynamicMeshBVH) –
query_point (Vector) –
options (GeometryScriptSpatialQueryOptions) –
debug (GeometryScriptDebug) –

Returns

is_inside (bool):

outcome (GeometryScriptContainmentOutcomePins):

Return type

tuple

is_same_mesh_as(other_mesh, options, debug=None) -> (DynamicMesh, is_same_mesh=bool)¶

Is Same Mesh As

Parameters

other_mesh (DynamicMesh) –
options (GeometryScriptIsSameMeshOptions) –
debug (GeometryScriptDebug) –

Returns

is_same_mesh (bool):

Return type

is_valid_triangle_id(triangle_id) → bool¶

Is Valid Triangle ID

Parameters: triangle_id (int32) –
Return type: bool

is_valid_vertex_id(vertex_id) → bool¶

Is Valid Vertex ID

Parameters: vertex_id (int32) –
Return type: bool

measure_distances_between_meshes(other_mesh, options, debug=None) -> (DynamicMesh, max_distance=double, min_distance=double, average_distance=double, root_mean_sqr_deviation=double)¶

Measure Distances Between Meshes

Parameters

other_mesh (DynamicMesh) –
options (GeometryScriptMeasureMeshDistanceOptions) –
debug (GeometryScriptDebug) –

Returns

max_distance (double):

min_distance (double):

average_distance (double):

root_mean_sqr_deviation (double):

Return type

tuple

property mesh_modified_bp_event¶

[Read-Write] Mesh Modified BPEvent: Blueprintable event called when mesh is modified, in the same cases as OnMeshChanged

Type: (OnDynamicMeshModifiedBP)

rebuild_bvh_for_mesh(update_bvh, only_if_invalid=True, debug=None) -> (DynamicMesh, update_bvh=GeometryScriptDynamicMeshBVH)¶

Rebuild BVHFor Mesh

Parameters

update_bvh (GeometryScriptDynamicMeshBVH) –
only_if_invalid (bool) –
debug (GeometryScriptDebug) –

Returns

update_bvh (GeometryScriptDynamicMeshBVH):

Return type

GeometryScriptDynamicMeshBVH

recompute_mesh_u_vs(uv_set_index, options, debug=None) → DynamicMesh¶

Recompute Mesh UVs

Parameters

uv_set_index (int32) –
options (GeometryScriptRecomputeUVsOptions) –
debug (GeometryScriptDebug) –

Return type

recompute_normals(calculate_options, debug=None) → DynamicMesh¶

Recompute Normals

Parameters

calculate_options (GeometryScriptCalculateNormalsOptions) –
debug (GeometryScriptDebug) –

Return type

remap_material_i_ds(from_material_id, to_material_id, debug=None) → DynamicMesh¶

Remap Material IDs

Parameters

from_material_id (int32) –
to_material_id (int32) –
debug (GeometryScriptDebug) –

Return type

remove_hidden_triangles(options, debug=None) → DynamicMesh¶

Remove Hidden Triangles

Parameters

options (GeometryScriptRemoveHiddenTrianglesOptions) –
debug (GeometryScriptDebug) –

Return type

remove_small_components(options, debug=None) → DynamicMesh¶

Remove Small Components

Parameters

options (GeometryScriptRemoveSmallComponentOptions) –
debug (GeometryScriptDebug) –

Return type

repack_mesh_u_vs(uv_set_index, repack_options, debug=None) → DynamicMesh¶

Repack Mesh UVs

Parameters

uv_set_index (int32) –
repack_options (GeometryScriptRepackUVsOptions) –
debug (GeometryScriptDebug) –

Return type

reset() → DynamicMesh¶

Clear the internal mesh to an empty mesh. This does not allocate a new mesh, so any existing mesh pointers/refs are still valid

Return type: DynamicMesh

reset_to_cube() → DynamicMesh¶

Clear the internal mesh to a 100x100x100 cube with base at the origin. This this instead of Reset() if an initially-empty mesh is undesirable (eg for a Component)

Return type: DynamicMesh

rotate_mesh_u_vs(uv_set_index, rotation_angle, rotation_origin, debug=None) → DynamicMesh¶

Rotate Mesh UVs

Parameters

uv_set_index (int32) –
rotation_angle (float) –
rotation_origin (Vector2D) –
debug (GeometryScriptDebug) –

Return type

scale_mesh(scale=[1.000000, 1.000000, 1.000000], debug=None) → DynamicMesh¶

Scale Mesh

Parameters

scale (Vector) –
debug (GeometryScriptDebug) –

Return type

scale_mesh_u_vs(uv_set_index, scale, scale_origin, debug=None) → DynamicMesh¶

Scale Mesh UVs

Parameters

uv_set_index (int32) –
scale (Vector2D) –
scale_origin (Vector2D) –
debug (GeometryScriptDebug) –

Return type

set_all_triangle_material_i_ds(defer_change_notifications=False, debug=None) -> (DynamicMesh, triangle_material_id_list=GeometryScriptIndexList)¶

Set All Triangle Material IDs

Parameters

defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Returns

triangle_material_id_list (GeometryScriptIndexList):

Return type

GeometryScriptIndexList

set_mesh_constant_vertex_color(color, flags, clear_existing=False, debug=None) → DynamicMesh¶

Set Mesh Constant Vertex Color

Parameters

color (LinearColor) –
flags (GeometryScriptColorFlags) –
clear_existing (bool) –
debug (GeometryScriptDebug) –

Return type

set_mesh_per_vertex_colors(vertex_color_list, debug=None) → DynamicMesh¶

Set Mesh Per Vertex Colors

Parameters

vertex_color_list (GeometryScriptColorList) –
debug (GeometryScriptDebug) –

Return type

set_mesh_triangle_normals(triangle_id, normals, defer_change_notifications=False) -> (DynamicMesh, is_valid_triangle=bool)¶

Set Mesh Triangle Normals

Parameters

triangle_id (int32) –
normals (GeometryScriptTriangle) –
defer_change_notifications (bool) –

Returns

is_valid_triangle (bool):

Return type

set_mesh_triangle_u_vs(uv_set_index, triangle_id, u_vs, defer_change_notifications=False) -> (DynamicMesh, is_valid_triangle=bool)¶

Set Mesh Triangle UVs

Parameters

uv_set_index (int32) –
triangle_id (int32) –
u_vs (GeometryScriptUVTriangle) –
defer_change_notifications (bool) –

Returns

is_valid_triangle (bool):

Return type

set_mesh_u_vs_from_box_projection(uv_set_index, box_transform, min_island_tri_count=2, debug=None) → DynamicMesh¶

Set Mesh UVs from Box Projection

Parameters

uv_set_index (int32) –
box_transform (Transform) –
min_island_tri_count (int32) –
debug (GeometryScriptDebug) –

Return type

set_mesh_u_vs_from_cylinder_projection(uv_set_index, cylinder_transform, split_angle=45.000000, debug=None) → DynamicMesh¶

Set Mesh UVs from Cylinder Projection

Parameters

uv_set_index (int32) –
cylinder_transform (Transform) –
split_angle (float) –
debug (GeometryScriptDebug) –

Return type

set_mesh_u_vs_from_planar_projection(uv_set_index, plane_transform, debug=None) → DynamicMesh¶

Scale of PlaneTransform defines world-space dimension that maps to 1 UV dimension

Parameters

uv_set_index (int32) –
plane_transform (Transform) –
debug (GeometryScriptDebug) –

Return type

set_num_extended_polygroup_layers(num_layers, debug=None) → DynamicMesh¶

Set Num Extended Polygroup Layers

Parameters

num_layers (int32) –
debug (GeometryScriptDebug) –

Return type

set_num_uv_sets(num_uv_sets, debug=None) → DynamicMesh¶

Set Num UVSets

Parameters

num_uv_sets (int32) –
debug (GeometryScriptDebug) –

Return type

set_per_face_normals(debug=None) → DynamicMesh¶

Set Per Face Normals

Parameters: debug (GeometryScriptDebug) –
Return type: DynamicMesh

set_per_vertex_normals(debug=None) → DynamicMesh¶

Set Per Vertex Normals

Parameters: debug (GeometryScriptDebug) –
Return type: DynamicMesh

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

Set Polygroup Material ID

Parameters

group_layer (GeometryScriptGroupLayer) –
polygroup_id (int32) –
material_id (int32) –
defer_change_notifications (bool) –
debug (GeometryScriptDebug) –

Returns

is_valid_polygroup_id (bool):

Return type

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

Set Triangle Material ID

Parameters

triangle_id (int32) –
material_id (int32) –
defer_change_notifications (bool) –

Returns

is_valid_triangle (bool):

Return type

set_vertex_position(vertex_id, new_position, defer_change_notifications=False) -> (DynamicMesh, is_valid_vertex=bool)¶

Set Vertex Position

Parameters

vertex_id (int32) –
new_position (Vector) –
defer_change_notifications (bool) –

Returns

is_valid_vertex (bool):

Return type

split_mesh_by_components(mesh_pool, debug=None) -> (DynamicMesh, component_meshes=Array(DynamicMesh))¶

Split Mesh by Components

Parameters

mesh_pool (DynamicMeshPool) –
debug (GeometryScriptDebug) –

Returns

component_meshes (Array(DynamicMesh)):

Return type

Array(DynamicMesh)

split_mesh_by_material_i_ds(mesh_pool, debug=None) -> (DynamicMesh, component_meshes=Array(DynamicMesh), component_material_i_ds=Array(int32))¶

Split Mesh by Material IDs

Parameters

mesh_pool (DynamicMeshPool) –
debug (GeometryScriptDebug) –

Returns

component_meshes (Array(DynamicMesh)):

component_material_i_ds (Array(int32)):

Return type

tuple

split_mesh_by_polygroups(group_layer, mesh_pool, debug=None) -> (DynamicMesh, component_meshes=Array(DynamicMesh), component_polygroups=Array(int32))¶

Split Mesh by Polygroups

Parameters

group_layer (GeometryScriptGroupLayer) –
mesh_pool (DynamicMeshPool) –
debug (GeometryScriptDebug) –

Returns

component_meshes (Array(DynamicMesh)):

component_polygroups (Array(int32)):

Return type

tuple

transform_mesh(transform, debug=None) → DynamicMesh¶

Transform Mesh

Parameters

transform (Transform) –
debug (GeometryScriptDebug) –

Return type

translate_mesh(translation, debug=None) → DynamicMesh¶

Translate Mesh

Parameters

translation (Vector) –
debug (GeometryScriptDebug) –

Return type

translate_mesh_u_vs(uv_set_index, translation, debug=None) → DynamicMesh¶

Translate Mesh UVs

Parameters

uv_set_index (int32) –
translation (Vector2D) –
debug (GeometryScriptDebug) –

Return type

weld_mesh_edges(weld_options, debug=None) → DynamicMesh¶

Weld Mesh Edges

Parameters

weld_options (GeometryScriptWeldEdgesOptions) –
debug (GeometryScriptDebug) –

Return type