imagePlane

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

Synopsis

imagePlane [-camera string] [-counter boolean] [-detach] [-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]

imagePlane is undoable, queryable, and editable.

Return value

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

Keywords

Related

Flags

Long name (short name)	Argument types	Properties
-quickTime(-qt)	boolean
Query whether the image plane is using a QuickTime movie.
-timeCodeTrack(-tt)	boolean
Query whether the movie on the image plane has a timecode track.
-dropFrame(-df)	boolean
Query the 'drop frame' flag of the movie's timecode format.
-twentyFourHourMax(-tf)	boolean
Query the '24 hour max' flag of the movie's timecode format.
-negTimesOK(-nt)	boolean
Query the 'neg times OK' flag of the movie's timecode format.
-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).
-timeScale(-ts)	int
Query the timescale of the movie's timecode format.
-frameDuration(-fd)	int
Query the frame duration of the movie's timecode format.
-numFrames(-nf)	int
Query the whole number of frames per second of the movie's timecode format.
-timeCode(-tc)	int
Query the whole number of frames per second of the movie's timecode format.
-width(-w)	float
Width of the image plane. When creating, if this flag is not specified, it will use 10.0 as default width.
-height(-h)	float
Height of the image plane. When creating, if this flag is not specified, it will use 10.0 as default height.
-name(-n)	string
Set the image plane node name when creating or return the image plane name when querying.
-fileName(-fn)	string
Set the image name for image plane to read.
-imageSize(-iz)	int int
Get size of the loaded image.
-maintainRatio(-mr)	boolean
Let the image plane respect the picture aspect ratio. When creating, if this flag is not specified, it will use true as default value.
-camera(-c)	string
When creating, it will try to attach the created the 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 attaches to(like free image plane), it will return 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.
-lookThrough(-lt)	string
The camera currently used for image plane to look through.
-showInAllViews(-sia)	boolean
The flag is used to show the current image plane in all views or not.
-detach(-d)
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.

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

	// create image plane with width and height example
	string $myImagePlane[] = `imagePlane -w 100 -h 50` ;
	// create image plane with width and maintainRatio off
	string $myImagePlane[] = `imagePlane -w 100 -mr false` ;
	// create free image plane with look through camera specified.
	string $myImagePlane[] = `imagePlane -lt "persp"` ;
	// create free image plane with look through camera specified let it only show when looking through this specified camera.
	string $myImagePlane[] = `imagePlane -lt "persp" -sia false` ;
	// edit image plane example
	imagePlane -e -w 100 -h 200 -mr false $myImagePlane[1] ;
	// edit free image plane with look through camera specified.
	imagePlane -e -lt "side" $myImagePlane[1];
	// query image width height example
	imagePlane -q -w -h $myImagePlane[1] ;
	// Create image plane with name
	imagePlane -n "Foo" ;
	imagePlane -w 100 -h 50 -n "Foo" ;
	// query loaded image ratio
	imagePlane -q -iz $myImagePlane[1];
	// Create image plane under a specified camera
	string $camera[] = `camera`;
	imagePlane -camera $camera[1];