bluePencilUtil is undoable, queryable, and editable.
Utility commands for blue pencil tool.
In query mode, return type is based on queried flag.
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.
|
|