Go to: Synopsis. Return value. Flags. Python examples.
bluePencilFrame([activeViewport=boolean], [clear=boolean], [copy=boolean], [cutFrame=boolean], [delete=boolean], [duplicate=boolean], [exportFrames=boolean], [importFrames=boolean], [insert=boolean], [move=[int, int, int]], [moveToNext=boolean], [paste=boolean], [relative=boolean], [retime=int], [scale=[float, boolean, int, int]], [stepBack=boolean], [stepForward=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
bluePencilFrame is undoable, NOT queryable, and NOT editable.
Command to create or edit blue pencil frames.
None
activeViewport, clear, copy, cutFrame, delete, duplicate, exportFrames, importFrames, insert, move, moveToNext, paste, relative, retime, scale, stepBack, stepForward
| Long name (short name) |
Argument types |
Properties |
|
activeViewport(avp)
|
boolean
|
|
|
Create the frame in the active viewport's camera.
|
|
clear(clr)
|
boolean
|
|
|
Erase the data from one or more frames using the highlighted range in Maya's time slider.
|
|
copy(cp)
|
boolean
|
|
|
Copy the frame data in the selected range to the clipboard.
|
|
cutFrame(cut)
|
boolean
|
|
|
Copy the frame data in the selected range to the clipboard and remove the frames.
|
|
delete(delete)
|
boolean
|
|
|
Remove one or more frames using the highlighted range in Maya's time slider.
|
|
duplicate(dup)
|
boolean
|
|
|
Insert a frame at the current time that is a duplicate of the previous frame.
|
|
exportFrames(ex)
|
boolean
|
|
|
Show blue pencil export frame dialog.
|
|
importFrames(im)
|
boolean
|
|
|
Show blue pencil import frame dialog.
|
|
insert(ins)
|
boolean
|
|
|
Insert one or more empty frames using the highlighted range in the time slider.
|
|
move(mv)
|
[int, int, int]
|
|
|
Move the frames in the specified range by the given offset. Arguments are offset,
range start, range end.
|
|
moveToNext(mvn)
|
boolean
|
|
|
Move the current time to the next frame after retiming.
|
|
paste(pst)
|
boolean
|
|
|
Create new frames using the data in the clipboard at the current time.
|
|
relative(rel)
|
boolean
|
|
|
Set the retime action to shift the frames by a relative amount to add or remove space
between frames. When the flag is not set, the spacing between the frames is set to the
retime value.
|
|
retime(ret)
|
int
|
|
|
Shift frames or change the frame spacing in a selected range.
|
|
scale(sc)
|
[float, boolean, int, int]
|
|
|
Scale the frames in the specified range by the given factor. Arguments are scale factor,
scale from end (true) or beginning (false), range start, range end.
|
|
stepBack(sb)
|
boolean
|
|
|
Set the current time to the previous blue pencil frame's time.
|
|
stepForward(sf)
|
boolean
|
|
|
Set the current time to the next blue pencil frame's time.
|
|
|
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 have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
# Frame actions.
cmds.bluePencilFrame(ins=True)
cmds.bluePencilFrame(dup=True)
cmds.bluePencilFrame(del=True)
cmds.bluePencilFrame(cut=True)
cmds.bluePencilFrame(cp=True)
cmds.bluePencilFrame(pst=True)
cmds.bluePencilFrame(clr=True)
cmds.bluePencilFrame(stepForward=True)
cmds.bluePencilFrame(stepBack=True)
# Set the distance to the next frame to 5.
cmds.bluePencilFrame(retime=5)
# Add 5 to the space to the next frame.
cmds.bluePencilFrame(retime=5, relative=True)
# Set the distance to the next frame to 5 and then set the current time to the next frame.
cmds.bluePencilFrame(retime=5, moveToNext=True)
# Move frames between 5 and 9 by 15 frames.
cmds.bluePencilFrame(move=(15, 5, 9))
# Scale frames between 5 and 9 by 2 from the beginning.
cmds.bluePencilFrame(scale=(2.0, 0, 5, 9))
# Launch import frame dialog.
cmds.bluePencilFrame(importFrames=True)
# Launch export frame dialog.
cmds.bluePencilFrame(exportFrames=True)