Product documentation · Current desktop UI

Houdini source functions

70 definitions in the current source checkout. This source map includes internal helpers and class methods. It is not a supported API contract or a promise that a function can be called through a bridge. For supported entry points use the Python API reference or bundled DCC wrapper pages.

houdini_tools.geometry

import_file

def import_file(filepath: str, parent: str='/obj', name: str='ai_import') -> dict[str, Any]

module function · public name · houdini_tools/geometry.py:9

export_file

def export_file(node_path: str, filepath: str, frame: int=1) -> dict[str, Any]

module function · public name · houdini_tools/geometry.py:25

houdini_tools.operations

_hou

def _hou()

module function · internal · houdini_tools/operations.py:8

_node

def _node(path: str)

module function · internal · houdini_tools/operations.py:14

scene_select

def scene_select(nodes: Iterable[str], replace: bool=True) -> dict[str, Any]

module function · public name · houdini_tools/operations.py:22

scene_list

def scene_list(network: str='/obj', recursive: bool=True, limit: int=500) -> dict[str, Any]

module function · public name · houdini_tools/operations.py:35

node_create

def node_create(node_type: str, parent: str='/obj', name: str='') -> dict[str, Any]

module function · public name · houdini_tools/operations.py:45

node_set_parm

def node_set_parm(node_path: str, parm_name: str, value: Any) -> dict[str, Any]

module function · public name · houdini_tools/operations.py:51

node_connect

def node_connect(source_path: str, destination_path: str, output_index: int=0, input_index: int=0) -> dict[str, Any]

module function · public name · houdini_tools/operations.py:60

material_create

def material_create(material_name: str, network: str='/mat', shader_type: str='principledshader::2.0', color: Iterable[float] | None=None) -> dict[str, Any]

module function · public name · houdini_tools/operations.py:81

material_assign

def material_assign(material_path: str, node_path: str='', nodes: Iterable[str] | None=None) -> dict[str, Any]

module function · public name · houdini_tools/operations.py:100

api_call

def api_call(function: str, args: list[Any] | None=None, kwargs: dict[str, Any] | None=None) -> Any

module function · public name · houdini_tools/operations.py:120

script_run

def script_run(code: str) -> Any

module function · public name · houdini_tools/operations.py:129

houdini_tools.render

submit

def submit(rop_path: str, start_frame: int=1, end_frame: int=100, step: int=1) -> dict[str, Any]

module function · public name · houdini_tools/render.py:8

houdini_tools.Rigging.rigging_host_adapter

_hou

def _hou()

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:29

_result

def _result(ok: bool, capability: str, message: str='', **kwargs: Any) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:35

_workspace

def _workspace()

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:39

_state

def _state() -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:49

_save_state

def _save_state(state: dict[str, Any]) -> None

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:57

_node

def _node(value: str)

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:61

_definition

def _definition(value: Any) -> CharacterDefinition

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:72

_matrix_values

def _matrix_values(matrix: Any) -> list[float]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:82

_matrix

def _matrix(values: Any)

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:86

_control

def _control(name: str, target: str='', module: str='custom')

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:93

_record

def _record(kind: str, payload: dict[str, Any], *, record_id: str='') -> str

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:107

reload_dependencies

def reload_dependencies() -> int

module function · public name · houdini_tools/Rigging/rigging_host_adapter.py:116

Refresh the shared portable contract used by this live Houdini host.

scene_joints

def scene_joints() -> dict[str, Any]

module function · public name · houdini_tools/Rigging/rigging_host_adapter.py:132

selection

def selection() -> dict[str, Any]

module function · public name · houdini_tools/Rigging/rigging_host_adapter.py:168

execute

def execute(capability: str, payload: dict[str, Any]) -> dict[str, Any]

module function · public name · houdini_tools/Rigging/rigging_host_adapter.py:172

_op_definition_auto_map

def _op_definition_auto_map(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:184

_op_definition_assign_slot

def _op_definition_assign_slot(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:194

_op_definition_clear_slot

def _op_definition_clear_slot(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:200

_op_definition_mirror_slots

def _op_definition_mirror_slots(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:206

_op_definition_validate

def _op_definition_validate(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:213

_op_definition_set_reference_pose

def _op_definition_set_reference_pose(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:219

_op_definition_import

def _op_definition_import(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:226

_op_definition_export

def _op_definition_export(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:231

_op_rig_create_control

def _op_rig_create_control(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:236

_op_rig_edit_control_shape

def _op_rig_edit_control_shape(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:243

_op_rig_create_constraint

def _op_rig_create_constraint(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:250

_op_rig_create_ik_fk_limb

def _op_rig_create_ik_fk_limb(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:263

_op_rig_set_ik_fk_blend

def _op_rig_set_ik_fk_blend(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:280

_op_rig_create_reverse_foot

def _op_rig_create_reverse_foot(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:285

_op_rig_create_ribbon

def _op_rig_create_ribbon(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:298

_op_rig_create_twist

def _op_rig_create_twist(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:303

_op_rig_create_motion_path

def _op_rig_create_motion_path(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:321

_op_rig_create_curve_joints

def _op_rig_create_curve_joints(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:326

_op_rig_create_space_switch

def _op_rig_create_space_switch(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:331

_op_rig_set_space

def _op_rig_set_space(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:337

_op_rig_create_mesh_attachment

def _op_rig_create_mesh_attachment(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:348

_op_rig_create_pose_reader

def _op_rig_create_pose_reader(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:353

_op_rig_build_module

def _op_rig_build_module(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:360

_op_rig_remove_module

def _op_rig_remove_module(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:375

_op_rig_rebuild_module

def _op_rig_rebuild_module(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:393

_op_rig_build_full

def _op_rig_build_full(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:401

_op_rig_place_joints

def _op_rig_place_joints(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:412

_op_rig_set_t_pose

def _op_rig_set_t_pose(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:429

_op_rig_create_face_module

def _op_rig_create_face_module(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:434

_op_rig_store_connections

def _op_rig_store_connections(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:438

_op_rig_restore_connections

def _op_rig_restore_connections(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:449

_op_skin_surface_spatial_smooth_brush

def _op_skin_surface_spatial_smooth_brush(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:459

_op_retarget_create_definition

def _op_retarget_create_definition(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:466

_op_retarget_validate_definition

def _op_retarget_validate_definition(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:471

_op_retarget_solve_pose

def _op_retarget_solve_pose(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:477

_op_retarget_preview

def _op_retarget_preview(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:493

_op_retarget_bake

def _op_retarget_bake(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:499

_op_retarget_transfer_take

def _op_retarget_transfer_take(payload: dict[str, Any]) -> dict[str, Any]

module function · internal · houdini_tools/Rigging/rigging_host_adapter.py:520

houdini_tools.simulation

run

def run(dop_network_path: str, start_frame: int=1, end_frame: int=100, substeps: int=1) -> dict[str, Any]

module function · public name · houdini_tools/simulation.py:8

houdini_tools.usd

export

def export(filepath: str, node_path: str='/obj', frame_range: list[int] | tuple[int, int] | None=None) -> dict[str, Any]

module function · public name · houdini_tools/usd.py:9

houdini_tools.validation

inspect_procedural_fx

def inspect_procedural_fx(source_node: str, transform_node: str, dop_network_path: str, usd_path: str, start_frame: int=1, end_frame: int=24) -> dict[str, Any]

module function · public name · houdini_tools/validation.py:9