base_render_handler

Base Hook for other Houdini renderer node handlers.

These include:

• arnold_handler

• ifd_handler

This hook is designed to inherit from base_export_handler hook.

Module Contents

Classes

BaseRenderNodeHandler

Base class for all render output nodes.

HookBaseClass

class BaseRenderNodeHandler

Bases: HookBaseClass

Base class for all render output nodes.

AOV_COUNT =

AOV_ERROR =

AOV_FILE_TMPL = {}

AOV_NAME_TMPL = {}

AOV_PUBLISH_TEMPLATE = aov_publish_template

AOV_USE_FILE_TMPL = {}

AOV_WORK_TEMPLATE = aov_work_template

ARCHIVE_ENABLED =

ARCHIVE_OUTPUT =

ARCHIVE_PUBLISH_TEMPLATE =

ARCHIVE_WORK_TEMPLATE =

SGTK_PASS_NAME = sgtk_pass_name

_create_sgtk_parms(self, node)

Create the parameters that are going to live within the sgtk folder.

Parameters

node – A hou.Node instance.

Return type

list(hou.ParmTemplate)

_enable_sgtk(self, node, sgtk_enabled)

Enable/disable the sgtk parameters.

Parameters

• node – A hou.Node instance.

• sgtk_enabled (bool) – The state to set the parameters to.

_get_multi_parm_output_paths_and_templates(self, node, count_parm_name, use_file_parm_tmpl, file_parm_tmpl, work_template_name, publish_template_name, paths_and_templates)

Get the output path and the templates used for the given multi parms.

Parameters

• node – A hou.Node instance.

• count_parm_name (str) – The name of the count parameter to query.

• use_file_parm_tmpl (str) – The string template for the use file parm name.

• file_parm_tmpl (str) – The string template for the file parm name.

• work_template – The work sgtk.Template for this parm.

• publish_template – The publish sgtk.Template for this parm.

• paths_and_templates (list) – The current list of paths and templates to append to.

_get_output_paths_and_templates(self, node)

Go through the node’s specified parameters and get the output paths, work and publish templates.

Returns a list of dictionaries, each containing, at least: - work template - publish template - file name

and optionally: - any sequence paths - whether the output is a deep image

Parameters

node – A hou.Node instance.

Return type

list(dict)

_get_template_fields_from(self, node, additional_fields=None)

Get shotgun template fields from the given node and update with any additional fields.

Parameters

• node – A hou.Node instance.

• additional_fields (dict) – Any fields to override with.

Returns

The template fields updated with the additional_fields

_lock_aov_parms(self, node, lock)

Lock aov output path parms.

Parameters

• node – A hou.Node instance.

• lock (bool) – Lock parms if True.

_lock_parms(self, node, lock)

Lock parms on the node is shotgun is enabled.

Parameters

• node – A hou.Node instance.

• lock (bool) – Lock parms if True.

_populate_aov_names(self, node, parent_parm_name, src_parm_name, dest_parm_name)

Populate sgtk aov names from the original aov names.

Parameters

• node – A hou.Node instance.

• parent_parm_name (str) – The parent parm name.

• src_parm_name (str) – The source parm name.

• dest_parm_name (str) – The sgtk parm name.

_populate_from_fields(self, node, fields)

Populate the node from template fields.

Parameters

• node – A hou.Node instance.

• fields (dict) – The template fields.

_refresh_file_path(self, node)

Refresh the file paths generated by the node handler.

Parameters

node – A hou.Node instance.

_set_up_parms(self, node)

Set up the given node’s parameters.

Parameters

node – A hou.Node instance.

_update_aov_path(self, node, index)

Update the aov output path for the given index.

Parameters

• node – A hou.Node instance.

• index (int) – The index of the aov parm.

Raises

FieldInputError on invalid input.

_update_aov_paths(self, node)

Update all the aov output paths on the node.

Parameters

node – A hou.Node instance.

_update_template_fields(self, node, fields)

Update template fields from the node’s parameter values.

Parameters

• node – A hou.Node instance.

• fields (dict) – Template fields.

generate_aov_path(self, node, channel, template_name)

Generate the file path for the given aov name.

Parameters

• node – A hou.Node instance.

• channel (str) – The aov name.

• template_name (str) – The name of the shotgun template to use.

Returns

The file path for the aov output.

lock_aov_parms(self, kwargs)

Callback to lock aov output path parms.

update_aov_path(self, kwargs)

Callback to update the aov output path for the given index.

update_file_path(self, node, parm_name, template_name, additional_fields=None)

Update the file path for the given parameter.

Parameters

• node – A hou.Node instance.

• parm_name (str) – The name of the parm to update.

• template_name (str) – The name of the shotgun template to use.

• additional_fields (dict) – Any fields to override the template fields with.