Indicates whether the IPR session is paused. If there is no active session, this returns false.

Indicates whether the IPR session has an render in progress. Returns True even if the render is paused.

Indicates whether an active IPR sessions exists.

Kills the active IPR session (if there is one).

Pauses the active IPR session (if there is one).

Resumes the active IPR session (if there is one).

Start a new render if there is no active IPR session or issue a re-render if there is one.

Return whether or not the Preview checkbox is checked. When it is unchecked, the viewer will not progressively refine the image using IPR, and will instead use the rendering engine from the ROP node to render it.

See also hou.IPRViewer.setPreview.

Check or uncheck the Preview checkbox.

See hou.IPRViewer.isPreviewOn for more information.

Returns whether or not the Auto Save toggle is selected. When turned on, IPR will periodically save the render progress to the auto save file path. The time between saves can be configured by setting the auto save time.

See also hou.IPRViewer.setAutoSave.

Set or unset the Auto Save toggle.

See hou.IPRViewer.isAutoSaveOn for more information.

Returns the render save path. This is the path that is used when the IPR viewer is set to automatically save render progress to disk.

See also hou.IPRViewer.setSavePath.

Sets the render progress save path.

See also hou.IPRViewer.autoSavePath for more information.

Returns the time between IPR auto saves in seconds. When auto saving is on, a render progress image is written out at this rate.

See also hou.IPRViewer.setAutoSaveTime.

Sets the auto save time in seconds.

See also hou.IPRViewer.autoSaveTime for more information.

Return whether or not the Auto-Update checkbox is checked. When it is unchecked, the viewer will not refresh when objects, shaders, lights, etc. change. In this case, you can force a re-render by clicking on the Render button.

See also hou.IPRViewer.setAutoUpdate.

Check or uncheck the Auto-Update checkbox.

See hou.IPRViewer.isAutoUpdateOn for more information.

Return the contents of the viewer’s Delay field. This value determines how long Houdini waits between when you change a parameter value and when it starts re-rendering.

See also hou.IPRViewer.setDelay and hou.IPRViewer.updateTime.

Set the contents of the viewer’s Delay field.

See hou.IPRViewer.delay for more information.

Return the contents of the viewer’s Update Time field. This value determines approximately how long each progressive refinement should take. Smaller values will produce more progressive renders where detail is added more gradually.

See also hou.IPRViewer.setUpdateTime and hou.IPRViewer.delay.

Set the contents of the viewer’s Update Time field.

See hou.IPRViewer.updateTime for more information.

Return the x and y coordinates for the pixel location where the user last clicked in the IPR viewer. Note that this location might be outside the image: the x and y coordinates can be negative and can be greater than or equal to the image resolution. Note that if the user never clicked in the viewer, the x and y coordinates will be negative.

You would typically call this method from a shelf script. For example, a user can click on a pixel in the IPR viewer and then click on the shelf to perform an action on that pixel (e.g. display the shader parameters, assign a shader, etc.).

Use hou.IPRViewer.imageResolution to get the valid range for pixel coordinates.

Note that when you Ctrl-click on a pixel, Houdini searches $HOUDINI_PATH for scripts/ipr/pickpixel.py and runs it. This script can access the viewer with kwargs["viewer"] and the location where the user clicked with kwargs["position"].

The following script opens a floating parameter window for the shader corresponding to the pixel the user last clicked on.

viewer = hou.ui.paneTabOfType(hou.paneTabType.IPRViewer)
px, py = viewer.lastClickLocation()

if (px < 0 or px > viewer.imageResolution()[0] or
        py < 0 or py >= viewer.imageResolution()[1]):
    hou.ui.displayMessage("Click on the image and then run this script again")
else:
    material = viewer.materialNode(px, py)

    if material is not None:
        parm_window = hou.ui.curDesktop().createFloatingPaneTab(
            hou.paneTabType.Parm)
        parm_window.setCurrentNode(material)
        parm_window.setPin(True)
    else:
        hou.ui.displayMessage("Click on an object to bring up the shader.")

Return the ROP node that is selected in the viewer, or None if nothing is selected.

Set the ROP node to use for rendering.

Return the resolution of the image.

Raises hou.OperationFailed if the viewer does not contain an image.

Return the x0, x1, y0, and y1 normalized coordinates of the subregion that is selected, where (x0, y0) is the bottom-left corner and (x1, y1) is the top-right corner of the subregion.

You can optionally tell the IPR viewer to only re-render only a portion of the image. To select a subportion of the image, hold down shift and select the box.

Note that the bottom-left corner is (0.0, 0.0) and the top-right corner is (1.0, 1.0). For example, if the entire image is being rendered, this method returns (0.0, 1.0, 0.0, 1.0).

Return the names of the image planes in the rendered output.

Note that the special Op_Id image plane contains the hou.Node.sessionId ids of the object nodes in the image. -1 indicates that there is no object node associated with the pixel. Use hou.IPRViewer.objectNode to access the object corresponding to that id.

Similarly, the Prim_Id plane contains the hou.Prim.number ids of the primitives in the image. Use hou.IPRViewer.prim to access the primitive corresponding to that id.

Raises hou.OperationFailed if the viewer does not contain an image.

Return the name of the currently-displayed image plane in the rendered output.

Note that the special Op_Id image plane contains the hou.Node.sessionId ids of the object nodes in the image. -1 indicates that there is no object node associated with the pixel. Use hou.IPRViewer.objectNode to access the object corresponding to that id.

Similarly, the Prim_Id plane contains the hou.Prim.number ids of the primitives in the image. Use hou.IPRViewer.prim to access the primitive corresponding to that id.

Raises hou.OperationFailed if the viewer does not contain an image.

Return the value of a pixel in one plane of the image. This method returns a tuple of 1 to 4 floats, depending on the type of image plane.

Note that the color plane is named C.

Raises hou.OperationFailed if the plane name is invalid, the pixel location is outside the image, or the viewer does not contain an image.

You can determine the number of components in the image plane using the following: len(viewer.pixel(plane_name, 0, 0)).

>>> viewer.pixel("C", 300, 200)
(0.69970703125, 0.46728515625, 0.289794921875, 1.0)

Returns the value of all pixels in one plane of the image. This method returns a tuple of tuples of 1 to 4 floats, depending on the type of image plane. The results are in row-major order, starting at the bottom left corner of the IPR image.

Note that the color plane is named C.

Raises hou.OperationFailed if the plane name is invalid or the viewer does not contain an image.

>>> all_pixels = viewer.pixels("C")
>>> width = viewer.imageResolution()[0]
>>> all_pixels[width*200 + 300]
(0.69970703125, 0.46728515625, 0.289794921875, 1.0)

Returns a JSON string describing the material style sheet at a given pixel. If no style sheet is active, an empty string is returned.

Returns a list of paths to the styles that contribute to the style sheet at the current pixel.

Saves the current IPR render to the specified file path. It is possible to save an in progress/incomplete render.

The output image type is inferred from the file extension on the provided file path. The snapshot parameter controls which IPR snapshot to save. A value of 0 indicates the active render.

The native IPR resolution is used by default, however a custom resolution can be specified with the xres and yres parameters. The color and alpha parameters control which render planes are used when writing RGBA images like .jpg or .png. If a deep image format such as .pic or .exr is used, the scope parameter can be used to specify which image planes to include in the output.

Return the object node contributing the pixel at the specified location, or None if there is no object at the pixel or if the pixel location is outside the image bounds

The following function returns the SOP node containing the geometry that contributes the pixel to the final image:

def sopNode(viewer, x, y):
    obj_node = viewer.objectNode(x, y)
    return (obj_node.renderNode() if obj_node is not None else None)

Raises hou.OperationFailed if the viewer does not contain an image.

Return the geometry primitive contributing the pixel at the specified location, or None if there is nothing at the pixel or if the pixel location is outside the image bounds

Raises hou.OperationFailed if the viewer does not contain an image.

Return the SHOP node contributing the pixel at the specified location, or None if there is nothing at the pixel, the pixel location is outside the image bounds, or there is no shader on the geometry.

This method first checks the primitive corresponding to the pixel and returns the SHOP corresponding to its shop_materialpath attribute. If the primitive does not have this attribute then it returns the SHOP assigned to the object. If no SHOP is assigned to the object, it returns None.

Raises hou.OperationFailed if the viewer does not contain an image.

Query if OpenColorIO is being used for color correction in the viewer.

Enable or disable OpenColorIO for color correction in the viewer.

Set the OpenColorIO display name, view name, or both. The display and view together define the output colorspace for the viewer, and any number of color transforms (Looks) to be performed on the linear viewport image.

Return the current OpenColorIO display used for color correction.

Return the current OpenColorIO view used for color correction.