pymel.core.rendering.imagePlane

imagePlane(*args, **kwargs)

The imagePlane command allows querying of various properties of an image plane and any movie in use by the image plane. 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 queries work only on 64 bit Windows systems.

Flags:

Long name (short name)		Argument Types	Properties
counter (cn)		bool
	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).
dropFrame (df)		bool
	Query the ‘drop frame’ flag of the movie’s timecode format.
frameDuration (fd)		bool
	Query the frame duration of the movie’s timecode format.
negTimesOK (nt)		bool
	Query the ‘neg times OK’ flag of the movie’s timecode format.
numFrames (nf)		bool
	Query the whole number of frames per second of the movie’s timecode format.
quickTime (qt)		bool
	Query whether the image plane is using a QuickTime movie.
timeCode (tc)		bool
	Query the timecode of the current movie frame.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
timeCodeTrack (tt)		bool
	Query whether the movie on the image plane has a timecode track.
timeScale (ts)		bool
	Query the timescale of the movie’s timecode format.
twentyFourHourMax (tf)		bool
	Query the ‘24 hour max’ flag of the movie’s timecode format.

Derived from mel command maya.cmds.imagePlane

Example:

import pymel.core as pm

import maya.cmds as cmds

# query whether the image plane on the persp camera
# is using a QuickTime movie
pm.imagePlane( 'persp', q=True, qt=True )

# get the current timecode
pm.imagePlane( 'persp', q=True, tc=True )