Moves/tumbles the viewport to the default view.

Moves/tumbles the view to show all geometry/objects (including templated geometry). See also homeNonTemplated().

Moves/tumbles the view to show the selected geometry/objects.

Homes the viewport on the grid.

Moves/tumbles the view to show all non-templated geometry.

Moves/tumbles the viewport to show an arbitrary area in the scene.

center_to_origin

Moves the view to show all geometry/objects. See also frameNonTemplates().

Moves the view to show an arbitrary area in the scene.

Moves the view to show the selected geometry/objects.

Frames the view on the grid.

Moves the view to show all non-templated geometry.

Returns the transform matrix of the view. To set the viewpoint programmatically, use defaultCamera() to get a hou.ViewportCamera object and manipulate that.

Returns the transform from the modeling space to the space of the points in the geometry. When modeling at object level, this converts from the object space into the SOP’s space. When modeling at the SOP level, this is identity as the model space was the SOP space.

Equivalent to viewTransform, this is the transform matrix of the view. It converts from the camera’s space into the space that modeling is currently being done at.

Returns the transform from normalized device coordinates to the viewport camera’s space. This is often a projective transform, so if used the resulting points will have to be dehomogenized by dividing by w.

Returns the matrix converting from the viewport pixel coordinates to the normalized device coordinates. This is a two dimensional scale and translate, so the z and w components are identity.

Returns the matrix converting from the window pixel viewport coordinates to the viewport pixel coordinates. Window coordinates are present in hou.ViewerEvent and are unaware of quad-view viewports.

This is a two dimensional translate, so z and w components are identity.

Returns a hou.Vector3 representing the view pivot as a point in world space.

Returns the resolution of the viewport in pixels, as (width, height).

If the viewport is currently looking through a camera or light (not necessarily locked to it), this returns an object representing the camera/light’s node. Returns None if the viewport is not looking through a camera/light.

Return the path to the camera that the viewport is looking through. If the viewport isn’t looking through a camera, return an empty string. In objects, this is the path of the camera object node. In LOPs, this is the USD primitive path.

Copies the viewpoint transform of the current view onto the transformation parameters of a camera or light node.

Copies the viewport transform from the transformation parameters of a camera or light onto the current view. This is the same as choosing a camera/light from the Look through submenu in the viewport’s Camera menu.

Returns an object representing the viewport’s viewpoint. The returned object is “live” in that changing its settings will immediately change the view

If a camera/light is locked to the view, changing the settings of the GeometryViewportCamera will change the camera/light node’s parameters as well.

Instead of a live object, you can get a “disconnected” version of the viewpoint using hou.GeometryViewportCamera.stash. This is a useful way to remember a certain viewpoint in code for later. You can restore a “stashed” camera using setDefaultCamera().

# Remember the current view
cam = viewport.defaultCamera()
saved = cam.stash()

# Change the view somehow

# Restore the original view
viewport.setDefaultCamera(saved)

Takes a hou.GeometryViewportCamera and copies its values into this viewport.

Set the current camera settings of the viewport to the settings stored in cam_setting. If the viewport is looking through a camera and the view is not locked to the camera, it will be switched to “No camera”. If the view is locked to the camera, the camera object will be updated instead.

Set the viewport camera to “No camera” and stop looking through a camera object (or light).

Query to see if the camera is locked to the view. This returns the state of the camera lock only; this can be enabled without viewing through a camera.

Set the viewport camera lock. When True, any changes to the view will affect the camera object being viewed though. When False, the camera will become disconnected from the viewport and revert to the default viewport camera when the user tumbles the view. It is possible to enable this without the viewport looking through a camera, though view changes will not affect any objects until the user sets the viewport to look through a camera or light.

Query to see if the view changes are exported to a locked camera continuously (True) or only on mouse release (False).

Set whether the export of view changes to a locked camera happens continuously (True) or only on mouse release (False).

Query if the viewport is currently displaying 2d geometry, often implying it is displaying UV information.

Query if the viewport is currently displaying 3d geometry. This is the case for perspective and ortho viewports.

Request that the viewport redraw. Multiple draw() calls within the same script will be merged into a single call.

Query of the name of the viewport (persp1, top1, etc).

Set the name of the viewport. Setting the name does not affect its type, so naming a perspective view front will be confusing. This is best used in conjunction with changeType().

Returns the hou.GeometryViewportSettings object for this viewport. By calling methods on that object, you can read/edit the viewport’s display options.

Returns the size of this viewport. The tuple elements are returned in viewport coordinates.

1. X position (lower left)

2. Y position (lower left)

3. Width dimension

4. Height dimension

Returns the position and size of this viewport in the UI space. The tuple elements are returned in viewport coordinates, relative to the lower-left corner position of the scene viewer.

1. X position (lower left)

2. Y position (lower left)

3. Width dimension

4. Height dimension

Query the viewport type (UV, 3D, top, left, etc).

Set the viewport type (hou.geometryViewportType). This method first attempts to restore a stashed view for the new viewport type, but failing that, will home the viewport.

Returns whether this viewport uses the construction plane when it is on.

Return the node draw at the specified pixel in the viewport, or None if there is nothing there. The type of node returned depends on the level of the viewer.

If pick_templates is True then templated geometries will be included in the query.

Return the primitive drawn at the specified pixel in the viewport, or None if there is nothing there. The primitive returned will be a subclass of hou.Prim.

The parameter node is used to restrict the query to geometry within a particular node. If node is None, then the query is unrestricted.

Return the geometry currently being inspected in the viewport, or None when nothing is being inspected or when called outside of an inspect script.

Return the primitive currently being inspected in the viewport, or None when nothing is being inspected or when called outside of an inspect script. The primitive returned will be a subclass of hou.Prim.

Convert world coordinates to viewport coordinates.

Convert viewport coordinates to world coordinates. Returns a ray (direction vector and an origin point).

Convert from the Mouse CHOP’s X and Y screen values (which range from -1 to 1) to viewport coordinates, where (0,0) is the bottom left corner of the viewport.

Look up the world position and normal of geometry at viewport coordinates (x,y) where (0,0) is the bottom left corner of the viewport. The returned tuple contains the position, normal, and a boolean flag that is True if there is geometry at that screen position. The selectionRestriction can optionally exclude selected or non-selected prims; it defaults to querying all prims.

Register a Python callback to be called whenever a viewport event occurs.

callback can be used for any geometry viewport event type.

The kwargs contains the following:

• event_type: A viewport event.

• desktop: The desktop object holding the scene viewer.

• viewer: The scene viewer object pointing to the viewport.

• viewport: The viewport object that triggered the event.

import hou

def onViewportCB(**kwargs):
        event_type=kwargs['event_type']
        desktop=kwargs['desktop']
        viewer=kwargs['viewer']
        viewport=kwargs['viewport']

        print( "event type=",event_type )
        print( "desktop=",desktop )
        print( "viewer=",viewer )
        print( "viewport=",viewport )

        cam = viewport.camera()
if cam:
            print( "camera=%s\n\n"%(cam.name()) )

curSceneViewer = [item for item in hou.ui.curDesktop().currentPaneTabs() if item.type() == hou.paneTabType.SceneViewer][0]
curSceneViewer.curViewport().addEventCallback(onViewportCB)

Remove all Python callbacks that have been registered with hou.GeometryViewport.addEventCallback.

Remove a specific Python callback that have been registered with hou.GeometryViewport.addEventCallback.

Return a tuple of all the Python callbacks that have been registered with hou.GeometryViewport.addEventCallback.