pymel.core.nodetypes.ImagePlane

class ImagePlane(*args, **kwargs)

class counterpart of mel function imagePlane

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.

detach(val=True, **kwargs)

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 commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.imagePlane

fileName(val=True, **kwargs)

Set the image name for image plane to read.

Derived from mel command maya.cmds.imagePlane

getCamera(**kwargs)

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.

Derived from mel command maya.cmds.imagePlane

getDropFrame(**kwargs)

Query the ‘drop frame’ flag of the movie’s timecode format.

Derived from mel command maya.cmds.imagePlane

getFrameDuration(**kwargs)

Query the frame duration of the movie’s timecode format.

Derived from mel command maya.cmds.imagePlane

getHeight(**kwargs)

Height of the image plane. When creating, if this flag is not specified, it will use 10.0 as default height.

Derived from mel command maya.cmds.imagePlane

getImageSize(**kwargs)

Get size of the loaded image.

Derived from mel command maya.cmds.imagePlane

getLookThrough(**kwargs)

The camera currently used for image plane to look through.

Derived from mel command maya.cmds.imagePlane

getMaintainRatio(**kwargs)

Let the image plane respect the picture aspect ratio. When creating, if this flag is not specified, it will use true as default value.

Derived from mel command maya.cmds.imagePlane

getNegTimesOK(**kwargs)

Query the ‘neg times OK’ flag of the movie’s timecode format.

Derived from mel command maya.cmds.imagePlane

getNumFrames(**kwargs)

Query the whole number of frames per second of the movie’s timecode format.

Derived from mel command maya.cmds.imagePlane

getQuickTime(**kwargs)

Query whether the image plane is using a QuickTime movie.

Derived from mel command maya.cmds.imagePlane

getShowInAllViews(**kwargs)

The flag is used to show the current image plane in all views or not.

Derived from mel command maya.cmds.imagePlane

getTimeCode(**kwargs)

Query the whole number of frames per second of the movie’s timecode format.

Derived from mel command maya.cmds.imagePlane

getTimeCodeTrack(**kwargs)

Query whether the movie on the image plane has a timecode track.

Derived from mel command maya.cmds.imagePlane

getTimeScale(**kwargs)

Query the timescale of the movie’s timecode format.

Derived from mel command maya.cmds.imagePlane

getTwentyFourHourMax(**kwargs)

Query the ‘24 hour max’ flag of the movie’s timecode format.

Derived from mel command maya.cmds.imagePlane

getWidth(**kwargs)

Width of the image plane. When creating, if this flag is not specified, it will use 10.0 as default width.

Derived from mel command maya.cmds.imagePlane

setCamera(val=True, **kwargs)

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.

Derived from mel command maya.cmds.imagePlane

setHeight(val=True, **kwargs)

Height of the image plane. When creating, if this flag is not specified, it will use 10.0 as default height.

Derived from mel command maya.cmds.imagePlane

setLookThrough(val=True, **kwargs)

The camera currently used for image plane to look through.

Derived from mel command maya.cmds.imagePlane

setMaintainRatio(val=True, **kwargs)

Let the image plane respect the picture aspect ratio. When creating, if this flag is not specified, it will use true as default value.

Derived from mel command maya.cmds.imagePlane

setShowInAllViews(val=True, **kwargs)

The flag is used to show the current image plane in all views or not.

Derived from mel command maya.cmds.imagePlane

setWidth(val=True, **kwargs)

Width of the image plane. When creating, if this flag is not specified, it will use 10.0 as default width.

Derived from mel command maya.cmds.imagePlane