Mantra Render Output Node Support for the Toolkit Mantra render output node in Houdini. By: Shotgun Software Latest Version: v0.2.7 (prod) For our version numbers, we follow the Semantic Versioning standard. System Name: tk-houdini-mantranode

Overview

This document describes functionality only available if you have taken control over a Toolkit configuration. Please refer to the Shotgun Integrations User Guide for details. This app provides a Houdini Mantra output node whose output path is prepopulated with a location based off a set of Toolkit configurations and the path of the Houdini scene generating the content.

Documentation

The Houdini Mantra Node App provides a custom Shotgun Mantra Output node which makes it easy to standardise the location where render files are output. It can be configured for each environment.

General Use

In order to use the Shotgun Mantra Node, save your script as a Toolkit work file first and then create a new node via the TAB menu in Houdini. This will create a node which looks similar to a normal Mantra output node:

The node can be configured with multiple output profiles, each using a different set of template paths for where the render output (images, ifd, dcm, aov, etc) should be written to disk.

Rather than entering a path by hand, you just specify which configuration to use and the node will compute the rest of the path automatically. You can see the computed path in the UI.

The rendered files will be versioned and the version number will always follow the current Houdini scene file version which will be incremented automatically when you publish using Multi Publish.

Configuration

The Toolkit mantra node provides the ability to specify multiple output profiles for an environment configuration. Here's an example of configuring the node with multiple profiles:

  tk-houdini:
    apps:
      tk-houdini-mantranode:
        location: 
          name: tk-houdini-mantranode
          type: dev
          version: v0.2.2
        default_node_name: tk_mantra_out
        work_file_template: houdini_shot_work
        output_profiles:
          - name: Primary Render
            settings: {}
            color: [255, 127, 0]
            output_render_template: houdini_shot_render
            output_ifd_template: houdini_shot_ifd
            output_dcm_template: houdini_shot_dcm
            output_extra_plane_template: houdini_shot_extra_plane
          - name: Local Render
            settings: {}
            color: [0, 127, 255]
            output_render_template: houdini_shot_local_render
            output_ifd_template: houdini_shot_local_ifd
            output_dcm_template: houdini_shot_local_dcm
            output_extra_plane_template: houdini_shot_local_extra_plane

You can use the output profiles to alter the look of the node via the color field, and you can adjust individual parms on the underlying Alembic node by supplying key/value pairs matching those parms in the settings field. Finally, the output_*_template fields drive the output paths for the files written to disk by the mantra renderer.

Installation and Updates

Adding this App to the Shotgun Pipeline Toolkit

If you want to add this app to Project XYZ, in an environment named asset, execute the following command:

> tank Project XYZ install_app asset tk-houdini tk-houdini-mantranode

Updating to the latest version

If you already have this item installed in a project and you want to get the latest version, you can run the update command. You can either navigate to the tank command that comes with that specific project, and run it there:

> cd /my_tank_configs/project_xyz
> ./tank updates

Alternatively, you can run your studio tank command and specify the project name to tell it which project to run the update check for:

> tank Project XYZ updates

Collaboration and Evolution

If you have access to the Shotgun Pipeline Toolkit, you also have access to the source code for all apps, engines and frameworks in Github where we store and manage them. Feel free to evolve these items; use them as a base for further independent development, make changes (and submit pull requests back to us!) or simply tinker with them to see how they have been built and how the toolkit works. You can access this code repository at https://github.com/shotgunsoftware/tk-houdini-mantranode.

Special Requirements

• You need Shotgun Pipeline Toolkit Core API version v0.12.5 or higher to use this.
• You need Engine version v0.2.0 or higher to use this.

Configuration

Below is a summary of all the configuration settings used. These settings need to be defined in the environment file where you want to enable this App or Engine.

work_file_template

Type: template

Description: A reference to a template which locates a Houdini work file on disk. This is used to drive the version and optionally the name of output files.

default_node_name

Type: str

Default Value: sgtk_mantra

Description: A default name for Mantra output nodes created in houdini. Allowed characters include letters, numbers, periods, dashes, or underscores.

output_profiles

Type: list

Description: A list of dictionaries defining the various mantra output profiles. Each profile contains a unique name that describes the profile, the cach template for writing to disk, a color to distinguish each profile type in the node graph, and optional settings to apply to the internal mantra node.

Release Notes

Welcome to the release notes for this tk-houdini-alembicnode. Below you will find an overview of all the changes we did for each release. We try to be as detailed as possible and include all bugs we have fixed, features we have added and things that may have changed. If you have questions about a particular release, don't hesitate to contact our support team!

v0.2.7

2016-Mar-03

Adds metrics logging

v0.2.6

2016-Jan-20

Bug fixes discovered during testing related to extra plane aovs

v0.2.5

2016-Jan-19

Changed node label from SGTK Mantra to Shotgun Mantra

v0.2.4

2016-Jan-19

Bug fix in conversion classmethods wrt extra image planes

v0.2.3

2016-Jan-07

Updated config docs.

v0.2.2

2016-Jan-07

QA: Simplified the hadModule code for param callbacks

v0.2.1

2016-Jan-06

QA fixes. OTL regenerated in preparation for release.

v0.2.0

2015-Dec-10

Merged updates from Pixomondo, cleanup, refactor

v0.1.1

Fixed app so that it will install with the current engine version. - Note that this app is still going through QA and is yet to be officially released!

v0.1.0

Initial release to the App Store.