character is undoable, queryable, and editable.
This command is used to manage the membership of a character. Characters
are a type of set that gathers together the attributes of a node or nodes
that a user wishes to animate as a single entity.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
|
-addElement(-add)
|
name
|
|
|
Adds the list of items to the given character. If some of the
items cannot be added to the character because they are in another
character, the command will fail. When another character is passed to
to -addElement, is is added as a sub character. When a node is
passed in, it is expanded into its keyable attributes, which are
then added to the character.
|
|
-addOffsetObject(-aoo)
|
string
|
|
|
Indicates that the selected character member objects should be used when
calculating and applying offsets. The flag argument is used to specify the
character.
|
|
-anyMember(-am)
|
name
|
|
|
An operation which tests whether any of the given items
are members of the given set.
|
|
-characterPlug(-cp)
|
|
|
|
Returns the plug on the character that corresponds to the
specified character member.
|
|
-clear(-cl)
|
name
|
|
|
An operation which removes all items from the given character.
|
|
-empty(-em)
|
|
|
|
Indicates that the character to be created should be empty. (i.e.
it ignores any arguments identifying objects to be added to
the character.
|
|
-excludeDynamic(-ed)
|
|
|
|
When creating the character, exclude dynamic attributes.
|
|
-excludeRotate(-er)
|
|
|
|
When creating the character, exclude rotate attributes from
transform-type nodes.
|
|
-excludeScale(-es)
|
|
|
|
When creating the character, exclude scale attributes from
transform-type nodes.
|
|
-excludeTranslate(-et)
|
|
|
|
When creating the character, exclude translate attributes from
transform-type nodes. For example, if your character contains
joints only, perhaps you only want to include rotations in the
character.
|
|
-excludeVisibility(-ev)
|
|
|
|
When creating the character, exclude visibility attribute from
transform-type nodes.
|
|
-flatten(-fl)
|
name
|
|
|
An operation that flattens the structure of the given character. That is,
any characters contained by the given character will be replaced by its
members so that the character no longer contains other characters but contains
the other characters' members.
|
|
-forceElement(-fe)
|
name
|
|
|
For use in edit mode only. Forces addition of the items
to the character. If the items are in another character which
is in the character partition, the items will be removed
from the other character in order to keep the characters in the
character partition mutually exclusive with respect to membership.
|
|
-include(-in)
|
name
|
|
|
Adds the list of items to the given character. If some of the
items cannot be added to the character, a warning will be issued.
This is a less strict version of the -add/addElement operation.
|
|
-intersection(-int)
|
name
|
|
|
An operation that returns a list of items which are members of
all the character in the list. In general, characters should be
mutually exclusive.
|
|
-isIntersecting(-ii)
|
name
|
|
|
An operation which tests whether or not the characters in the list have
common members. In general, characters should be mutually exclusive, so
this should always return false.
|
|
-isMember(-im)
|
name
|
|
|
An operation which tests whether or not all the given items
are members of the given character.
|
|
-library(-lib)
|
|
|
|
Returns the clip library associated with this character, if there is one. A clip library will only exist if you have created clips on your character.
|
|
-memberIndex(-mi)
|
uint
|
|
|
Returns the memberIndex of the specified character member if used after the query flag. Or if used before the query flag, returns the member that corresponds to the specified index.
|
|
-name(-n)
|
string
|
|
|
Assigns string as the name for a new character. Valid for operations that
create a new character.
|
|
-noWarnings(-nw)
|
|
|
|
Indicates that warning messages should not be reported such
as when trying to add an invalid item to a character. (used by UI)
|
|
-nodesOnly(-no)
|
|
|
|
This flag modifies the results of character membership queries.
When listing the attributes (e.g. sphere1.tx) contained in the
character, list only the nodes. Each node will only be listed
once, even if more than one attribute or component of the node
exists in the character.
|
|
-offsetNode(-ofs)
|
|
|
|
Returns the name of the characterOffset node used to add offsets to the root of the character.
|
|
-remove(-rm)
|
name
|
|
|
Removes the list of items from the given character.
|
|
-removeOffsetObject(-roo)
|
string
|
|
|
Indicates that the selected character offset objects should be removed
as offsets. The flag argument is used to specify the character.
|
|
-root(-rt)
|
string
|
|
|
Specifies the transform node which will act as the root of the character being created.
This creates a characterOffset node in addition to the character node, which can be used to add offsets
to the character to change the direction of the character's animtion without inserting additional nodes
in its hierarchy.
|
|
-scheduler(-sc)
|
|
|
|
Returns the scheduler associated with this character, if there is one. A scheduler will only exist if you have created clips on your character.
|
|
-split(-sp)
|
name
|
|
|
Produces a new set with the list of items and removes
each item in the list of items from the given set.
|
|
-subtract(-sub)
|
name
|
|
|
An operation between two characters which returns the members of the
first character that are not in the second character. In general,
characters should be mutually exclusive.
|
|
-text(-t)
|
string
|
|
|
Defines an annotation string to be stored with the character.
|
|
-union(-un)
|
name
|
|
|
An operation that returns a list of all the members of all characters
listed.
|
|
-userAlias(-ua)
|
name
|
|
|
Returns the user defined alias for the given attribute on
the character or and empty string if there is not one. Characters
automatically alias the attributes where character animation data
is stored. A user alias will exist when the automatic aliases are
overridden using the aliasAttr command.
|
|