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

Synopsis

timeEditorClipOffset [-applyToAllRoots] [-clipId int] [-matchClipId int] [-matchDstTime time] [-matchObj name] [-matchOffsetRot] [-matchOffsetTrans] [-matchPath string] [-matchRotOp int] [-matchSrcTime time] [-matchTransOp int] [-offsetTransform] [-path string] [-resetMatch int] [-resetMatchPath string] [-rootObj string] [-upVectorX float] [-upVectorY float] [-upVectorZ float]

timeEditorClipOffset is undoable, queryable, and editable.

This command is used to compute an offset to apply on a source clip in order to automatically align it to a destination clip at a specified match element. For this command to work, offset objects must be specified for the character.

Return value

None

In query mode, return type is based on queried flag.

Keywords

timeEditor, nle

Related

timeEditor, timeEditorClip

Flags

applyToAllRoots, clipId, matchClipId, matchDstTime, matchObj, matchOffsetRot, matchOffsetTrans, matchPath, matchRotOp, matchSrcTime, matchTransOp, offsetTransform, path, resetMatch, resetMatchPath, rootObj, upVectorX, upVectorY, upVectorZ
Long name (short name) Argument types Properties
-applyToAllRoots(-atr) create
Apply root offsets to all roots in the population. However, if the root objects are specified by rootObj flag, this flag will be ignored.
-clipId(-id) int createeditmultiuse
ID of the clip to be edited.
-matchClipId(-mci) int create
Specify the ID of a clip to match.
-matchDstTime(-mdt) time create
Specify the time on target clip.
-matchObj(-mob) name create
Specify the object to match.
-matchOffsetRot(-mor) query
Get the rotation of the match offset matrix.
-matchOffsetTrans(-mot) query
Get the translation of the match offset matrix.
-matchPath(-mpt) string create
Full path of the clip to match. For example: composition1|track1|Group|track2|clip1
-matchRotOp(-mro) int create
Specify the option for matching rotation.
  • 0 : full - All rotation components are matched
  • 1 : Y - Y component is matched
  • 2 : none - No rotation matching
-matchSrcTime(-mst) time create
Specify the time on source clip.
-matchTransOp(-mto) int create
Specify the option for matching translation.
  • 0 : full - All translation components are matched
  • 1 : XZ - X and Z components are matched
  • 2 : none - No translation matching
-offsetTransform(-oft) createquery
Create/get an offset for the specified clip.
-path(-pt) string createeditmultiuse
Full path of a clip to be edited. For example: composition1|track1|group; composition1|track1|group|track2|clip1.

In query mode, this flag can accept a value.
-resetMatch(-rsm) int create
Specify clip ID to remove offset.
-resetMatchPath(-rmp) string create
Specify clip's full path to remove offset. For example: composition1|track1|Group|track2|clip1
-rootObj(-rob) string createqueryeditmultiuse
Specify the root objects. If specified, this flag will take precedence over applyToAllRoots flag. When used in query mode, returns list of roots defined for the relocator.
-upVectorX(-upx) float create
Specify the X coordinate of the up vector.
-upVectorY(-upy) float create
Specify the Y coordinate of the up vector.
-upVectorZ(-upz) float create
Specify the Z coordinate of the up vector.
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


// Match position and rotation
//
timeEditorClipOffset -clipId 1 -matchClipId 2 -matchObj cube -matchSrcTime 45 -matchDstTime 45 -matchTransOp 0 -matchRotOp 1 -applyToAllRoots;

// Match position and rotation by clip paths
//
timeEditorClipOffset -path "composition1|track1|clip1" -matchPath "composition1|track1|clip2" -matchObj cube -matchSrcTime 45 -matchDstTime 45 -matchTransOp 0 -matchRotOp 1 -applyToAllRoots;