bluePencilUtil

2023

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

Synopsis

bluePencilUtil [-adjustBrushSize boolean] [-adjustOpacity boolean] [-arrowOptions int int] [-arrowTool] [-brushOptions int int int int int] [-brushTool] [-draw] [-drawColor int int int] [-ellipseOptions int int] [-ellipseTool] [-eraserOptions int int int int int] [-eraserTool] [-ghostColorNext int int int] [-ghostColorOverride boolean] [-ghostColorPrevious int int int] [-ghostNext boolean] [-ghostNextCount int] [-ghostPrevious boolean] [-ghostPreviousCount int] [-layerManager] [-layerProperties] [-lineOptions int int] [-lineTool] [-pencilOptions int int int int] [-pencilTool] [-rectangleOptions int int] [-rectangleTool] [-refreshLayerManager] [-refreshTimelineDisplay] [-resetTool] [-textFontFamily string] [-textOptions int int string] [-textTool] [-timelineFrameDisplay int] [-transform]

bluePencilUtil is undoable, queryable, and editable.

Return value

None

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

Flags

Long name (short name)	Argument types	Properties
-adjustBrushSize(-abs)	boolean
Activates or deactivates the mode to adujst the brush size by dragging.
-adjustOpacity(-aop)	boolean
Activates or deactivates the mode to adujst the brush opacity by dragging.
-arrowOptions(-ao)	int int
Set the arrow options. The arguments are size, opacity.
-arrowTool(-at)
Activates the arrow tool. When queried, returns true if the arrow tool is active.
-brushOptions(-bo)	int int int int int
Sets the brush options. The arguments in order are size, opacity, hardness pressure opacity, pressure size.
-brushTool(-bt)
Activates the brush tool. When queried, returns true if the brush tool is active.
-draw(-d)
Activates the drawing tool context. When queried, returns true if the drawing tool context is active.
-drawColor(-dc)	int int int
Sets the current drawing color. Color format is RGB with values from 0-255. When queried, returns the current drawing color.
-ellipseOptions(-elo)	int int
Sets the ellipse options. The arguments are size, opacity.
-ellipseTool(-elt)
Activates the ellipse tool. When queried, returns true if the ellipse tool is active.
-eraserOptions(-eo)	int int int int int
Sets the brush options. The arguments in order are size, opacity, hardness pressure opacity, pressure size.
-eraserTool(-et)
Activates the eraser tool. When queried, returns true if the eraser tool is active.
-ghostColorNext(-gcn)	int int int
Sets the color for the ghosts of next frames.
-ghostColorOverride(-gco)	boolean
Activates or deactivates the color override for the ghosts.
-ghostColorPrevious(-gcp)	int int int
Sets the color for the ghosts of previous frames.
-ghostNext(-gn)	boolean
Activates or deactivates the ghosting of next frames.
-ghostNextCount(-gnc)	int
Sets the number of ghosts of next frames.
-ghostPrevious(-gp)	boolean
Activates or deactivates the ghosting of previous frames.
-ghostPreviousCount(-gpc)	int
Sets the number of ghosts of previous frames.
-layerManager(-lm)
Shows the layer manager by showing the tool settings window. Query returns if the layer manager is shown.
-layerProperties(-lp)
Show the layer properties dialog.
-lineOptions(-lo)	int int
Sets the line options. The arguments are size, opacity.
-lineTool(-lt)
Activates the line tool. When queried, returns true if the line tool is active.
-pencilOptions(-po)	int int int int
Sets the pencil options. The arguments in order are size, opacity, pressure opacity, pressure size.
-pencilTool(-pt)
Activates the pencil tool. When queried, returns true if the pencil tool is active.
-rectangleOptions(-ro)	int int
Sets the rectangle options. The arguments are size, opacity.
-rectangleTool(-rt)
Activates the rectangle tool. When queried, returns true if the rectangle tool is active.
-refreshLayerManager(-rlm)
Refresh the layer manager.
-refreshTimelineDisplay(-rtd)
Refresh the timeline display frames.
-resetTool(-r)
Restore tool settings to default values.
-textFontFamily(-tff)	string
Sets the text font family.
-textOptions(-txo)	int int string
Sets the text options. The arguments in order are size, opacity, font family name.
-textTool(-tt)
Activates the text tool. When queried, returns true if the text tool is active.
-timelineFrameDisplay(-tfd)	int
Sets the display mode for blue pencil frames in the timeline. Modes: 0 Show always 1 Show when context is active 2 Hide
-transform(-t)
Activates the transform tool context. When queried, returns true if the transform tool context is active.

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

// Activate the drawing tool context.
bluePencilUtil -d;

// Activate the transform tool context.
bluePencilUtil -transform;

// Set the draw color to red.
bluePencilUtil -drawColor 255 0 0;

// Activate tool.
bluePencilUtil -pencilTool;
bluePencilUtil -brushTool;
bluePencilUtil -eraserTool;
bluePencilUtil -lineTool;
bluePencilUtil -arrowTool;
bluePencilUtil -ellipseTool;
bluePencilUtil -rectangleTool;
bluePencilUtil -textTool;

// Start adjusting the brush size.
bluePencilUtil -adjustBrushSize 1;

// Stop adjusting the brush size.
bluePencilUtil -adjustBrushSize 0;

// Adjust opacity.
bluePencilUtil -adjustOpacity 1;

// Set pencil options size: 10, opacity 25, pressure size: 35, pressure opacity: 45.
bluePencilUtil -pencilOptions 10 25 35 45;

// Set pencil options size: 10, opacity 25, hardness: 30,
//pressure size: 35, pressure opacity: 45.
bluePencilUtil -brushOptions 10 25 30 35 45;
bluePencilUtil -eraserOptions 10 25 30 35 45;
bluePencilUtil -lineOptions 10 25;
bluePencilUtil -arrowOptions 10 25;
bluePencilUtil -ellipseOptions 10 25;
bluePencilUtil -rectangleOptions 10 25;

// Set the text options, size: 12, opacity: 25, font: Arial
bluePencilUtil -textOptions 12 25 Arial;
bluePencilUtil -textFontFamily Arial;

// Activate ghosting
bluePencilUtil -ghostPrevious 1;
bluePencilUtil -ghostNext 1;

// Set the number of ghosts.
bluePencilUtil -ghostPreviousCount 5;
bluePencilUtil -ghostNextCount 5;

// Set the ghost color.
bluePencilUtil -ghostColorOverride 1;
bluePencilUtil -ghostColorPrevious 0 0 255;
bluePencilUtil -ghostColorNext 255 255 0;

// Refresh timeline.
bluePencilUtil -refreshTimelineDisplay;

// Show layer manager.
bluePencilUtil -layerManager;

// Refresh layer manager.
bluePencilUtil -refreshLayerManager;

// Show layer properties.
bluePencilUtil -layerProperties;

// Reset blue pencil tool settings.
bluePencilUtil -resetTool;