Returns the name of the tool currently in use in the view. This is an internal, undocumented designation but usually corresponds to the name of a node. You can change to a different tool using setCurrentState.

Switch to the view tool.

Sets the currently active tool in the view. state is a string containing an internal, undocumented designation. See currentState().

Executes a command implemented by the active python state. A state command can be invoked by specifying a name identifier along with arguments.

An exception is thrown if the state is not a Python state type or the state is not running.

An implementation example of a COP state command.

import hou
import viewerstate.utils as su

class State(object):
    def __init__(self, state_name, viewer):
        self.state_name = state_name
        self.scene_viewer = viewer    

    def onCommand( self, kwargs ):        
        name = kwargs['command']
        args = kwargs['command_args']

        if name == "myCOPCommand"':
            self.log(f"{name}({args})")

def createViewerStateTemplate():
    """ Mandatory entry point to create and return the viewer state 
        template to register. """

    state_typename = "mycopstate"
    state_label = "My COP State"
    state_cat = hou.copNodeTypeCategory()

    template = hou.ViewerStateTemplate(state_typename, state_label, state_cat)
    template.bindFactory(State)
    template.bindIcon("MISC_python")

    return template            

Here’s how to invoke the command.

import viewerstate.utils as ut

v = ut.findCompositorViewer()       
v.runStateCommand("myCOPCommand", {"arg0":0, "arg1":[1,2,3]})    

Returns this viewer’s current viewport. The current viewport is the one containing the mouse cursor.

Shows or hides a display handle linked to the current tool state. This API is typically used with Python states and can be called from any python state callbacks. Avoid calling showHandle from the python state constructor, because this leads to a runtime error.

See also hou.Handle.show.

Binds a dynamic viewer handle to the current viewer state similarly to hou.ViewerStateTemplate.bindHandle. Unlike bindHandle though, this method creates and initializes the handle in a dynamic fashion so there is no need to register in advance the handle with the viewer state. You can call bindViewerHandle from almost anywhere in Houdini (from the viewer state handlers, from a python script, etc…), but it can only be called while the viewer state is running.

To remove the viewer handles added with bindViewerHandle, use hou.SceneViewer.unbindViewerHandle. Houdini will take care of removing automatically all viewer handles added with bindViewerHandle when the state exits.

This method works only with python states, an exception is raised if the state is not a python state.

Binds a static viewer handle to the current viewer state similarly to hou.ViewerStateTemplate.bindHandleStatic. Unlike bindHandleStatic though, this method creates and initializes the handle in a dynamic fashion so there is no need to register in advance the handle with the viewer state. You can call bindViewerHandleStatic from almost anywhere in Houdini (from the viewer state handlers, from a python script, etc…), but it can only be called while the viewer state is running.

To remove the viewer handles added with bindViewerHandleStatic, use hou.SceneViewer.unbindViewerHandle. Houdini will take care of removing automatically all viewer handles added with bindViewerHandleStatic when the state exits.

This method works only with python states, an exception is raised if the state is not a python state.

Removes a viewer handle from the current python state. unbindViewerHandle can only unbind the viewer handles that were dynamically added with hou.SceneViewer.bindViewerHandle or hou.SceneViewer.bindViewerHandleStatic. An exception is raised if the viewer handle to unbind is a state registered viewer handle.

This method works only with python states, an exception is raised if the state is not a python state.

Not implemented.

Not implemented.

Not implemented.

Not implemented.

Not implemented.

Not implemented.

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.