bluePencilFrame

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

Synopsis

bluePencilFrame [-activeViewport] [-clear] [-copy] [-cutFrame] [-delete] [-duplicate] [-exportArchive string] [-exportFrames] [-importArchive string] [-importFrames] [-insert] [-move int int int] [-moveCopy int int int] [-moveToNext] [-paste] [-relative] [-retime int] [-scale float boolean int int] [-scaleCopy float boolean int int] [-stepBack] [-stepForward]

bluePencilFrame is undoable, NOT queryable, and NOT editable.

Return value

None

Flags

Long name (short name)	Argument types	Properties
-activeViewport(-avp)
Create the frame in the active viewport's camera.
-clear(-clr)
Erase the data from one or more frames using the highlighted range in Maya's time slider.
-copy(-cp)
Copy the frame data in the selected range to the clipboard.
-cutFrame(-cut)
Copy the frame data in the selected range to the clipboard and remove the frames.
-delete(-del)
Remove one or more frames using the highlighted range in Maya's time slider.
-duplicate(-dup)
Insert a frame at the current time that is a duplicate of the previous frame.
-exportArchive(-ea) 2025.2	string
Export a blue pencil frames archive to the specified path
-exportFrames(-ex)
Show blue pencil export frame dialog.
-importArchive(-ia) 2025.2	string
Import a blue pencil frames archive from the specified path
-importFrames(-im)
Show blue pencil import frame dialog.
-insert(-ins)
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.
-moveCopy(-mvc)	int int int
Copy then move the frames in the specified range by the given offset. Arguments are offset, range start, range end.
-moveToNext(-mvn)
Move the current time to the next frame after retiming.
-paste(-pst)
Create new frames using the data in the clipboard at the current time.
-relative(-rel)
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.
-scaleCopy(-scc)	float boolean int int
Copy then 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)
Set the current time to the previous blue pencil frame's time.
-stepForward(-sf)
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 be used more than once in a command.

MEL examples

// Frame actions.
bluePencilFrame -ins;
bluePencilFrame -dup;
bluePencilFrame -del;
bluePencilFrame -cut;
bluePencilFrame -cp;
bluePencilFrame -pst;
bluePencilFrame -clr;
bluePencilFrame -stepForward;
bluePencilFrame -stepBack;

// Set the distance to the next frame to 5.
bluePencilFrame -retime 5;

// Add 5 to the space to the next frame.
bluePencilFrame -retime 5 -relative;

// Set the distance to the next frame to 5 and then set the current time to the next frame.
bluePencilFrame -retime 5 -moveToNext;

// Move frames between 5 and 9 by 15 frames.
bluePencilFrame -move 15 5 9;

// Move frames between 5 and 9 by 15 frames while leaving a copy of the initial keys in their original location.
bluePencilFrame -moveCopy 15 5 9;

// Scale frames between 5 and 9 by 2 from the beginning.
bluePencilFrame -scale 2.0 0 5 9;

// Scale frames between 5 and 9 by 2 from the beginning while leaving a copy of the initial keys in their original location.
bluePencilFrame -scaleCopy 2.0 0 5 9;

// Launch import frame dialog.
bluePencilFrame -importFrames;

// Launch export frame dialog.
bluePencilFrame -exportFrames;

// Import a blue pencil frame archive without the file browser dialog
bluePencilFrame -importArchive "C:/archives/bluePencil.zip";

// Export a blue pencil frame archive without the file browser dialog
bluePencilFrame -exportArchive "C:/archives/bluePencil.zip";