sgm_renumber | (renum_option, entity_type, new_selection, original_selection, created_selection) |
Description: | ||
This function will renumber a selection of point, curve, surface, solid, plane, or vector identifiers in either a consecutive manner beginning with a starting point, curve, surface, solid, plane, or vector identifier or as directed by a selection of point,curve, surface, solid, plane, or vector identifiers. | ||
Input: | ||
INTEGER | renum_option | This value specifies the option for processing the new_selection where: 1 = Starting ID(s) 2 = Offset ID |
STRING | entity_type | This value specifies which geometric entity type to renumber. Valid values include: point curve surface solid plane vector |
STRING | new_selection[] | This value specifies a selection of point, curve, surface, solid, plane, or vector identifiers to which the original points, curves, surfaces, solids, planes, or vectors will be renumbered. If there is only one identifier in the selection the original identifiers will be renumbered in a consecutive manner. If more than one identifier is provided, the identifiers in the input value original_selection will be renumbered to match the identifiers specified by this input value. |
STRING | original_selection[] | This value specifies a selection of point, curve, surface, solid, plane, or vector identifiers that will be renumbered. |
Output: | ||
STRING | created_selection[VIRTUAL] | This value returns a description of the renumbered point, curve, surface, or solid identifiers. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |