greasePlane

Show frames

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.

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)	Type	Default	Flags
greaseSequence (gsq)	Message	n/a
The grease sequence message is connected to the grease sequence node that contains data for this plane.
renderPlane (rpl)	Message	n/a
This attribute connects to the plane that's controlled and orientated by the grease plane so that it aligns correctly with the camera.
renderPlaneRotate (rpr)	double3	0.0, 0.0, 0.0
Render Plane position.
renderPlaneRotateX (rprx) angle (double) 0.0deg x component.
renderPlaneRotateY (rpry) angle (double) 0.0deg y component.
renderPlaneRotateZ (rprz) angle (double) 0.0deg z component.
renderPlaneScale (rps)	double3	1.0, 1.0, 1.0
Render plane position.
renderPlaneScaleX (rpsx) double 1.0 x component.
renderPlaneScaleY (rpsy) double 1.0 y component.
renderPlaneScaleZ (rpsz) double 1.0 z component.
renderPlaneTranslate (rptr)	double3	0.0, 0.0, 0.0
renderPlane position.
renderPlaneTranslateX (rptx) distance (double) 0.0cm x component.
renderPlaneTranslateY (rpty) distance (double) 0.0cm y component.
renderPlaneTranslateZ (rptz) distance (double) 0.0cm z component.
sourceDepth (srd)	distance (double)	2000cm
SourceDepth controls the distance of the drawing plane from the camera. This attribute is only meaningful when Locked To Camera is on.
sourcePlane (spl)	Message	n/a
This attribute connects to the plane that's controlled and orientated by the grease plane so that it aligns correctly with the camera.
sourcePlaneRotate (spr)	double3	0.0, 0.0, 0.0
Source plane position.
sourcePlaneRotateX (sprx) angle (double) 0.0deg x component.
sourcePlaneRotateY (spry) angle (double) 0.0deg y component.
sourcePlaneRotateZ (sprz) angle (double) 0.0deg z component.
sourcePlaneScale (sps)	double3	1.0, 1.0, 1.0
Source Plane position.
sourcePlaneScaleX (spsx) double 1.0 x component.
sourcePlaneScaleY (spsy) double 1.0 y component.
sourcePlaneScaleZ (spsz) double 1.0 z component.
sourcePlaneTranslate (sptr)	double3	0.0, 0.0, 0.0
Source Plane position.
sourcePlaneTranslateX (sptx) distance (double) 0.0cm x component.
sourcePlaneTranslateY (spty) distance (double) 0.0cm y component.
sourcePlaneTranslateZ (sptz) distance (double) 0.0cm z component.