pymel.core.animation.shot¶
- shot(*args, **kwargs)¶
Use this command to create a shot node or manipulate that node.
Flags:
Long Name / Short Name Argument Types Properties audio / aud unicode Specify the audio clip for this shot. Audio can be linked to a shot to allow playback of specific sounds when that shot is being displayed in the Sequencer. Refer to the shot node’s documentation for details on how audio is used by shots and the Sequencer. clip / cl unicode The clip associated with this shot. This clip will be posted to the currentCamera’s imagePlane. Refer to the shot node’s documentation for details on how cameras are used by shots and the Sequencer. clipDuration / cd time Length of clip. This is used for the display of the clip indicator bar in the Sequencer. clipOpacity / co float Opacity for the shot’s clip, this value is assigned to the currentCamera’s imagePlane. Refer to the shot node’s documentation for details on how cameras are used by shots and the Sequencer. clipSyncState / css bool The viewport synchronization status of the clip associated with this shot. Return values are, 0 = no clip associated with this shot 1 = clip is fully in sync with viewport, and frames are 1:1 with sequencer 2 = clip is partially in sync with viewport, movie may be scaled to match sequencer 3 = clip not in sync with viewport (i.e. could have scale/time/camera differences) clipZeroOffset / czo time Specify which time of the clip corresponds to the beginning of the shot. This is used to properly align splitted clips. copy / c bool This flag is used to copy a shot to the clipboard. In query mode, this flag allows you to query what, if anything, has been copied into the shot clipboard. createCustomAnim / cca bool Creates an animation layer and links the shot node’s customAnim attr to the weight attr of the animation layer currentCamera / cc unicode The camera associated with this shot. Refer to the shot node’s documentation for details on how cameras are used by shots and the Sequencer. customAnim / ca bool Returns the name of the animation layer node linked to this shot node’s customAnim attr deleteCustomAnim / dca bool Disconnects the animation layer from this shot’s customAnim attr and deletes the animation layer node determineTrack / dt bool Determines an available track for the shot. Returns a new track number or the existing track number if the current track is available. endTime / et time The shot end time in the Maya timeline. Changing the startTime will extend the duration of a shot. favorite / fav bool Make the shot a favorite. This is a UI indicator only to streamline navigation in the Sequencer panel flag1 / f1 bool User specified state flag 1/12 for this shot flag10 / f10 bool User specified state flag 10/12 for this shot flag11 / f11 bool User specified state flag 11/12 for this shot flag12 / f12 bool User specified state flag 12/12 for this shot flag2 / f2 bool User specified state flag 2/12 for this shot flag3 / f3 bool User specified state flag 3/12 for this shot flag4 / f4 bool User specified state flag 4/12 for this shot flag5 / f5 bool User specified state flag 5/12 for this shot flag6 / f6 bool User specified state flag 6/12 for this shot flag7 / f7 bool User specified state flag 7/12 for this shot flag8 / f8 bool User specified state flag 8/12 for this shot flag9 / f9 bool User specified state flag 9/12 for this shot hasCameraSet / hcs bool Returns true if the camera associated with this shot is a camera set. hasStereoCamera / hsc bool Returns true if the camera associated with this shot is a stereo camera. imagePlaneVisibility / ipv bool Visibility of the shot imageplane, this value is assigned to the currentCamera’s imagePlane. linkAudio / la unicode Specify an audio clip to link to this shot. Any currently linked audio will be unlinked. lock / lck bool Lock a specific shot. This is different than locking an entire track, which is done via the shotTrack command mute / m bool Mute a specific shot. This is different than muting an entire track, which is done via the shotTrack command. Querying this attribute will return true if the shot is muted due to its own mute, its shot being muted, or its shot being unsoloed. See flag selfmuteto query only the shot’s own state. paste / p bool This flag is used to paste a shot or shots from the clipboard to the sequence timeline. Shots are added to the clipboard using the c/copy flag. pasteInstance / pi bool This flag is used to paste an instance of a shot or shots from the clipboard to the sequence timeline. Unlike the p/paste flag, which duplicates the camera and image plane from the original source shot, the pi/pasteInstance flag shares the camera and image plane from the source shot. The audio node is duplicated. postHoldTime / pst time Specify the time length to append to the shot in the sequence timeline. This repeats the last frame of the shot, in sequence time, over the specified duration. preHoldTime / prt time Specify the time length to prepend to the shot in the sequence timeline. This repeats the first frame of the shot, in sequence time, over the specified duration. scale / s float Specify an amount to scale the Maya frame range of the shot. This will affect the sequenceEndFrame, leaving the sequenceStartFrame unchanged. selfmute / sm bool Query if this individual shot’s own mute state is set. This is different from the flag mute, which will return true if this shot is muted due to the track being muted or another track being soloed. Editing this flag will set this shot’s own mute status (identical behavior as the flag mute). sequenceDuration / sqd time Return the sequence duration of the shot, which will include the holds and scale. This flag can only be queried. sequenceEndTime / set time The shot end in the sequence timeline. Changing the endTime of a shot will scale it in sequence time. sequenceStartTime / sst time The shot start in the sequence timeline. Changing the startTime of a shot will shift it in sequence time. shotName / sn unicode Specify a user-defined name for this shot. This allows the assignment of names that are not valid as node names within Maya. Whenever the shotName attribute is defined its value is used in the UI. sourceDuration / sd time Return the number of source frames in the shot. This flag can only be queried. startTime / st time The shot start time in the Maya timeline. Changing the startTime will extend the duration of a shot. track / trk int Specify the track in which this shot resides. transitionInLength / til time Length of the transtion into the shot. transitionInType / tit int Specify the the type of transition for the transition into the shot. 0 = Fade 1 = Dissolve transitionOutLength / tol time Length of the transtion out of the shot. transitionOutType / tot int Specify the the type of transition for the transition out of the shot. 0 = Fade 1 = Dissolve unlinkAudio / ula bool COMMENT Unlinks any currently linked audio. Flag can have multiple arguments, passed either as a tuple or a list. Derived from mel command maya.cmds.shot
Example:
import pymel.core as pm myShot = pm.shot('myShot', st=10, et=19); pm.shot(myShot, e=True, sst=100, set=119); pm.shot(myShot, q=True, st=True); pm.shot(myShot, q=True, sst=True); pm.shot(myShot, e=True, pst=10); pm.shot(myShot, q=True, set=True); pm.shot(myShot, e=True, prt=5); pm.shot(myShot, q=True, set=True); pm.shot(myShot, q=True, sd=True);