审核提交

审核提交

提供向 Shotgun 提交媒体进行审核的功能。
最新版本:v1.0.2 (prod)
我们的版本号遵循语义化版本标准。
系统名称:tk-multi-reviewsubmission

请注意:本文档介绍仅当控制 Toolkit 配置时可用的功能。有关更多详细信息,请参见 Shotgun 集成用户手册
概述
文档
            如何使用此应用?
                  作为 API
                  作为菜单项
安装、更新和开发
配置选项

该应用提供用于帮助在 Shotgun 中以版本形式提交图像序列以进行审核的功能。此应用没有用户界面,而是提供 API 方法来生成 QuickTime 影片文件和审核。您可以从脚本或挂钩内调用此应用。例如,如果您想创建 QuickTime 影片文件并将它送审,可以让发布配置在后期处理挂钩中调用此应用。此应用将生成一个带有场景信息覆层和场记板信息的 QuickTime 影片文件。您可以配置是让应用将 QuickTime 影片文件上传至 Shotgun、保留在磁盘上还是同时进行这两种操作。最后,应用将在 Shotgun 内创建一个新版本,供用户在审片室中审看!

文档

如何使用此应用?

作为 API

此应用提供了一种模式以从多发布应用等其他应用内进行调用。

此模式基于图像序列创建 QuickTime 影片文件,然后将它们以版本形式提交至 Shotgun,以方便审核。生成的 QuickTime 影片文件将具有场记板信息和场景信息覆层。字体、徽标位置、影片压缩选项和场景信息覆层/场记板信息目前在默认挂钩中采取硬编码方式编写,因此建议您重新执行挂钩函数以调整行为。

下面是场记板信息和场景信息覆层当前的默认格式:

主菜单

主菜单

如果您想在自己的应用或挂钩中使用此应用,下面快速介绍了一种简单的方法。

  • 从当前插件中获取 tk-multi-reviewsubmission 应用。我们可以在一个挂钩内通过调用 self.parent.engine.apps.get('tk-multi-reviewsubmission') 来做到这一点。
  • 如果应用可用,调用 render_and_submit_version() 方法。

下面的示例显示了此应用在您的挂钩代码中的样子:

review_submission_app = self.parent.engine.apps.get("tk-multi-reviewsubmission")
if review_submission_app:
    review_submission_app.render_and_submit_version(
        template,
        fields,
        first_frame,
        last_frame,
        sg_publishes,
        sg_task,
        comment,
        thumbnail_path,
        progress_cb,
        color_space
    )

您需要传递给 render_and_submit_version 的参数如下所示:

  • template:一个模板,用于定义要发布的文件的所在位置
  • fields:用来填写模板的字段
  • first_frame:要处理的图像序列的第一帧
  • last_frame:要处理的图像序列的最后一帧
  • sg_publishes:要与版本链接的 Shotgun 发布文件对象的列表。
  • sg_task:要与版本链接的 Shotgun 任务链接词典。
  • comment:要添加到版本说明中的文字。
  • thumbnail_path:影片未上传至 Shotgun 时为版本使用的缩略图的路径(在配置中设置)。
  • progress_cb:一个用于报告进度的回调。此值的格式应为:callback(percent, message)
  • color_space:输入帧所在的颜色空间。在 Nuke 中,这是写入节点的颜色空间按钮的其中一个枚举值。

作为菜单项

此模式向 DCC 内的 Shotgun 菜单添加菜单项。

此模式创建当前视口的快照,并将其作为版本草稿发送到 Shotgun Create。然后,用户可以通过添加标注、文字或比较注释,在 Shotgun Create 内扩展审核提交。

要将此功能添加到上下文,您需要:

  • 设置 display_name 字段,使其显示在菜单项中。
  • render_media_hook 字段设置为挂钩,告知如何在 DCC 中渲染媒体(tk-photoshopcc 和 tk-maya 具有默认执行)
  • submitter_hook 字段设置为 {self}/submitter_create.py

如下所示:

tk-multi-reviewsubmission:
  display_name: Send for review
  render_media_hook: '{self}/render_media.py:{self}/{engine_name}/render_media.py'
  submitter_hook: '{self}/submitter_create.py'
  location: 
    type: app_store
    name: tk-multi-reviewsubmission
    version: v1.0.1

相关应用和文档

发布

通过发布应用,艺术家可以发布他们的作品,以便其可供下游的艺术家使用。它支持在艺术家的内容创建软件中以传统方式发布工作流,以及在磁盘上单独发布任何文件。在内容创建软件中操作并使用基本 Shotgun 集成时,该应用将自动发现并显示项目以供艺术家发布。对于较复杂的生产需求,工作室可以编写自定义发布插件来推动美工人员工作流。

Quickdailies

此应用用于向 Nuke 添加节点类型,您可以在节点图表中的任意位置添加节点类型。添加到场景中后,可以双击节点,转到属性页面,然后点击“Send to Review”按钮。然后,此应用会为您的场景渲染一个 QuickTime 影片文件,添加场景信息覆层和场记板信息,并将文件发送至 Shotgun。它还会生成胶片缩略图,以方便在 Shotgun 中预览版本。

Quickreview 节点

此应用用于添加 Nuke 节点,您可以在节点图表中的任意位置添加 Nuke 节点。添加到场景中后,可以双击节点,转到属性页面,然后点击“Send to Review”按钮。然后,此应用会为您的场景渲染一个 QuickTime 影片文件,添加场景信息覆层和场记板信息,并将文件上传至 Shotgun。

写入节点

此应用包含一个适用于 Nuke 的自定义写入节点小控件,使用户不必关心文件系统路径,从而只需关注于为特定输出命名。Shotgun 会完成其余操作!此应用通常与发布应用结合使用,如果您安装了适用于 Nuke 的发布应用,您很可能也想要安装此应用!

安装和更新

将此应用添加到 Shotgun Pipeline Toolkit

如果您想将此应用添加到 Project XYZ 中名为 asset 的环境中,请执行以下命令:

> tank Project XYZ install_app asset tk-maya tk-multi-reviewsubmission

更新至最新版本

如果您已在某个项目中安装了此应用,要获取最新版本,可运行 update 命令。您可以导航到该特定项目随附的 tank 命令,并在该项目中运行它:

> cd /my_tank_configs/project_xyz
> ./tank updates

或者,也可以运行您的工作室的 tank 命令并指定项目名称,指示该命令要对哪个项目运行更新检查:

> tank Project XYZ updates

协作和代码演进

如果您可以获取 Shotgun Pipeline Toolkit,意味着也可以获取我们在 GitHub 中存储和管理的所有应用、插件和框架的源代码。欢迎根据实际需要演进和完善这些内容,以它们为基础做进一步的独立开发,修改它们(以及向我们提交 Pull 请求!),或者只是随手玩一玩,简单了解它们的构建方式和 Toolkit 的工作原理。您可以通过以下网址访问此代码库:https://github.com/shotgunsoftware/tk-multi-reviewsubmission

特殊要求

  • 需要安装 Shotgun Pipeline Toolkit 核心 API 版本 v0.14.0 或更高版本才能使用此功能。

配置

下面是使用的所有配置设置的摘要。您需要在要启用此应用或插件的环境文件中定义这些设置。

movie_width

类型:int

默认值:1920

说明:渲染的影片文件的宽度。

display_name

类型:str

说明:指定在菜单和主对话框中使用的名称

render_media_hook

类型:hook

默认值:{self}/render_media.py:{self}/{engine_name}/render_media.py

说明:执行此应用运行时媒体的生成方式。

slate_logo

类型:config_path

说明:这是场记板上使用的图像(如公司徽标)的路径。提供的图像将被调整为一个 400 像素的方框,徽标左下角距离右侧 100 像素,并位于场记板左下角上方 100 像素。如果想增添透明效果,可以使用具有 Alpha 通道的图像。目前 Nuke 支持的任何图像格式均符合要求。如果此设置为空字符串,将不应用徽标。

movie_path_template

类型:template

可选模板键:***

说明:此模板用于定义影片文件在文件系统中的输出位置。对于此模板,可以使用传递给 render_and_submit 字段的模板中定义的所有字段。除了这些字段,您还可以使用特殊字段 width 和 height,这两个字段包含影片的分辨率。如果 store_on_disk 设置为 false,此设置仍然是必需的,但是在文件上传至 Shotgun 之前,将用作临时的处理位置。

store_on_disk

类型:bool

默认值:True

说明:控制是否将创建的影片保留在磁盘上。禁用此选项和 upload_to_shotgun 选项实际上将禁用整个工具。

upload_to_shotgun

类型:bool

默认值:True

说明:控制是将创建的影片作为一个版本上传至 Shotgun,还是仅保留在磁盘上。禁用此选项和 store_on_disk 选项实际上将禁用整个工具。

version_number_padding

类型:int

默认值:3

说明:此值将用于填充场记板和各种电影场景信息覆层中的版本号。此设置并不会影响影片文件名中的版本号填充。请参见 movie_path_template。1 表示无填充。

submitter_hook

类型:hook

默认值:{self}/submitter_sgtk.py

说明:执行媒体发送到 Shotgun 的方式

movie_height

类型:int

默认值:1080

说明:渲染的影片文件的高度。

关注