Rename v2

In: Substance Model graph/Scene Management

Simple

Description

The Rename node lets you rename one or more Elements in a Scene.

The name of Elements can be used for filtering purposes, such as limiting the effect of a node to specific Elements. Go to the Path expressions and filtering page to learn more.

Parameters

  • Input Scene
    The input Scene holding the Element which should be renamed.
  • Renaming action Integer
    The renaming operation to execute:
    • Replace all: replace the entire current name.
    • Search and replace: replace only a part of the current name.
    • Insert: insert a string at a specific position in the current name.
  • Source branch or entity to rename String
    The full path of the item which should be renamed – i.e., the groups should be included if the source Element is under any. Go to the Path expressions and filtering page to learn more.
  • Rename to String
    The new name of the Element. Each Element is always renamed in place, thus it is not necessary to include groups – i.e. the node cannot be used to move items in or out of groups.
  • Target string to replace String
    The part of any Element's name which should be replaced.
    Note: This parameter is only available when the Renaming action parameter is set to Search and replace.
  • insertPosID Integer
    The position where to insert the given string. The position is a number representing the index of the character in a string.
    Note: This parameter is only available when the Renaming action parameter is set to Insert.
  • Insert string String
    The string to insert into the Element's name.
    Note: This parameter is only available when the Renaming action parameter is set to Insert.
  • Enumeration Boolean
    Enable the enumeration, which appends an incrementing number to the name of each Element which has been renamed.
  • Starting at Integer
    The starting number of the enumeration.
    Note: This parameter is only available when the Enumeration parameter is set to True
  • Minimum digits Integer
    The minimum number of digits for the enumeration – e.g., a value of 3 will produce the following enumeration: 001, 002, 003, ...
    Note: This parameter is only available when the Enumeration parameter is set to True
  • Insert Enumeration before suffix Boolean
    When True, the enumeration is inserted before the suffix.
    Note: This parameter is only available when the Enumeration parameter is set to True
  • Prefix String
    A string which should be added at the beginning of each Element's name.
  • Suffix String
    A string which should be appended at the end of each Element's name. If the Enumeration parameter is set to True, the position of the enumeration relatively to the suffix is determined by the Insert Enumeration before suffix parameter.

Example Images