Houdini 20.0 hapi

hapi.createHeightFieldInput function

Creates the required node hierarchy needed for heightfield inputs.

Note that when saving the Houdini scene using hapi.saveHIPFile the nodes created with this method will be green and will start with the name “input”.

Usage

createHeightFieldInput(session: hapi.Session, parent_node_id: int, name: str, xsize: int, ysize: int, voxelsize: float, sampling: hapi.heightFieldSampling) → (int, int, int, int)

Creates the required node hierarchy needed for heightfield inputs.

session

The session of Houdini you are interacting with. See hapi.Session for more on sessions. Pass None to just use the default in-process session.

parent_node_id

The parent node network’s node id or -1 if the parent network is the manager (top-level) node. In that case, the manager must be identified by the table name in the operator_name.

name

Give this input node a name for easy debugging. The node’s parent OBJ node and the Null SOP node will both get this given name with “input_” prepended. You can also pass None in which case the name will be “input#” where # is some number.

xsize

size of the heightfield in X

ysize

size of the heightfield in y

voxelsize

Size of the voxel

sampling

Type of sampling which should be either center or corner.

Returns a tuple of (heightfield_node_id, height_node_id, mask_node_id, merge_node_id).

hapi