bluePencilNode

2023

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

Synopsis

bluePencilNode [-camera string] [-exists] [-frame] [-layer] [-layerName string] [-layerState uint] [-refresh] [-refreshGhosting]

bluePencilNode is undoable, queryable, and NOT editable.

Return value

None

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

Flags

Long name (short name)	Argument types	Properties
-camera(-c)	string
Specifies the camera on which to create a new layer when creating the node. Query returns the name of the active camera.
-exists(-ex)
Returns true if the blue pencil node has been created.
-frame(-f)
Creates a new frame when creating the new layer when creating the node.
-layer(-l)
Create a new layer when creating the node.
-layerName(-ln)	string
Specifies the layer name of the new layer when creating the node.
-layerState(-ls)	uint
Specifies the layer state of the new layer. 0: Animated, 1: Static.
-refresh(-r)
Refresh the viewport of the active camera.
-refreshGhosting(-rg)
Refresh the ghosting information.

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

// Refresh node.
bluePencilNode -r;

// Check if blue pencil node exists.
bluePencilNode -exists;

// Get the active camera name.
bluePencilNode -q -camera;

// Create a new node.
bluePencilNode -layer -c CameraName -ln LayerName -ls 1 -f;