mmSolver.tools.surfacecluster#

Surface Cluster tool.

Tools#

Create (and Edit) Surface Clusters.

Surface Clusters can be used to deform a surface, starting from the surface position and orientation.

mmSolver.tools.surfacecluster.tool.create_single_surface_cluster()#

Create a Surface Cluster on the selected Mesh component.

Usage: 1) Select 1 or more components (vertices, edges, faces, etc). 2) Run this tool.

  • create a single surface cluster at the average position of all selected components.

  • (Optionally) Use current Soft Selection as default weighting - the same as the “update_weights_with_soft_selection” tool.

Returns:

None or a SurfaceCluster object with the nodes making up the setup.

Return type:

SurfaceCluster or None

mmSolver.tools.surfacecluster.tool.create_multiple_surface_clusters()#

Create multiple surface clusters, one for each component selected.

Usage: 1) Select 1 or more components (vertices, edges, faces, etc). 2) Run this tool.

  • For each component, create a surface cluster is created.

Returns:

A list of SurfaceCluster objects with the nodes making up the setup. The list may be empty.

Return type:

[SurfaceCluster, ..] or []

mmSolver.tools.surfacecluster.tool.update_weights_with_soft_selection()#

Update the cluster deformer weights using the current component soft-selection.

Usage: 1) Enable Soft Selection. 2) Select 1 or more components (vertices, edges, faces, etc). 3) Select surface cluster control. 4) Run this tool.

  • The weights of the surface cluster are updated with the soft selection.

Return type:

None

mmSolver.tools.surfacecluster.tool.open_paint_weights_tool()#

Open the paint weights tool for the selected surface cluster.

Usage: 1) Select a surface cluster control. 2) Run tool.

  • The paint weights tool is opened.

  1. User paints weights.

Return type:

None

mmSolver.tools.surfacecluster.tool.main()#

Create surface clusters using the values defined in the UI.

Use open_window() function to open the UI to edit the values as needed.

Return type:

None

mmSolver.tools.surfacecluster.tool.open_window()#

Open the Surface Cluster UI.

Return type:

None

Library#

Functions to create and edit Surface Clusters.

mmSolver.tools.surfacecluster.lib.paint_cluster_weights_on_mesh(mesh_tfm, cluster_shp)#

Opens the Paint Editor on a mesh node to allow user painting of weights.

class mmSolver.tools.surfacecluster.lib.SurfaceCluster(control_transform, mesh_transform, mesh_shape, cluster_deformer_node)#
property cluster_deformer_node#

Alias for field number 3

property control_transform#

Alias for field number 0

property mesh_shape#

Alias for field number 2

property mesh_transform#

Alias for field number 1

mmSolver.tools.surfacecluster.lib.get_surface_cluster_from_control_transform(control_tfm)#
mmSolver.tools.surfacecluster.lib.create_surface_cluster_on_mesh_and_component(mesh_tfm, mesh_shp, component, uv_coordinate)#

Create a Surface Cluster on a mesh component (face, edge or vertex), positioned at a UV coordinate on the mesh_shp.

Return type:

None or SurfaceCluster

mmSolver.tools.surfacecluster.lib.set_cluster_deformer_weights(cluster_shp, mesh_shp, weights)#
mmSolver.tools.surfacecluster.lib.create_surface_cluster_on_component(component)#

Create a Surface Cluster on a mesh component (face, edge or vertex).

Return type:

None or SurfaceCluster

UI - Layout#

UI - Window#

Constants#

Surface Cluster constants.