imagePlane

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

Synopsis

imagePlane([camera=string], [counter=boolean], [detach=boolean], [dropFrame=boolean], [frameDuration=int], [height=float], [imageSize=[int, int]], [name=string], [negTimesOK=boolean], [numFrames=int], [quickTime=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.

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 query from the "optionVar -q freeImageWidth" for default value. If queried from optionVar failed or it is 0, then use 1.0 as default width.
height(h)	float
Height of the image plane. When creating, if this flag is not specified, it will query from the "optionVar -q freeImageHeight" for default value. If queried from optionVar failed or it is 0, then use 1.0 as default height.
name(n)	string
Set the image plane node name when creating or return the image plane name when querying.
imageSize(iz)	[int, int]
Get size of the loaded image.
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.
detach(d)	boolean
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 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 )
        // edit image plane example
        cmds.imagePlane( myImagePlane[1], e=True, w=100 ) ;
        // query image with height example
        cmds.imagePlane( myImagePlane[1], q=True, w=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])