pymel.core.animation.clipSchedule

clipSchedule(*args, **kwargs)

This command is used to create, edit and query clips and blends in the Trax editor. It operates on the clipScheduler node attached to the character. In query mode, if no flags are specified, returns an array of strings in this form: (clipName,clipIndex,clipStart,clipSourceStart,clipSourceEnd,clipScale,clipPreCycle,clipPostCycle,clipHold)

Flags:

• absolute : abs (bool) [query,edit]

  This flag is now deprecated. Use aa/allAbsolute, ar/allRelative, ra/rotationsAbsolute, or da/defaultAbsolute instead. This flag controls whether the clip follows its keyframe values or whether they are offset by a value to maintain a smooth path.

• absoluteRotations : abr (bool) [query,edit]

  This flag is now deprecated. Use aa/allAbsolute, ar/allRelative, ra/rotationsAbsolute, or da/defaultAbsolute instead. If true, this overrides the abs/absolute flag so that rotation channels are always calculated with absolute offsets. This allows you to have absolute offsets on rotations and relative offsets on all other channels.

• allAbsolute : aa (bool) [edit]

  Set all channels to be calculated with absolute offsets. This flag cannot be used in conjunction with the ar/allRelative, ra/rotationsAbsolute or da/defaultAbsolute flags.

• allRelative : ar (bool) [edit]

  Set all channels to be calculated with relative offsets. This flag cannot be used in conjunction with the aa/allAbsolute, ra/rotationsAbsolute or da/defaultAbsolute flags.

• blend : b (int, int) [create,query]

  This flag is used to blend two clips, whose indices are provided as flag arguments.

• blendNode : bn (int, int) [query]

  This query only flag list all of the blend nodes associated with the blend defined by the two clip indices. This flag returns a string array. In query mode, this flag can accept a value.

• blendUsingNode : bun (unicode) [create]

  This flag is used if you want to blend using an existing blend node. It is used in conjunction with the blend flag. The blend flag specifies the clip indices for the blend. The name of an existing animBlend node should be supplied supplied as an argument for the blendUsingNode flag.

• character : ch (bool) [query]

  This flag is used to query which characters this scheduler controls. It returns an array of strings.

• clipIndex : ci (int) [create,query]

  Specify the index of the clip to schedule. In query mode, returns an array of strings in this form: (clipName,index,start,sourceStart,sourceEnd,scale,preCycle,postCycle) In query mode, this flag can accept a value.

• cycle : c (float) [create,query]

  This flag is now obsolete. Use the postCycle flag instead.

• defaultAbsolute : da (bool) [edit]

  Sets all top-level channels except rotations in the clip to relative, and the remaining channels to absolute. This is the default during clip creation if no offset flag is specified. This flag cannot be used in conjunction with the aa/allAbsolute, ar/allRelative, or ra/rotationsAbsolute flags.

• enable : en (bool) [create,query]

  This flag is used to enable or disable a clip. It must be used in conjunction with the ci/clipIndex flag. The specified clip will be enabled or disabled.

• group : grp (bool) [create]

  This flag is used to add (true) or remove (false) a list of clips (specified with groupIndex) into a group.

• groupIndex : gri (int) [create]

  This flag specifies a multiple number of clips to be added or removed from a group. Flag can have multiple arguments, passed either as a tuple or a list.

• groupName : gn (unicode) [create,query]

  This flag is used to specify the group that should be added to. If no group by that name exists and new group is created with that name. By default if this is not specified a new group will be created.

• hold : ph (time) [create,query]

  Specify how long to hold the last value of the clip after its normal or cycled end.

• insertTrack : it (int) [create]

  This flag is used to insert a new empty track at the track index specified.

• instance : instance (unicode) [create]

  Create an instanced copy of the named clip. An instanced clip is one that is linked to an original clip. Thus, changes to the animation curve of the original curve will also modify all instanced clips. The name of the instanced clip is returned as a string.

• listCurves : lc (bool) [create,query]

  This flag is used to list the animation curves associated with a clip. It should be used in conjunction with the clipIndex flag, which specifies the clip of interest.

• listPairs : lp (bool) [query]

  This query only flag returns a string array containing the channels in a character that are used by a clip and the names of the animation curves that drive the channels. Each string in the string array consists of the name of a channel, a space, and the name of the animation curve animating that channel. This flag must be used with the ci/clipIndex flag.

• lock : l (bool) [query,edit]

  This flag specifies whether clips on a track are to be locked or not. Must be used in conjuction with the track flag.

• mute : m (bool) [query,edit]

  This flag specifies whether clips on a track are to be muted or not. Must be used in conjuction with the track flag.

• name : n (unicode) [create,query]

  This flag is used to query the name of the clip node associated with the specified clip index, or to specify the name of the instanced clip during instancing. In query mode, this flag can accept a value.

• postCycle : poc (float) [create,query]

  Specify the number of times to repeat the clip after its normal end.

• preCycle : prc (float) [create,query]

  Specify the number of times to repeat the clip before its normal start.

• remove : rm (bool) [create]

  This flag is used to remove a clip from the timeline. It must be used in conjunction with the ci/clipIndex flag. The specified clip will be removed from the timeline, but will still exist in the library and any instanced clips will remain in the timeline. To permanently remove a clip from the scene, the clip command should be used instead.

• removeBlend : rb (int, int) [create]

  This flag is used to remove an existing blend between two clips, whose indices are provided as flag arguments.

• removeEmptyTracks : ret (bool) [create]

  This flag is used to remove all tracks that have no clips.

• removeTrack : rt (int) [create]

  This flag is used to remove the track with the specified index. The track must have no clips on it before it can be removed.

• rotationsAbsolute : ra (bool) [edit]

  Set all channels except rotations to be calculated with relative offsets. Rotation channels will be calculated with absolute offsets. This flag cannot be used in conjunction with the aa/allAbsolute, ar/allRelative or da/defaultAbsolute flags.

• scale : sc (float) [create,query]

  Specify the amount to scale the clip. Values must be greater than 0.

• shift : sh (int) [create]

  This flag allows multiple clips to be shifted by a certain number of tracks and works in conjunction with the shiftIndex flag. The flag specifies the number of tracks to shift the associated clips. Positive values shift the clips down an negative values shift the clips up.

• shiftIndex : shi (int) [create]

  This flag allows multiple clips to be shifted by a certain number of tracks and works in conjunction with the shiftAmount flag. The flag specifies the index of the clip to shift. This flag can be used multiple times on the command line to specify a number of clips to shift.

• solo : so (bool) [query,edit]

  This flag specifies whether clips on a track are to be soloed or not. Must be used in conjuction with the track flag.

• sourceClipName : scn (bool) [create,query]

  This flag is used to query the name of the source clip node associated with the specified clip index.

• sourceEnd : se (time) [create,query]

  Specify where to end in the source clip’s animation curves

• sourceStart : ss (time) [create,query]

  Specify where to start in the source clip’s animation curves

• start : s (time) [create,query]

  Specify the placement of the start of the clip

• track : t (int) [create,query]

  Specify the track to operate on. For example, which track to place a clip on, which track to mute/lock/solo. In query mode, it may be used in conjuction with the clipIndex flag to return the track number of a clip, where track 1 is the first track of the character. In query mode, this flag can accept a value.

• weight : w (float) [create,query]

  This flag is used in to set or query the weight of the clip associated with the specified clip index.

• weightStyle : ws (int) [create,query]

  This flag is used to set or query the weightStyle attribute of the clip associated with the specified clip index.

Derived from mel command maya.cmds.clipSchedule