Go to: Synopsis. Return value. Keywords. Related. Flags. Python examples.

Synopsis

imagePlane([camera=string], [counter=boolean], [detach=boolean], [dropFrame=boolean], [fileName=string], [frameDuration=int], [height=float], [imageSize=[int, int]], [lookThrough=string], [maintainRatio=boolean], [name=string], [negTimesOK=boolean], [numFrames=int], [quickTime=boolean], [showInAllViews=boolean], [timeCode=int], [timeCodeTrack=boolean], [timeScale=int], [twentyFourHourMax=boolean], [width=float])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

imagePlane is undoable, queryable, and editable.

The imagePlane command allows querying of various properties of an image plane and any movie in use by the image plane. It also supports creating and edit. The object passed to the command may either be an imagePlane node, or a camera, in which case the command uses the image plane attached to the camera (if any). If no object is passed in, the current selection is used. Currently, most movie related queries work only on 64 bit Windows systems.

Return value

boolean

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

Keywords

image, plane

Related

camera

Flags

camera, counter, detach, dropFrame, fileName, frameDuration, height, imageSize, lookThrough, maintainRatio, name, negTimesOK, numFrames, quickTime, showInAllViews, timeCode, timeCodeTrack, timeScale, twentyFourHourMax, width
Long name (short name) Argument types Properties
camera(c) string createqueryedit
When creating, it will try to attach the created image plane to the specified camera. If the given camera is invalid, creating will fail. When querying, it will query which camera current image plane is attaching to. If it has no camera attached to (free image plane), it will return an empty string. When edit, it will make the image plane attach to the new specified camera. If the camera given is invalid, it will do nothing. When the image plane is attached to a camera, the image plane's transform node will be set identity. The detach command will not restore the original position of the image plane. but the undo command will restore the original position of the image plane.
counter(cn) boolean
Query the 'counter' flag of the movie's timecode format. If this is true, the timecode returned by the -timeCode flag will be a simple counter. If false, the returned timecode will be an array of integers (hours, minutes, seconds, frames).
detach(d) boolean edit
This flag can only be used in the edit mode, when this flag is used in edit, it will detach current image plane from any camera it attaches to and make it a free image plane.
dropFrame(df) boolean query
Query the 'drop frame' flag of the movie's timecode format.
fileName(fn) string createedit
Set the image name for image plane to read.
frameDuration(fd) int query
Query the frame duration of the movie's timecode format.
height(h) float createqueryedit
Height of the image plane. When creating, if this flag is not specified, it will use 10.0 as default height.
imageSize(iz) [int, int] query
Get size of the loaded image.
lookThrough(lt) string createqueryedit
The camera currently used for image plane to look through.
maintainRatio(mr) boolean createqueryedit
Let the image plane respect the picture aspect ratio. When creating, if this flag is not specified, it will use true as default value.
name(n) string createquery
Set the image plane node name when creating or return the image plane name when querying.
negTimesOK(nt) boolean query
Query the 'neg times OK' flag of the movie's timecode format.
numFrames(nf) int query
Query the whole number of frames per second of the movie's timecode format.
quickTime(qt) boolean query
Query whether the image plane is using a QuickTime movie.
showInAllViews(sia) boolean createqueryedit
The flag is used to show the current image plane in all views or not.
timeCode(tc) int query
Query the whole number of frames per second of the movie's timecode format.
timeCodeTrack(tt) boolean query
Query whether the movie on the image plane has a timecode track.
timeScale(ts) int query
Query the timescale of the movie's timecode format.
twentyFourHourMax(tf) boolean query
Query the '24 hour max' flag of the movie's timecode format.
width(w) float createqueryedit
Width of the image plane. When creating, if this flag is not specified, it will use 10.0 as default width.
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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

	import maya.cmds as cmds

	// create image plane with width and height example
	myImagePlane = cmds.imagePlane( width=100, height=50 )

	// create image plane with width and maintainRatio off
	myImagePlane = cmds.imagePlane( width=100, maintainRatio=False )

	// create free image plane with look through camera specified.
	myImagePlane =  cmds.imagePlane( lookThrough="persp")

	// create free image plane with look through camera specified let it only show when looking through this specified camera.
	myImagePlane =  cmds.imagePlane( lookThrough="persp", showInAllViews=false)

	// edit image plane example
	cmds.imagePlane( myImagePlane[1], e=True, w=100, h=200, mr=False ) ;

	// edit free image plane with look through camera specified.
	myImagePlane =  cmds.imagePlane( myImagePlane[1], e=True, lookThrough="side")

	// query image width height example
	cmds.imagePlane( myImagePlane[1], q=True, w=True, h=True ) ;

	// Create image plane with name
	cmds.imagePlane( name="Foo") ;
	cmds.imagePlane( width=100, height=50, name="Foo") ;

	// query loaded image ratio
	cmds.imagePlane( myImagePlane[1], q=True, iz=True );

	// Create image plane under a specified camera
	camera = cmds.camera()
	cmds.imagePlane(camera=camera[1])