pymel.core.rendering.iprEngine¶

iprEngine(*args, **kwargs)¶

Command to create or edit an iprEngine. A iprEngine is an object that watches for changes to shading networks and automatically reshades to generate an up-to-date image.

Flags:

Long Name / Short Name		Argument Types	Properties
copy / cp		unicode
	Copies the deep raster file, as well as its related files, to the new location.
defineTemplate / dt		unicode
	Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
diagnostics / dig		bool
estimatedMemory / mem		bool
	Displays the estimated memory being used by IPR.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
iprImage / ipr		unicode
	Specify the ipr image to use.
motionVectorFile / mvf		bool
	Returns the name of the motion vector file used by IPR.
object / obj		PyNode
	The objects to be tuned.
region / r		int, int, int, int
	The coordinates of the region to be tuned. The integers are in the sequence left bottom right topor x1,y2 x2,y2
relatedFiles / rel		bool
	Returns the names for the related files, e.g, the non-glow-non-blur image, the motion vector file, and the depth-map files.
releaseIprImage / rii		bool
	The ipr image should be released and memory should be freed.
resolution / res		bool
	The width and height of the ipr file.
scanlineIncrement / sli		unicode
	Set the scanline increment percentage. If the height of the region being update is 240 pixels, and the scanlineIncrement is 10% then the image will refresh blocks of 24 scanlines.
showProgressBar / spb		bool
	Show progress bar during tuning.
startTuning / st		bool
	An ipr image has been specified and now changes to shading networks should force an image to be produced.
stopTuning / spt		bool
	Tuning should cease but ipr image should not be closed.
underPixel / un		int, int
	Get list of objects under the pixel sprcified.
update / u		bool
	Force an update.
updateDepthOfField / udf		bool
	Force a refresh of depth-of-field.
updateLightGlow / ulg		bool
	Automatically update when light glow changes.
updateMotionBlur / umb		bool
	Automatically update when 2.5D motion blur changes.
updatePort / up		unicode
	The name of the port that is to be updated when pixel values are recomputed. (not currently supported)
updateShaderGlow / usg		bool
	Automatically update when shader glow changes.
updateShading / us		bool
	Automatically update shading.
updateShadowMaps / usm		bool
	Force the shadow maps to be generated and an update to occur.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.iprEngine

Example:

import pymel.core as pm

# Create a iprEngine and tell it about an already created ipr image.
pm.iprEngine(ipr='iprImages/persp_scene1_ipr.iff')

# Tell the iprEngine about the region to update.
pm.iprEngine( 'iprEngine1', e=True, region=(10, 10, 100, 100))

# Tell the iprEngine to watch changes and update pixels.
pm.iprEngine( 'iprEngine1', e=True, startTuning=True )