unreal.GeometryScript_MeshSculptLayers

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

Bases: BlueprintFunctionLibrary

Geometry Script Library Mesh Sculpt Layers Functions

C++ Source:

  • Plugin: GeometryScripting

  • Module: GeometryScriptingCore

  • File: MeshSculptLayersFunctions.h

classmethod discard_sculpt_layers(target_mesh, debug=None) → DynamicMesh

Discard all sculpt layer data, leaving current vertex positions unchanged

Parameters:
Return type:

DynamicMesh

classmethod enable_sculpt_layers(target_mesh, num_layers, debug=None) → DynamicMesh

Enable Sculpt Layers on the Target Mesh, if not already enabled, with at least the requested number of layers. Note: Will never decrease the number of enabled layers.

Parameters:

  • target_mesh (DynamicMesh)

  • num_layers (int32) – The amount of layers that must be enabled on the mesh. Note: If this many layers (or more) are already enabled, the mesh will not be changed.

  • debug (GeometryScriptDebug)

Return type:

DynamicMesh

classmethod get_active_sculpt_layer(target_mesh) → int32

Get the current sculpting layers active on the mesh, or -1 if the mesh does not have sculpting layers

Parameters:

target_mesh (DynamicMesh)

Return type:

int32

classmethod get_num_sculpt_layers(target_mesh) → int32

Get the number of sculpting layers active on the mesh

Parameters:

target_mesh (DynamicMesh)

Return type:

int32

classmethod get_sculpt_layer_weights_array(target_mesh) → Array[double]

Get the weights of all sculpt layers on the mesh

Parameters:

target_mesh (DynamicMesh)

Return type:

Array[double]

classmethod merge_sculpt_layers(target_mesh, merge_layer_start, merge_layer_num, use_weights=True, debug=None) -> (DynamicMesh, out_active_layer=int32)

Merge a range of sculpt layers together. May change the Active Sculpt Layer.

Parameters:

  • target_mesh (DynamicMesh)

  • merge_layer_start (int32) – The first layer to merge

  • merge_layer_num (int32) – The number of layers to merge. Note: If larger than the number of existing layers after MergeLayerStart, will be clamped as needed.

  • use_weights (bool) – If true, layers will be merged based on their current weights – keeping the mesh shape unchanged. Otherwise, layers will be merged with weight 1, which may change the shape of the mesh.

  • debug (GeometryScriptDebug)

Returns:

out_active_layer (int32): The active layer after layers have been merged.

Return type:

int32

classmethod set_active_sculpt_layer(target_mesh, layer_index, debug=None) → DynamicMesh

Set the requested LayerIndex as the current active sculpt layer, if possible.

Parameters:
Return type:

DynamicMesh

classmethod set_sculpt_layer_weight(target_mesh, layer_index, weight, options=[True], debug=None) → DynamicMesh

Set the weight of the layer at LayerIndex to the requested Weight

Parameters:
Return type:

DynamicMesh

classmethod set_sculpt_layer_weights_array(target_mesh, weights, options=[True], debug=None) → DynamicMesh

Set the weights of multiple layers to match the given Weights array. Note: If the Weights array length is larger than the number of layers, will just set the weights of the existing layers. Will not add or remove layers.

Parameters:
Return type:

DynamicMesh