| On this page |
VEX ¶
-
ocio_aliases returns the list of aliases for a given color space.
-
ocio_aliases returns the full name defined by the OCIO config for the given color space.
-
ocio_nanocolorname returns the Nanocolor name identifier of the given color space. Not all color spaces have a corresponding Nanocolor name, so this function may return an empty string.
-
vertexprimuv returns the intrinsic uv location of the vertex in the primitive.
-
volumetransform returns transform between various spaces connected to a volume.
-
minjerk samples position, velocity, and acceleration for a MinJerk curve.
-
random_shash hashes a string to an integer.
-
implicitsurface evaluates a compound implicit surface.
-
implicitsurfacebounds returns an SDF min/max interval over a sphere around a point.
-
implicitsurfacevel evaluates implicit surface SDF, normal, and surface velocity.
-
osd_limitcurvature computes principal curvature values and directions at a point attribute evaluated on the subdivision limit using Open Subdiv.
-
osd_limitnormal computes the normal to a point attribute evaluated at the subdivision limit using Open Subdiv.
-
osd_limitvertex evaluates a vertex attribute at the subdivision limit surface using Open Subdiv, and also evaluates all first and second partial derivatives with respect to the given attribute.
-
usd_bindmaterial binds a material to a given primitive.
-
osd_limitgradient computes the gradient to a scalar point attribute evaluated at the subdivision limit using Open Subdiv and maps the gradient into the tangent space of a given vector point attribute (typically
P). -
qexp computes the exponential of a quaternion.
-
qlog computes the natural logarithm of a quaternion.
-
qpow raises the quaternion to the power of the exponent.
OpenCL ¶
For more information about OpenCL in Houdini, please read the OpenCL for VEX users page. There you’ll also find the descriptions for the new functions listed here.
-
osd / noosd | Default noosd
-
@name.osd_facecount() -
@name.osd_patchcount() -
@name.osd_firstpatch(face) -
@name.osd_patchcount_face(face) -
@name.osd_lookuppatch(face, face_u, face_v, patch, patch_u, patch_v) -
@name.osd_lookupface(patch, patch_u, patch_v, face, face_u, face_v) -
@name.osd_limitsurface(patch, u, v) -
@name.osd_limit(patch, u, v, du, dv) -
@name.osd_limitnormal(patch, u, v)
-
Certain feature flags can add more helper methods to attribute bindings. In particular, the
osdflag adds Open Subdiv queries that mirror the corresponding VEXosd_*functions, but operate on the currently bound attribute so they do not take a geometry or attribute name argument.
HOM ¶
-
The hou.ApexUniGraphDebugger class is a debugger that runs an Apex graph and captures its values.
-
The hou.Camera class stores camera data and a transform.
-
The hou.CameraPrim class is a geometry primitive that stores camera data.
-
The hou.cameraProjection module defines the type of projection a camera primitive can use.
-
The hou.ChannelEditor class represents a Channel Editor pane tab. This replaces the hou.ChannelEditorPane class.
-
The hou.channelGraphSelectionMode module is an enumeration of selection modes for the channel editor graph view.
-
The hou.ChannelListPaneTab class manages the pane tab.
-
The hou.CompositorViewerEvent class represents user interface events in the compositor viewer.
-
The hou.CopCable class lists the named COP objects (wires).
-
The hou.DetachedAttrib class contains the attribute values of an attribute separated from the original geometry.
-
The hou.nodeConnectionDrawStyle module determines the shape of the connection wires between nodes in the network editor.
-
The hou.OpenCLDevice class describes a single OpenCL device that Houdini can use for computing.
Note
You can’t construct this class directly.
-
The hou.openCLDeviceType module is an enumeration of OpenCL device types.
-
The hou.UniNode class represents an APEX node that lives in an APEX graph.
-
The hou.UniNodeConnection class represents a UNI wire connection between two ports of the UNI nodes.
-
The hou.UniStickyNote class represents a sticky note in a UNI network.
-
The hou.UniNodeType class specializes the hou.NodeType class for UNI node types.
-
The hou.UniNodeTypeCategory class represents the node type category for UNI node types.
-
The hou.ViewerHandleDragger2D dragger class manipulates the hou.Drawable2D objects of a Python viewer handle in a 3D space.
-
The hou.ViewerStateDragger2D dragger class manipulates the hou.Drawable2D objects of a Python viewer state in a 3D space.
-
hou.AgentShapeLibrary.removeShape() removes a shape from the shape library.
-
In hou.AdvancedDrawable:
-
hou.AdvancedDrawable.isVisibleInViewport() sees if this drawable is visible in the viewport.
-
hou.AdvancedDrawable.setVisibleInAllViewports() removes all per-viewport visibility restrictions so the drawable is shown in all viewports.
-
hou.AdvancedDrawable.setVisibleInViewport() restricts the drawable so it’s visible in only the viewport.
-
-
In hou.ApexNode:
-
hou.ApexNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.ApexNode.convertSubgraphToSubnet() converts a node that represents a subgraph asset into a subnet.
-
hou.ApexNode.debugger() returns the Apex debugger for the graph that contains this node.
-
hou.ApexNode.inputDebugData() returns the value of the input port captured by the debugger.
-
hou.ApexNode.outputDebugData() returns the value of the output port captured by the debugger.
-
hou.ApexNode.isEditableSubnet() returns
Trueif this node represents a subnet, and the contents of this subnet can be modified. -
hou.ApexNode.properties() returns the node’s properties.
-
hou.ApexNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.Attrib:
-
hou.Attrib.dictCount() returns the number of entries in the attribute’s dictionary table.
-
hou.Attrib.stringCount() returns the number of entries in the attribute’s string table.
-
-
hou.attribType.Invalid() enum invalid geometry attribute type.
-
In hou.ButtonParmTemplate:
-
hou.ButtonParmTemplate.iconNames() returns the tuple of icons corresponding to the menu items.
-
hou.ButtonParmTemplate.itemGeneratorScript() returns the script used to generate menu items.
-
hou.ButtonParmTemplate.itemGeneratorScriptLanguage() returns the script used to generate menu items.
-
hou.ButtonParmTemplate.menuItems() returns the tuple of internal menu names.
-
hou.ButtonParmTemplate.menuLabels() returns the tuple of menu labels displayed in the user interface.
-
hou.ButtonParmTemplate.menuType() returns the type of menu.
-
hou.ButtonParmTemplate.menuUseToken() returns whether the parameter is set to the token value instead of the index.
-
hou.ButtonParmTemplate.setIconNames() sets the icon names to the given sequence of strings.
-
hou.ButtonParmTemplate.setItemGeneratorScript() sets the script used to generate menu items.
-
hou.ButtonParmTemplate.setItemGeneratorScriptLanguage() sets the script language used to generate menu items to a hou.scriptLanguage enum value.
-
hou.ButtonParmTemplate.setMenuItems() sets the internal menu names to the given sequence of strings.
-
hou.ButtonParmTemplate.setMenuLabels() sets the menu labels displayed in the user interface to the given sequence of strings.
-
hou.ButtonParmTemplate.setMenuType() sets the type of menu to a hou.menuType enum value.
-
hou.ButtonParmTemplate.setMenuUseToken() sets whether the parameter is set to the token value instead of the index.
-
-
In hou.ChannelGraph:
-
hou.ChannelGraph.clearRetimeMarkers() removes all retime markers.
-
hou.ChannelGraph.insertRetimeMarker() inserts a retime marker at time (in seconds).
-
hou.ChannelGraph.selectionMode() returns the current graph selection mode.
-
hou.ChannelGraph.setSelectionMode() sets the graph selection mode.
-
hou.ChannelGraph.deleteRetimeMarker() removes the retime marker at
index. -
hou.ChannelGraph.deleteRetimeMarkers() removes all markers whose indices fall within
range(inclusive). -
hou.ChannelGraph.deleteSelectedRetimeMarkers() removes the currently selected retime markers
-
hou.ChannelGraph.moveRetimeMarkers() moves the markers in
rangebydeltaseconds. -
hou.ChannelGraph.moveSelectedRetimeMarkers() moves the currently selected retime markers by
deltaseconds. -
hou.ChannelGraph.retimeMarkerSelection() returns the selected marker index range as a
(min, max)tuple (inclusive). -
hou.ChannelGraph.retimeMarkers() returns the time position (in seconds) of each retime marker.
-
hou.ChannelGraph.setRetimeMarkerSelection() sets the retime marker selection to the given index range.
-
-
In hou.ChannelPrim:
-
hou.ChannelPrim.isAllMuted() returns
Trueif the entire channel is muted. -
hou.ChannelPrim.isAllUnmuted() returns
Trueif the channel has no muted ranges. -
hou.ChannelPrim.isMuted() returns
Trueif the channel is muted at the given frame. -
hou.ChannelPrim.mute() mutes a range of the channel.
-
hou.ChannelPrim.muteAll() mutes the entire channel.
-
hou.ChannelPrim.unmute() unmutes a range of the channel.
-
hou.ChannelPrim.unmuteAll() unmutes the entire channel.
-
-
In hou.ChopNode:
-
hou.ChopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.ChopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.Cop2Node:
-
hou.Cop2Node.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.Cop2Node.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.CopNode:
-
hou.CopNode.attrib() returns the detached attribute computed by this COP node.
-
hou.CopNode.attribAtFrame() returns the detached attribute computed by this COP node that’s cooked at the specified frame.
-
hou.CopNode.cable() returns the COP cable computed by this COP node.
-
hou.CopNode.cableAtFrame() returns the COP cable computed by this COP node that’s cooked at the specified frame.
-
hou.CopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.CopNode.pairedNode() returns the node paired to this COP.
-
hou.CopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.DopNode:
-
hou.DopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.DopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
hou.DopObject.guideGeometry() returns guide geometry associated with a DopData specified by the
data_nameparameter. -
In hou.Drawable2D:
-
COP’s Layer Auto-Alignment:
-
New support for positioning and orienting drawables relative to a COP layer assigned to a Python state or Python handle.
-
New support for positioning drawables relative to the COP layer’s scale.
-
hou.Drawable2D.drawTransform returns the drawing transform matrix currently used by the drawable.
-
hou.Drawable2D.layerTransform returns the COP layer transform matrix used as the reference transform for the drawable.
-
hou.Drawable2D.postScale returns the post-scale vector used during rendering to position the drawable.
-
hou.Drawable2D.postTransform returns the post-transform matrix currently assigned to the drawable.
-
-
Fixed-size rendering:
-
New support to enable the rendering of hou.Drawable2D object with a fixed size.
-
hou.Drawable2D.fixedSizeScale Returns the scale factor used for fixed-size rendering.
-
hou.Drawable2D.isFixedSize returns
Trueif the drawable is rendered at a fixed size. -
hou.Drawable2D.setFixedSize sets whether this drawable is rendered at a fixed size.
-
-
hou.Drawable2D.postMulTransform post-multiplies the drawable’s transform with xform.
-
hou.Drawable2D.preMulTransform pre-multiplies the drawable’s transform with xform.
-
hou.Drawable2D.imageLayer() returns the image layer displayed by this drawable.
-
hou.Drawable2D.setImageLayer sets an image layer on this drawable for display.
-
-
In hou.GadgetDrawable:
-
hou.GadgetDrawable.isVisibleInViewport() sees if this drawable is visible in the viewport.
-
hou.GadgetDrawable.setVisibleInAllViewports() removes all per-viewport visibility restrictions so the drawable is shown in all viewports.
-
hou.GadgetDrawable.setVisibleInViewport() restricts the drawable so it’s visible in only the viewport.
-
-
In hou.Geometry:
-
hou.Geometry.createCameraPrim() creates and adds a camera primitive to the geometry and returns it.
-
hou.Geometry.primByName() returns a primitive by looking up its name attribute.
-
hou.Geometry.vertex() returns the vertex at the specified linear vertex index.
-
hou.Geometry.pointFloatListAttribValues() returns a tuple of tuples of floats containing one attribute’s values for all the points.
-
hou.Geometry.pointIntListAttribValues() returns a tuple of tuples of integers containing one attribute’s values for all the points.
-
hou.Geometry.pointStringListAttribValues() returns a tuple of tuples of strings containing one attribute’s values for all the points.
-
hou.Geometry.primFloatListAttribValues() returns a tuple of tuples of floats containing one attribute’s values for all the primitives.
-
hou.Geometry.primIntListAttribValues() returns a tuple of tuples of integers containing one attribute’s values for all the primitives.
-
hou.Geometry.primStringListAttribValues() returns a tuple of tuples of strings containing one attribute’s values for all the primitives.
-
hou.Geometry.vertexFloatListAttribValues() returns a tuple of tuples of floats containing one attribute’s values for all the vertices.
-
hou.Geometry.vertexIntListAttribValues() returns a tuple of tuples of integers containing one attribute’s values for all the vertices.
-
hou.Geometry.vertexStringListAttribValues() returns a tuple of tuples of strings containing one attribute’s values for all the vertices.
-
-
In hou.GeometryDrawable:
-
hou.GeometryDrawable.isVisibleInViewport() sees if this drawable is visible in the viewport.
-
hou.GeometryDrawable.setVisibleInAllViewports() removes all per-viewport visibility restrictions so the drawable is shown in all viewports.
-
hou.GeometryDrawable.setVisibleInViewport() restricts the drawable so it’s visible in only the viewport.
-
hou.drawableGeometryType.Sprite enum sprite drawable type that works with point geometries and lets you draw interactive images aligned with the view in world space or screen space.
-
-
In hou.GeometryDrawableGroup:
-
hou.GeometryDrawableGroup.isVisibleInViewport() sees if this drawable is visible in the viewport.
-
hou.GeometryDrawableGroup.setVisibleInAllViewports() removes all per-viewport visibility restrictions so the drawable is shown in all viewports.
-
hou.GeometryDrawableGroup.setVisibleInViewport() restricts the drawable so it’s visible in only the viewport.
-
-
In hou.GeometryViewport:
-
hou.GeometryViewport.isVisible() returns
Trueif this viewport is visible to the user. -
hou.GeometryViewport.isViewingThroughExtraCamera() returns
Trueif the viewport is looking though a camera provided by a state or drawable. -
hou.GeometryViewport.setCameraParms() provides camera parameters to the viewport when it’s looking through an extra camera provided by a state or drawable.
-
hou.GeometryViewport.tearOffCopy() opens a floating viewport with its display options set to this viewport’s settings.
-
-
In hou.GeometryViewportSettings:
-
hou.GeometryViewportSettings.copy() copies the settings from another viewport settings object.
-
hou.GeometryViewportSettings.setTransparencyCutoff() determines the cutoff value when
Transparency Qualityis set toCutout. -
hou.GeometryViewportSettings.transparencyCutoff() sets the alpha cutoff value for
Cutoutstyle transparency. -
hou.GeometryViewportSettings.getInstancedLightLimit() returns the maximum number of instanced lights to use in HQ Lighting.
-
hou.GeometryViewportSettings.gsplatsAlphaCulling() the alpha threshold used to cull Gaussian splats.
-
hou.GeometryViewportSettings.setGsplatsAlphaCulling() culls Gaussian splats whose alpha is below this threshold.
-
hou.GeometryViewportSettings.setInstancedLightLimit() sets the maximum number of instanced lights to contribute to lighting in HQ Lighting.
-
hou.GeometryViewportSettings.imageLayerFiltering() queries if filtering is on for image layers in the viewport.
-
hou.GeometryViewportSettings.setImageLayerFiltering() when on, image layers in the viewport smoothly interpolate pixel values.
-
-
hou.hipFileEventType.BeforeQuit enum event triggers when the user quits Houdini, before the save-changes prompt for the current .hip file is shown.
-
In hou.ImageLayer:
-
hou.ImageLayer.computeAverage() returns the layer’s average value across all pixels of the selected channel.
-
hou.ImageLayer.computeMax() returns the layer’s maximum value across all pixels of the selected channel.
-
hou.ImageLayer.computeMin() returns the layer’s minimum value across all pixels of the selected channel.
-
hou.ImageLayer.computeMaxLength() returns the layer’s maximum Euclidean length value across all the pixels.
-
hou.ImageLayer.computeMinLength() returns the layer’s minimum Euclidean length value across all the pixels.
-
hou.ImageLayer.expandConstant() expands constant layers into dense layers.
-
hou.ImageLayer.imagingDistance() sets the location of the camera’s imaging plane.
-
hou.ImageLayer.image3ToWorld() converts a 3-tuple from image space to world space.
-
hou.ImageLayer.imageToWorld() converts a 2-tuple from image space to world space.
-
hou.ImageLayer.image3ToLocal() converts a 3-tuple from image space to local space.
-
hou.ImageLayer.imageToLocal() converts a 2-tuple from image space to local space.
-
hou.ImageLayer.worldToImage() converts a 3-tuple from world space to image space, returning a 2-tuple.
-
hou.ImageLayer.isMetadataOnly() returns
Trueif the layer is a metadata layer and holds no pixel values. -
hou.ImageLayer.setIsMetadataOnly() marks this layer as being metadata only.
-
hou.ImageLayer.transform() modifies the image to world transform by applying an additional transform afterward.
-
hou.ImageLayer.guideScale() the size of the camera that’s displayed when the layer is metadata.
-
hou.ImageLayer.setGuideScale() sets the camera’s guide scale.
-
hou.ImageLayer.voxelSize() returns the layer’s world space voxel size.
-
hou.ImageLayer.worldToImage3() converts a 3-tuple from world space to image space, returning a 3-tuple.
-
hou.ImageLayer.worldToLocal() converts a 3-tuple from world space to local space, returning a 3-tuple.
-
hou.ImageLayer.localToWorld() converts a 3-tuple from local space to world space, returning a 3-tuple.
-
hou.ImageLayer.localToImage() converts a 3-tuple from local space to image space, returning a 2-tuple.
-
hou.ImageLayer.localToImage3() converts a 3-tuple from local space to image space, returning a 3-tuple.
-
hou.ImageLayer.setBufferIndex() sets a layer to the value at the buffer coordinate (x, y).
-
hou.ImageLayer.setBufferIndexI() sets an integer layer to the value at the buffer coordinate (x, y).
-
hou.ImageLayer.setBufferIndexV4() sets an RGBA layer to the value at the buffer coordinate (x, y).
-
hou.ImageLayer.setImageToWorldTransform() sets the transform from image space to world space.
-
hou.ImageLayer.setImagingDistance() sets the camera’s imaging distance.
-
hou.ImageLayer.properties() returns the layer properties present on this layer.
-
hou.ImageLayer.setProperties() replaces the layer properties with the provided dictionary.
-
hou.ImageLayer.updateProperties() updates the layer properties with the provided dictionary, replacing any matching keys.
-
-
In hou.LopNetwork:
-
hou.LopNetwork.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.LopNetwork.defaultState() returns a string with the name of the default viewer state for controlling this node.
-
hou.LopNetwork.selectionPaths() returns a list of pxr.Sdf.Path objects that represent all scene graph locations currently selected in the LOP Network parent of this LOP node.
-
hou.LopNetwork.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
hou.LopNetwork.setSelectionPaths() accepts a list of pxr.Sdf.Path objects that hold the scene graph locations that should become the selection in the LOP Network parent of this LOP node.
-
-
In hou.LopNode:
-
hou.LopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.LopNode.inEditLayerBlock() returns
Trueif this LOP node is inside an Edit Layer Block. -
hou.LopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.LopSelectionRule:
-
hou.LopSelectionRule.findPointInstancerIds() returns
Trueif this LOP selection rule is set to return point instancer instance IDs. -
hou.LopSelectionRule.pointInstancerIds() if this LOP selection rule is configured to find point instancer IDs, this method returns a dictionary of point instancer prim paths to the set of instance IDs that match the pattern.
-
hou.LopSelectionRule.setFindPointInstancerIds() configures this LOP selection rule to return primitive paths and, for point instancers, specific instance ID values.
-
-
hou.LopViewportOverrides.setXforms() applies transforms to prims or point instances in the viewport overrides layer.
-
hou.lopViewportOverridesLayer.ViewportState enum viewport state.
-
hou.MenuParmTemplate.isButton() returns whether the parameter is a button parameter with a menu.
-
In hou.NanoVDB:
-
hou.NanoVDB.computeAverage() returns the VDB’s average value across all voxels of the selected channel.
-
hou.NanoVDB.computeMax() returns the VDB’s maximum value across all voxels of the selected channel.
-
hou.NanoVDB.computeMin() returns the VDB’s minimum value across all voxels of the selected channel.
-
hou.NanoVDB.channelCount() returns the number of channels in the VDB.
-
hou.NanoVDB.computeMaxLength() returns the VDB’s maximum Euclidean length value across all the voxels.
-
hou.NanoVDB.computeMinLength() returns the VDB’s minimum Euclidean length value across all the voxels.
-
hou.NanoVDB.properties() returns the VDB properties present on this VDB.
-
hou.NanoVDB.setProperties() replaces the VDB properties with the provided dictionary.
-
hou.NanoVDB.updateProperties() updates the VDB properties with the provided dictionary, replacing any matching keys.
-
hou.NanoVDB.resolution() returns the x, y, and z dimensions of the active leaves.
-
-
In hou.NetworkEditor:
-
hou.NetworkEditor.multiParmTab() returns the currently visible tab index using a parameter name.
-
hou.NetworkEditor.setMultiParmTab() switches a multiparameter tab to a given tab using a parameter name.
-
hou.NetworkEditor.revertToNetworkViewOnEmpty() returns
TrueifsetRevertToNetworkViewOnEmpty(True)is called on thehou.paneTabType.ApexEditororhou.paneTabType.UsdShadeEditorpanes. -
hou.NetworkEditor.setRevertToNetworkViewOnEmpty() if the network editor is a
hou.paneTabType.ApexEditororhou.paneTabType.UsdShadeEditortype pane, set this flag toTrueso the pane switches tohou.paneTabType.NetworkEditorwhen the current node can’t provide a graph of the correct type. -
hou.NetworkEditor.isShowingParmDialog() returns
Trueif the Network Editor’s embedded parameter dialog is currently visible. -
hou.NetworkEditor.parmPythonPanelInterface() returns the Python Panel interface corresponding to the embedded parameter dialog’s current node if the interface exists and the dialog is visible.
-
hou.NetworkEditor.parmPythonPanelInterfaceRootWidget() returns a reference to the user-defined root widget created by the active Python Panel interface in the embedded parameter dialog.
-
hou.NetworkEditor.setShowParmDialog() shows or hides the Network Editor’s embedded parameter dialog.
-
hou.NetworkEditor.translate() shifts the view by delta (a
hou.Vector2in network space coordinates).
-
-
In hou.Node:
-
hou.Node.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.Node.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.ObjNode:
-
hou.ObjNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.ObjNode.revertParmInterface() reverts the parameter interface by moving all spare parameters to after the base parameters.
-
hou.ObjNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.OpNode:
-
hou.OpNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.OpNode.graphEditorPaneTabType() returns the type of pane tab that can be used to edit graph data for nodes that own editable graph data.
Note
All node classes that inherit the hou.OpNode class also add this method.
-
hou.OpNode.revertParmInterface() reverts the parameter interface by moving all spare parameters to after the base parameters.
-
hou.OpNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
hou.OpNode.toggleChildExportFlag() toggles the presence of an export flag on children of this node.
-
-
In hou.OpNodeType:
-
hou.OpNodeType.boundHandles() returns a dictionary of unique handle binding descriptions to the type of bound handle.
-
Given a bound handle description (returned as a key in the dictionary returned by boundHandles), hou.OpNodeType.handleBindings() returns a dictionary of handle parameters to the node parameter bound to that handle parameter.
-
-
hou.paneTabType.GenericGraphEditor and hou.paneTabType.UsdShadeEditor enum pane tab types.
-
In hou.ParameterEditor:
-
hou.ParameterEditor.pythonPanelInterface() returns the Python Panel interface corresponding to the Parameter Editor’s current node.
-
hou.ParameterEditor.pythonPanelInterfaceRootWidget() returns a reference to the user-defined root widget created by the active Python Panel interface corresponding to the Parameter Editor’s current node.
-
-
In hou.Parm:
-
hou.Parm.childrenAsData() returns a JSON-like structure when this parameter is a folder parameter that represents any parameters inside that folder.
-
hou.Parm.evalAsCopCable() evaluates this parameter at the current frame and returns the result as a
hou.CopCableobject. -
hou.Parm.evalAsCopCableAtFrame() evaluates this parameter at a certain frame and returns the result as a
hou.CopCableobject. -
hou.Parm.evalAsDetachedAttrib() evaluates this parameter at the current frame and returns the result as a
hou.DetachedAttribobject. -
hou.Parm.evalAsDetachedAttribAtFrame() evaluates this parameter at a certain frame and returns the result as a
hou.DetachedAttribobject. -
hou.Parm.clearDefaultRange() removes the default slider range for this parameter.
-
hou.Parm.isRangeAtDefault() returns whether the slider range of this parameter in the parameter editor is at its default.
-
hou.Parm.rangeMax() returns the maximum slider range of this parameter in the parameter editor.
-
hou.Parm.rangeMin() returns the minimum slider range of this parameter in the parameter editor.
-
hou.Parm.setDefaultRange() sets a default slider range for this parameter, stored in the node’s user data.
-
hou.Parm.setRange() sets the slider range of this parameter in the parameter editor.
-
hou.Parm.setRangeToDefault() sets the slider range of this parameter in the parameter editor to its default.
-
-
In hou.ParmTuple:
-
hou.ParmTuple.childrenAsData() returns a JSON-like structure when this parameter is a folder parameter that represents any parameters inside that folder.
-
hou.ParmTuple.clearDefaultRange() removes the default slider range for this parameter.
-
hou.ParmTuple.setDefaultRange() sets a default slider range for this parameter.
-
hou.ParmTuple.evalAsDetachedAttribs() evaluates this parameter tuple at the current frame and returns the result as a tuple containing a
hou.DetachedAttribobject. -
hou.ParmTuple.evalAsDetachedAttribsAtFrame() evaluates this parameter tuple at a certain frame and returns the result as a tuple containing a
hou.DetachedAttribobject. -
hou.ParmTuple.insertMultiParmInstance() inserts a new multiparameter instance before the given index or appends a new multiparameter instance.
-
hou.ParmTuple.isRangeAtDefault() returns whether the slider range of this parameter in the parameter editor is at its default.
-
hou.ParmTuple.moveDownMultiParmInstance() performs a move down operation on a multiparameter instance at the given index.
-
hou.ParmTuple.moveMultiParmInstances() performs a sequence of move operations on multiparameter instances.
-
hou.ParmTuple.moveUpMultiParmInstance() performs a move up operation on a multiparameter instance at the given index.
-
hou.ParmTuple.rangeMax() returns the maximum slider range of this parameter in the parameter editor.
-
hou.ParmTuple.rangeMin() returns the minimum slider range of this parameter in the parameter editor.
-
hou.ParmTuple.removeMultiParmInstance() removes the multiparameter instance at the given index.
-
hou.ParmTuple.setRange() sets the slider range of this parameter in the parameter editor.
-
hou.ParmTuple.setRangeToDefault() sets the slider range of this parameter in the parameter editor to its default.
-
hou.ParmTuple.isVisible() returns whether this parameter is visible in the parameter dialog for this node.
-
-
hou.PointGroup.containsNumber() returns whether or not the point with the given index is in this group.
-
hou.PrimGroup.containsNumber() returns whether or not the primitive with the given index is in this group.
-
hou.primType.CameraPrim enum camera and hou.primType.Plane enum plane primitive types.
-
In hou.RopNode:
-
hou.RopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.RopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.SceneViewer:
-
hou.SceneViewer.isSnappingToDrawables() returns whether snapping to drawables is on for the current snapping mode.
-
hou.SceneViewer.setSnapToDrawables() sets whether snapping to drawables is on or off for the current snapping mode.
-
hou.SceneViewer.pinCamera() pins or unpins a camera to the Scene Viewer.
-
hou.SceneViewer.setExtraCameras() lists camera names that the state is creating.
-
hou.SceneViewer.extraCameras() returns a list of all extra cameras registered with
setExtraCameras. -
hou.SceneViewer.showHydraProcedurals() sets whether Hydra procedurals can display in the viewport in LOPs.
-
hou.SceneViewer.showingHydraProcedurals() returns
Trueif the display of Hydra procedurals in the LOP viewport is on. -
hou.SceneViewer.toggleStateDialogWindow() toggles the dialog window of the current viewer state.
-
-
hou.sceneViewerEvent.RendererChanged enum sent when the LOP viewer render delegate changes.
-
hou.sceneViewerEvent.ViewportCreated enum sent when a tear off copy of the viewer is made.
-
hou.Shelf.setShortLabel() sets and hou.Shelf.shortLabel() returns the object’s short label.
-
hou.ShelfElement.setShortLabel() sets and hou.ShelfElement.shortLabel() returns the object’s short label.
-
hou.ShelfSet.setShortLabel() sets and hou.ShelfSet.shortLabel() returns the object’s short label.
-
In hou.ShopNode:
-
hou.ShopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.ShopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.SimpleDrawable:
-
hou.SimpleDrawable.isSnappable() returns
Trueif snapping to this drawable is allowed. -
hou.SimpleDrawable.setSnappable() controls whether snapping to this drawable is allowed.
-
-
In hou.SopNode:
-
hou.SopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.SopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.TextDrawable:
-
hou.TextDrawable.isVisibleInViewport() sees if this drawable is visible in the viewport.
-
hou.TextDrawable.setVisibleInAllViewports() removes all per-viewport visibility restrictions so the drawable is shown in all viewports.
-
hou.TextDrawable.setVisibleInViewport() restricts the drawable so it’s visible in only the viewport.
-
-
In hou.TopNode:
-
hou.TopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.TopNode.revertParmInterface() reverts the parameter interface by moving all spare parameters to after the base parameters.
-
hou.TopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
hou.Tool.setShortLabel() sets and hou.Tool.shortLabel() returns the object’s short label.
-
hou.VertexGroup.containsNumber() returns whether or not the vertex with the given linear number is in this group.
-
hou.ViewerEvent.mousePos() returns the mouse position for this event in screen coordinates.
-
In hou.ViewerHandleContext:
-
hou.ViewerHandleContext.boundParameter returns the name of the node parameter bound to a handle parameter.
-
hou.ViewerHandleContext.draw renders the handle’s drawables in the viewport.
-
hou.ViewerHandleContext.layerTransform returns the image-to-world space transform of the handle’s bound node.
-
hou.ViewerHandleContext.setDrawOrder defines the draw order for the handle’s drawables.
-
hou.ViewerHandleContext.updateLayer updates the handle’s image layer used to compute the post transform and post scale for
hou.Drawable2Dobjects.
-
-
In hou.ViewerStateContext:
-
hou.ViewerStateContext.postScale() returns the post-scale vector used during rendering to position hou.Drawable2D objects.
-
hou.ViewerStateContext.postTransform() returns the post-transform matrix assigned to hou.Drawable2D objects.
-
hou.ViewerStateContext.fixedSizeScale() returns the scale factor used to render fixed-size hou.Drawable2D objects when zooming in or out.
-
-
In hou.Volume:
-
hou.Volume.computeAverage() returns the volume’s average value across all voxels of the selected channel.
-
hou.Volume.computeMax() returns the volume’s maximum value across all voxels of the selected channel.
-
hou.Volume.computeMin() returns the volume’s minimum value across all voxels of the selected channel.
-
hou.Volume.clearWindow() clears any explicit data and display window metadata and restores the default identity window behavior.
-
hou.Volume.dataWindowOffset() returns the offset of the volume’s data window in canonical voxel space.
-
hou.Volume.dataWindowSize() returns the size of the volume’s data window in canonical voxel space.
-
hou.Volume.displayWindowOffset() returns the offset of the volume’s display window in canonical voxel space.
-
hou.Volume.displayWindowSize() returns the size of the volume’s display window in canonical voxel space.
-
hou.Volume.hasWindow() returns whether this volume has explicit data and display window metadata.
-
hou.Volume.setDataWindowOffset() sets the offset of the volume’s data window in canonical voxel space.
-
hou.Volume.setDisplayWindowOffset() sets the offset of the volume’s display window in canonical voxel space.
-
hou.Volume.setDisplayWindowSize() sets the size of the volume’s display window in canonical voxel space.
-
hou.Volume.setWindowVoxelScale() sets the scale from the volume’s voxel grid into canonical voxel space.
-
hou.Volume.windowVoxelScale() returns the scale from the volume’s voxel grid into canonical voxel space.
-
-
In hou.VopNetNode:
-
hou.VopNetNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.VopNetNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
In hou.VopNode:
-
hou.VopNode.connectionDrawStyle() returns the hou.nodeConnectionDrawStyle enum object that describes the way the graph editor draws the connection wires between nodes inside the subnet.
-
hou.VopNode.setConnectionDrawStyle() sets the style in which the graph editor draws the connection wires between nodes inside the subnet.
-
-
The
parmfilterkey in the following functions and methods captures the settings used for the parameter filter and search bar for each node: -
The following functions were removed:
-
hou.ApexNode.copyNetworkBox()
-
hou.ApexNode.copyStickyNote()
-
hou.ApexNode.editableInputString()
-
hou.ApexNode.editableInputStrings()
-
hou.ApexNode.setEditableInputString()
-
hou.Node.copyNetworkBox()
-
hou.Node.copyStickyNote()
-
hou.Node.editableInputString()
-
hou.Node.editableInputStrings()
-
hou.Node.setEditableInputString()
-
-
The hou.ChannelEditorPane class was removed.