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.
In query mode, return type is based on queried flag.
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)
|
|
|
|
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.
|
|