HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Height Fields

Functions

HAPI_DECL HAPI_CreateHeightFieldInput (const HAPI_Session *session, HAPI_NodeId parent_node_id, const char *name, int xsize, int ysize, float voxelsize, HAPI_HeightFieldSampling sampling, HAPI_NodeId *heightfield_node_id, HAPI_NodeId *height_node_id, HAPI_NodeId *mask_node_id, HAPI_NodeId *merge_node_id)
 Creates the required node hierarchy needed for heightfield inputs. More...
 
HAPI_DECL HAPI_CreateHeightfieldInputVolumeNode (const HAPI_Session *session, HAPI_NodeId parent_node_id, HAPI_NodeId *new_node_id, const char *name, int xsize, int ysize, float voxelsize)
 Creates a volume input node that can be used with Heightfields. More...
 

Detailed Description

Functions for creating and inspecting HAPI session state.

Function Documentation

HAPI_DECL HAPI_CreateHeightFieldInput ( const HAPI_Session session,
HAPI_NodeId  parent_node_id,
const char *  name,
int  xsize,
int  ysize,
float  voxelsize,
HAPI_HeightFieldSampling  sampling,
HAPI_NodeId heightfield_node_id,
HAPI_NodeId height_node_id,
HAPI_NodeId mask_node_id,
HAPI_NodeId merge_node_id 
)

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".

Parameters
[in]sessionThe session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]parent_node_idThe 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.
[in]nameGive 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 NULL in which case the name will be "input#" where # is some number.
[in]xsizesize of the heightfield in X
[in]ysizesize of the heightfield in y
[in]voxelsizeSize of the voxel
[in]samplingType of sampling which should be either center or corner.
[out]heightfield_node_idNewly created node id for the heightfield node. Use HAPI_GetNodeInfo() to get more information about the node.
[out]height_node_idNewly created node id for the height volume. Use HAPI_GetNodeInfo() to get more information about the node.
[out]mask_node_idNewly created node id for the mask volume. Use HAPI_GetNodeInfo() to get more information about the node.
[out]merge_node_idNewly created merge node id. The merge node can be used to connect additional input masks. Use HAPI_GetNodeInfo() to get more information about the node.
HAPI_DECL HAPI_CreateHeightfieldInputVolumeNode ( const HAPI_Session session,
HAPI_NodeId  parent_node_id,
HAPI_NodeId new_node_id,
const char *  name,
int  xsize,
int  ysize,
float  voxelsize 
)

Creates a volume input node that can be used with Heightfields.

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".

Parameters
[in]sessionThe session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]parent_node_idThe 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.
[out]new_node_idNewly created node id for the volume. Use HAPI_GetNodeInfo() to get more information about the node.
[in]nameThe name of the volume to create. You can also pass NULL in which case the name will be "input#" where # is some number.
[in]xsizesize of the heightfield in X
[in]ysizesize of the heightfield in y
[in]voxelsizeSize of the voxel