Go to: Related nodes. Attributes.

Image Plane is an object in the scene that can display images or textures. Each image plane is attached to a specific camera, and provides a background or environment for scenes seen through that camera.

A single camera can have multiple image planes. And a single image plane can be attached to more than one camera. Image planes can use single image files, a numbered sequence of image files (such as a saved animation), or a movie file, or a texture. Environment maps (such as Env Sky or Env Ball) work particularly well on image planes. In the table below, important attributes have their names listed in bold in the description column.
Node name Parents Classification MFn type Compatible function sets
imagePlane node imageplane:drawdb/base/imagePlane kImagePlane kBase
kNamedObject
kDependencyNode
kImagePlane

Related nodes

cameraView

Attributes (56)

The following quick index only shows top-level attributes (too many attributes to show them all): alphaGain, alreadyPremult, center (3), colorGain (3), colorOffset (3), compositeDepth, coverage (2), coverageOrigin (2), depth, depthBias, depthFile, depthOversample, depthScale, displayMode, displayOnlyIfCurrent, fit, frameCache, frameExtension, frameIn, frameOffset, frameOut, height, imageName, lockedToCamera, maxShadingSamples, offset (2), rotate, separateDepth, shadingSamples, shadingSamplesOverride, size (2), sourceTexture, squeezeCorrection, type, useDepthMap, useFrameExtension, visibleInReflections, visibleInRefractions, width

Long name (short name) Type Default Flags
type (t) enum 0 outputinputconnectablestorable
Type controls the source of the image on the Image plane. Allowed values are Image File and Texture. Some attributes are not available when using the Texture setting.
frameCache (fc) integer 24 outputinputconnectablestorable
Specifies how many frames to cache on the image plane node. This attribute is used when you have a sequence of images and want to cache the images when they are read from disk. By default this value is set to 24.
imageName (imn) string NULL outputinputconnectablestorable
Image Name is only used if Type is set to Image File. Set this attribute to the file name of the image to be used in the image plane. If you want to use a sequence of images (such as a saved animation) then set this to the name of the first file in the sequence. (see also Use Frame Extension and Frame Extension). You can also specify a movie file here. Maya can use SGI movie files using one of these compressions: Uncompressed Video, RLE, RLE24, JPEG, MVC1, or MVC2. Maya can also use QuickTime movie files using one of these compressions: Uncompressed Video, QuickTime Video, QuickTime Animation, or Indeo. If you specify a movie file, you must use the Frame Extension attributes.
useFrameExtension (ufe) bool false outputinputconnectablestorable
Use Frame Extension. Turn this ON when you are using a sequence of image files (such as a saved animation) for the image plane, or if you are using an SGI or QuickTime movie file. When this is on, the system will substitute the frame number in the Image Name with the number from the Frame Extension attribute (see below).
frameExtension (fe) integer 1 outputinputconnectablestorablekeyable
Frame Extension. This is only used when Use Frame Extension is ON. The frame extension in Image Name is replaced by the number here. Animate this attribute to use a sequence of image files (such as a saved animation) in the image plane. Example: say you have saved images named "pic.1.iff" up to "pic.99.iff". You want them to show on the image plane between frames 100 and 300 of your animation. To do this:
  • Set Image Name to "pic.1.iff"
  • Turn Frame Extension ON.
  • Go to frame 100. Set Frame Extension to 1. Keyframe it.
  • Go to frame 300. Set Frame Extension to 99. Keyframe it.
Tip: You can also use an expression for this attribute. For example, if you want the frame number of the image to always be the same as the current frame number, then just type "=frame" into the Frame Extension field in the attribute editor.
frameOffset (fo) integer 0 outputinputconnectablestorablekeyable
Specifies an offset of the keyed Frame Extension value. This attribute is only meaningful if Use Frame Extension is turned on.
frameIn (fin) integer -1 outputinputconnectablestorablekeyable
Specifes the initial frame of the movie. This is use to clip the movie to a smaller clip. This is taken before the frame offset. This attribute is only used with the movie type format.
frameOut (fot) integer -1 outputinputconnectablestorablekeyable
Specifes the end (last) frame of the movie. This is use to clip the move into a smaller region. A default value of 0 will be replaced on file load to the length of the movie. This attribute is only used with the movie type format.
coverage (cov) short2 1, 1 outputinputconnectablestorable
Coverage controls the amount of the image that will be used in the image plane. This is only used when the Type is set to Image File. The coverage is measured in pixels. You can specify how many horizontal and vertical pixels of the source image will be used. See also Coverage Origin (below).
coverageX (cvx) short 0 outputinputconnectablestorable
Coverage X: The width in pixels of the area on the source image to be used.
coverageY (cvy) short 0 outputinputconnectablestorable
Coverage Y: The height in pixels of the area on the source image to be used.
coverageOrigin (co) short2 0, 0 outputinputconnectablestorable
Coverage Origin controls the lower-left-corner of the area of the input image that will be used on the image plane. 0, 0, is the lower-left corner of the image. See also Coverage (above)
coverageOriginX (cox) short 0 outputinputconnectablestorable
Coverage Origin X: The pixel position of the left edge of the area of the source image to be used.
coverageOriginY (coy) short 0 outputinputconnectablestorable
Coverage Origin Y: The pixel position of the bottom edge of the area of the source image to be used.
sourceTexture (stx) Message n/a outputinputconnectablehidden
Source Texture. If the Type attribute is set to Texture, then this attribute is connected to the texture node used by the image plane. Note that the Texture node must have an attribute named Out Color.
fit (f) enum 1 outputinputconnectablestorable
Fit controls how the image file will be fit into the image plane. If the image file being used has the same aspect ratio as the image plane (determined by the Size attribute), then there is no problem; the image will fit exactly without any squashing or stretching. If the aspect ratios don't match, then this attribute determines which fitting algorithm will be used. Choices are:
Fill: The image will be made as small as it can while still completely filling the image plane. Whatever excess hangs off the sides or the top and bottom will be cropped. Fill guarantees that the image will completely fill the plane, without being squashed or stretched. Best: The image will be made as large as it can be, while still fitting completely within the defined image plane. (Effectively, this is the same as chooing Horizontal or Vertical, whichever one will result in no part of the image being cropped). Best guarantees that you will see the entire image, with no cropping and no squashing or stretching. Horizontal: The image is sized so that its horizontal dimension exactly fits the horizontal dimension of the image plane. The image keeps its own aspect ratio. Horizontal fit will crop the top and bottom of the image to make it fit. Vertical: The image is sized so that its vertical dimension exactly fits the vertical dimension of the image plane. The image keeps its own aspect ratio. Vertical fit will crop the left and right sides of the image to make it fit. To Size: The image is squashed or stretched, forced to fit into the image plane both horizontally and vertically.
displayMode (dm) enum 3 outputinputconnectablestorable
Display Mode controls how the image plane will be displayed both in the 3d view, and when rendered. Choices are:
None: The image plane is not shown. Outline: The image plane is displayed as a rectangle with an X through it. (If you render in this mode, the image plane will show up as though it were in RGB mode) RGB: The image is displayed. Any alpha channel (transparency) is ignored. If you are displaying an SGI or QuickTime movie file with no alpha channel, you should use this setting. RGBA: The image is displayed. The alpha channel controls the transparency of the image. (Areas where the alpha channel are brighter are more opaque) Luminance: The image is diplayed in greyscale, like a black-and-white television. Transparency (alpha) is ignored. Alpha: The alpha (transparency) channel is displayed as a monochrome image.
displayOnlyIfCurrent (dic) bool false outputinputconnectablestorable
Display Only If Current. If this is turned on, then you will only see the image plane when you are looking through the camera that the plane is attached to. For example, if you attach an image plane to your perspective camera, and you don't want to see it in your ortho views, turn this attribute ON.
colorGain (cg) float3 1.0, 1.0, 1.0 outputinputstorable
Color Gain is a multiplier applied to the colors in the image plane. Use this to control the relative brightness of the image.
colorGainR (cgr) float 0.0 outputinputstorable
The red component of Color Gain
colorGainG (cgg) float 0.0 outputinputstorable
The green component of Color Gain
colorGainB (cgb) float 0.0 outputinputstorable
The blue component of Color Gain
colorOffset (cof) float3 0.0, 0.0, 0.0 outputinputstorable
Color Offset is an additive value applied to the colors in the image plane. Increase this to make the whole image uniformly brighter.
colorOffsetR (cor) float 0.0 outputinputstorable
The red component of Color Offset
colorOffsetG (cog) float 0.0 outputinputstorable
The green component of Color Offset
colorOffsetB (cob) float 0.0 outputinputstorable
The blue component of Color Offset
alphaGain (ag) double 1.0 outputinputconnectablestorablekeyable
Alpha Gain is a multiplier that is applied to the alpha value. Increase this to make the semi-transparent areas of the image more opaque. Decrease this to make them more transparent.
shadingSamplesOverride (sso) bool true outputinputconnectablestorable
The flag to control if this surface should override global shading sample settings.
shadingSamples (ssa) integer 1 outputinputconnectablestorable
Specifies the minimum number of shading samples should be taken for this surface during rendering.
maxShadingSamples (msa) integer 1 outputinputconnectablestorable
Specifies the max number of shading samples can be taken for this surface during rendering.
lockedToCamera (dlc) bool true outputinputconnectablestorable
Locked To Camera. If this is turned on, then the image plane is locked to the camera's position, so that as the camera moves, the image plane moves with it. If this is turned off, the image plane stays in a fixed location, but it still always faces the camera. This is normally turned on. Tip: Use this attribute to trace images. Attach an image plane to an ortho camera, and load an image into it. Then turn off Locked to Camera. Now you can use tools such as the Maya curve tool to trace what's in the image. You can pan around and zoom in and out as you need to.
depth (d) distance (double) 100cm outputinputconnectablestorablekeyable
Depth controls the distance of the plane from the camera. This attribute is only meaningful when Locked To Camera is on.
squeezeCorrection (sqc) double 1.0 outputinputconnectablestorable
Squeeze Correction applies a horizontal scaling to an image. Increase Squeeze Correction to squeeze the image more, and descrease it to spread the image wider. This can be useful when your background images were scanned in from film that was shot using an anamorphic film format, such as Panavision. Set Squeeze Correction to 0.5, and the compressed film images will be expanded to twice their width.
size (s) double2 3.6cm 2.4cm outputinputconnectablestorable
Size controls the width and height of the image plane. This attribute is only meaningful when Locked To Camera is on. Note: Size is always measured in inches, so matter what your current units are set to. It is measured on the camera's aperture.
sizeX (sx) double 0.0 outputinputconnectablestorablekeyable
Size X: Image plane width
sizeY (sy) double 0.0 outputinputconnectablestorablekeyable
Size Y: Image plane height.
offset (o) double2 0.0, 0.0 outputinputconnectablestorable
Offset controls how much the center of the image plane is offset from the centre of the viewing frustum of the camera. Offset is always measured in inches on the camera aperture. This attribute is only meaningful when Locked To Camera is on.
offsetX (ox) double 0.0 outputinputconnectablestorablekeyable
Horizontal component of Offset
offsetY (oy) double 0.0 outputinputconnectablestorablekeyable
Vertical component of Offset
center (c) double3 0.0, 0.0, 0.0 outputinputconnectablestorable
Center controls the world-space position of the center of the image plane. This attribute is only meaningful when Locked To Camera is turned off.
centerX (cx) distance (double) 0.0cm outputinputconnectablestorablekeyable
X component of Center
centerY (cy) distance (double) 0.0cm outputinputconnectablestorablekeyable
Y component of Center
centerZ (cz) distance (double) 0.0cm outputinputconnectablestorablekeyable
Z component of Center
width (w) distance (double) 0.0cm outputinputconnectablestorablekeyable
Width controls the width of the image plane in world space. This attribute is only meaningful when Locked To Camera is turned off.
height (h) distance (double) 0.0cm outputinputconnectablestorablekeyable
Height controls the height of the image plane in world space. This attribute is only meaningful when Locked To Camera is turned off.
visibleInReflections (vir) bool false outputinputconnectablestorable
Visible In Reflections. Turn this on if you are doing Ray Tracing, and you want the image plane to sppear in reflected surfaces.
visibleInRefractions (vif) bool false outputinputconnectablestorable
Visible In Refractions. Turn this on if you are doing Ray Tracing, and you want the image plane to sppear when seen through a transparent refractive surface.
rotate (r) angle (double) 0.0deg outputinputconnectablestorable
Rotation of the image plane around the view vector. This attribute is only meaningful when Locked To Camera is on.
useDepthMap (udm) bool false outputinputconnectablestorable
Determines whether a depth map should be used for this image plane. This is only support for Maya IFF image files.
compositeDepth (cmp) bool true outputinputconnectablestorable
Indicates whether or not the image plane's color should be composited into the final image.
alreadyPremult (pre) bool false outputinputconnectablestorable
Indicates whether or not the image plane's stored color has already been premultiplied by its alpha. If it has, then Maya will not re-multiply the two. Note, this flag only affects rendering in the software renderer.
depthOversample (osp) bool false outputinputconnectablestorable
Indicates if we should oversample the depth buffer. Users can specify a depth buffer that is larger than the image buffer using the 'depthFile' attribute. Depth files should be integral multiples larger than the width and height of the actual image.
separateDepth (sd) bool false outputinputconnectablestorable
Indicates that we should read depth information from the file specified in the 'depthFile' attribute.
depthFile (df) string false outputinputconnectablestorable
Allows the user to specify a separate file to obtain depth information. Only Maya IFF files are supported.
depthBias (dg) distance (double) 0.0cm outputinputconnectablestorable
Offsets the depth buffer by the specified amount. Values are clamped to the near and far clip plane.
depthScale (ds) double 1.0 outputinputconnectablestorable
Scales the depth information the z values are multipled by the scale value before rendering. Values are clamped to the near and far clip planes.