componentTag

Go to: Synopsis. Return value. Related. Flags. MEL examples.

Synopsis

componentTag [-create] [-delete] [-injectionLocation string] [-modify string] [-newTagName string] [-queryEdit] [-rename] [-tagName string] [-uniqueTagName] [objects]

componentTag is undoable, NOT queryable, and NOT editable.

Return value

Related

Flags

Long name (short name)	Argument types	Properties
-create(-cr)
This creates a componentTag on the geometry. The name can be specified with the -newTagName option. If no new name is specified one will be generated. The name of the created tag is returned
-delete(-d)
This deletes the componentTags specified with the -tagName option.
-injectionLocation(-il)	string
The name of the injection node at which the componentTag will be edited. This is only necessary in the rare case where a particular componentTag can be altered at multiple injection locations.
-modify(-m)	string
This modifies the componentTag specified with the -tagName option. The mode determines whether components are, replaced, cleared, added or removed.
-newTagName(-ntn)	string
The name of the new componentTag to be created or the new name of the componentTag that is being renamed.
-queryEdit(-qe)
This returns what edits are allowed with the given parameters. When the command is issued in Python a dictionary object containing what is allowed is returned.
-rename(-rn)
This renames the componentTag specified with the -tagName option to the name specified with the -newTagName option
-tagName(-tn)	string
The name(s) of the componentTags to be edited. This can be a single name or a list of names. The names can contain wildcard like '*' to match multiple existing componentTags.
-uniqueTagName(-utn) 2024.2
This flag is used along the create and newTagName flags. It makes the command generate a unique tag name if the name provided by newTagName is already used by a tag on the injectionNode or its parents.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

    // Make a geometry
    file -f -new;
    polyCylinder -r 3 -h 8 -sx 6 -sy 9 -sz 1 -ax 0 1 0 -rcp 0 -cuv 3 -ch 1 -name "cyl";

    // Create some tags
    componentTag -cr -ntn "bottomSection" cyl.f[0:17];
    componentTag -cr -ntn "topSection" cyl.f[36:53];

    // Edit a tag
    componentTag -m "add" -tn "bottomSection" cyl.f[18:35];

    // Rename the tag
    componentTag -rn  -tn "bottomSection" -ntn "lowerSection" cyl;

    // Delete tags (using a wild card)
    componentTag -d -tn "*Section" cyl;