Houdini 20.0 hapi

hapi.getImageFilePath function

Get the file name that this image would be saved to

Check to see what file path hapi.extractImageToFile would have saved to given the same parms. Perhaps you might wish to see if it already exists before extracting.

Usage

getImageFilePath(session: hapi.Session, material_node_id: int, image_file_format_name: str, image_planes: str, destination_folder_path: str, destination_file_name: str, texture_parm_id: int) → int

Get the file name that this image would be saved to

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.

material_node_id

The material node id.

image_file_format_name

The image file format name you wish the image to be extracted as. See hapi.extractImageToFile for more information.

image_planes

The image planes you wish to extract into the file. Multiple image planes should be separated by spaces.

destination_folder_path

The folder where the image file sould be created.

destination_file_name

Optional parameter to overwrite the name of the extracted texture file. See hapi.extractImageToFile for more information.

texture_parm_id

The index in the parameter list of the material node. of the parameter containing the texture map file path

Returns destination_file_path as a int.

hapi