Go to: Related nodes. Attributes.

Grease Plane is an object in the scene that can be drawn onto. Like an image plane, each grease plane is attached to a specific camera.

A single camera can have multiple grease planes. And a single grease plane can be attached to more than one camera.

In the table below, important attributes have their names listed in bold in the description column.

Node nameParentsMFn typeCompatible function sets
greasePlaneimagePlanekGreasePlanekBase
kNamedObject
kDependencyNode
kDagNode
kShape
kGreasePlane

Related nodes

cameraView

Attributes (28)

greaseSequence, renderPlane, renderPlaneRotate, renderPlaneRotateX, renderPlaneRotateY, renderPlaneRotateZ, renderPlaneScale, renderPlaneScaleX, renderPlaneScaleY, renderPlaneScaleZ, renderPlaneTranslate, renderPlaneTranslateX, renderPlaneTranslateY, renderPlaneTranslateZ, sourceDepth, sourcePlane, sourcePlaneRotate, sourcePlaneRotateX, sourcePlaneRotateY, sourcePlaneRotateZ, sourcePlaneScale, sourcePlaneScaleX, sourcePlaneScaleY, sourcePlaneScaleZ, sourcePlaneTranslate, sourcePlaneTranslateX, sourcePlaneTranslateY, sourcePlaneTranslateZ

Long name (short name)TypeDefaultFlags
sourcePlane (spl) Messagen/aoutputinputconnectablehidden
This attribute connects to the plane that's controlled and orientated by the grease plane so that it aligns correctly with the camera.
renderPlane (rpl) Messagen/aoutputinputconnectablehidden
This attribute connects to the plane that's controlled and orientated by the grease plane so that it aligns correctly with the camera.
greaseSequence (gsq) Messagen/aoutputinputconnectablehidden
The grease sequence message is connected to the grease sequence node that contains data for this plane.
sourceDepth (srd) distance (double)2000cmoutputinputconnectablestorablekeyable
SourceDepth controls the distance of the drawing plane from the camera. This attribute is only meaningful when Locked To Camera is on.
renderPlaneTranslate (rptr) double30.0, 0.0, 0.0outputconnectable
renderPlane position.
renderPlaneTranslateX (rptx) distance (double)0.0cmoutputconnectable
x component.
renderPlaneTranslateY (rpty) distance (double)0.0cmoutputconnectable
y component.
renderPlaneTranslateZ (rptz) distance (double)0.0cmoutputconnectable
z component.
sourcePlaneTranslate (sptr) double30.0, 0.0, 0.0outputconnectable
Source Plane position.
sourcePlaneTranslateX (sptx) distance (double)0.0cmoutputconnectable
x component.
sourcePlaneTranslateY (spty) distance (double)0.0cmoutputconnectable
y component.
sourcePlaneTranslateZ (sptz) distance (double)0.0cmoutputconnectable
z component.
renderPlaneRotate (rpr) double30.0, 0.0, 0.0outputconnectable
Render Plane position.
renderPlaneRotateX (rprx) angle (double)0.0degoutputconnectable
x component.
renderPlaneRotateY (rpry) angle (double)0.0degoutputconnectable
y component.
renderPlaneRotateZ (rprz) angle (double)0.0degoutputconnectable
z component.
sourcePlaneRotate (spr) double30.0, 0.0, 0.0outputconnectable
Source plane position.
sourcePlaneRotateX (sprx) angle (double)0.0degoutputconnectable
x component.
sourcePlaneRotateY (spry) angle (double)0.0degoutputconnectable
y component.
sourcePlaneRotateZ (sprz) angle (double)0.0degoutputconnectable
z component.
renderPlaneScale (rps) double31.0, 1.0, 1.0outputconnectable
Render plane position.
renderPlaneScaleX (rpsx) double1.0outputconnectable
x component.
renderPlaneScaleY (rpsy) double1.0outputconnectable
y component.
renderPlaneScaleZ (rpsz) double1.0outputconnectable
z component.
sourcePlaneScale (sps) double31.0, 1.0, 1.0outputconnectable
Source Plane position.
sourcePlaneScaleX (spsx) double1.0outputconnectable
x component.
sourcePlaneScaleY (spsy) double1.0outputconnectable
y component.
sourcePlaneScaleZ (spsz) double1.0outputconnectable
z component.