mmSolver.tools.markerbundlerename#

Tools#

This tool renames selected markers and bundles (and the connected nodes).

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

Renames selected markers and bundles (and the connected nodes).

Library#

This file holds all the helpful functions for markerbundlerename

mmSolver.tools.markerbundlerename.lib.prompt_for_new_node_name(title, message, text)#

Ask the user for a new node name.

Parameters:

  • title (str) – Dialog box window title.

  • message (str) – Read-only text to show the user, for making a decision.

  • text (str) – The initial text to prompt the user as a starting point.

Returns:

New node name, or None if user cancelled.

Return type:

str or None

mmSolver.tools.markerbundlerename.lib.rename_markers_and_bundles(mkr_nodes, bnd_nodes, mkr_name, bnd_name, number_format, mkr_suffix, bnd_suffix)#

Rename the given marker and bundle nodes.

Parameters:

  • mkr_nodes ([str, ..]) – Marker nodes to rename.

  • bnd_nodes ([str, ..]) – Bundle nodes to rename.

  • mkr_name (str) – Rename the markers to this name.

  • bnd_name (str) – Rename the bundle to this name.

  • number_format (str) – The name format string for numbering.

  • mkr_suffix (str) – Set the marker suffix name.

  • bnd_suffix (str) – Set the bundle suffix name.

Returns:

Nodes that have been renamed.

Return type:

[str, ..]

Constants#

This file holds all the constants for markerbundlerename tool.