概括

本文介绍了如何在渲染器插件中实现实时渲染，并涵盖以下主题：

• 属性约定
• RendererInfo 插件函数
• 渲染插件功能
• Python 实用程序
  - LiveRenderAPI
  - LiveRenderActions
  - 回调
• 陷阱
  - 单采样更新
  - 非持久更新
  

有关LiveRendering 的一般说明，请在Katana用户指南》中的“渲染类型”部分中找到其说明，并参阅“执行渲染”中的“启动和停止实时渲染”子部分以及“控制实时渲染”部分。

有关渲染器插件其他部分的详细说明，以及与 LiveRendering 不直接相关的 RenderAPI 其他功能的文档，可以在Katana开发人员指南 的渲染器插件部分中找到。

更多信息

属性约定

Katana的实时渲染系统由场景图中的属性提供支持。以效率为名，仅将更新渲染器所需的属性发送到渲染插件。有一个属性约定来确定这些属性，如下所示：

实时渲染。 <更新组> 。 <属性名称>

<updateGroup> - 这是一个 GroupAttribute，用于将属性分组到单个更新中。

<attributeName> - 这是要监视的顶级属性的名称。在上图中， liveRender.geoXform.xform属性指示实时渲染系统将任何更改发送到顶级xform属性。请注意，这是一个 StringAttribute，其值通常与 updateGroup 匹配，这是出于遗留原因，但通常不在内部使用。如果在同一个更新组中指定了多个属性，则当其中任何一个属性发生更改时，它们都会被发送到渲染器。

RendererInfo 插件函数

void fillLiveRenderTerminalOps( OpDefinitionQueue & terminalOps ,
                               const FnAttribute::GroupAttribute& stateArgs )

虽然可以在节点图中设置上述属性约定，但使用 RendererInfo 插件中的fillLiveRenderTerminalOps()函数在实时渲染启动时自动设置属性通常更有用。该函数传递一个名为TerminalOps的参数，该参数是一个std::deque ，不包含或多个包含 op 类型（作为std::string ）和 op 参数（作为GroupAttribute ） std::pair对象。

例如。下面的代码监视/root/world/lgt下面的灯光位置的xform属性的变化。

 FnAttribute::GroupBuilder opArgs;
 opArgs. set ( "type" , FnAttribute::StringAttribute( "light" ));
 opArgs. set ( "location" , FnAttribute::StringAttribute( "/root/world/lgt" ));
 opArgs. set ( "attributeNames" , FnAttribute::StringAttribute( "xform" ));
 terminalOps.push_back( std ::make_pair( "LiveRenderFilter" , opArgs.build()));

Katana附带的几个Geolib3 Ops在这里很有用：

渲染器插件功能

int startLiveEditing()

 int stopLiveEditing()

Katana调用这两个函数来通知您实时渲染何时处于活动状态以及应该更新位置

int processControlCommand( const std::string & command )

此函数是从Katana UI 到渲染插件的通信方法。 UI 可以通过 python LiveRenderAPI.SendCommand()函数以字符串形式发送命令，您可以在渲染插件中处理该命令以达到您想要的任何目的。

 int queueDataUpdates(FnAttribute::GroupAttribute updateAttribute)

当监控的属性发生变化时，它的新值将通过此函数传递给渲染插件。传递的属性将包含三个子属性：

• type - 更新类型（这是上面属性约定部分列出的<updateGroup> ）
• location - 此更新的场景图位置。
• 属性- 已更改属性的值。请注意，如果该位置已被删除，这将包含一个名为deleted的属性
  
  

请注意，此函数是在专用线程中调用的，该线程专门用于接收实时渲染更新。

 bool hasPendingDataUpdates()

此函数告诉 renderboot 进程是否有应应用的已在queueDataUpdates()中排队的实时渲染更新。

 int applyPendingDataUpdates() 

该函数在主渲染线程中调用，并且应该获取任何排队的实时更新并实际应用它们。仅当hasPendingDataUpdates()返回 true 时才会调用它。

Python 实用程序

Katana的 UI 有几个实用程序可以帮助改善实时渲染体验，如下所示：

实时渲染API

此 API 允许您使用LiveRenderAPI.SendCommand()和LiveRenderAPI.SendData()函数向正在运行的实时渲染发送自定义命令（字符串）或实时更新。它还具有各种函数来查询和修改实时渲染子系统正在使用的终端操作列表。这些终端操作用于确定位置何时更改，而不是导致当前场景图（由节点生成）发生更改。这实际上是一种更改在调用RendererInfo::fillLiveRenderTerminalOps()期间传递的操作的方法。

实时渲染动作

通过使用plugin_apis/python/BaseLiveRenderAction.py 中的类，可以使用您自己的自定义菜单项来扩展“渲染”>“实时渲染”菜单。只需从 BaseLiverRenderAction 类派生（该类本身从QtGui.QAction派生）并重写成员函数即可。然后，您的类可以使用Katana的任何 python API（包括 LiveRenderAPI），从而允许它向渲染插件发送自定义命令或更新。 LiveRenderActions 的实例应放置在 $KATANA_RESOURCES/UIPlugins 目录中，以确保它们仅在 UI 会话期间尝试加载。

回调

在向渲染插件发送实时更新或实时渲染命令之前， Katana将分别触发名为 onLiveRenderUpdate 或 onLiveRenderCommand 的回调。这些回调将传递将要传递给渲染插件的命令或更新属性。这主要用于监视目的，允许您检查传递给渲染插件的数据，但也可以通过引发异常来阻止发送消息。然而，这将在Katana的消息日志中触发错误消息。

陷阱

单次采样更新

当渲染开始时，geolib 会生成多采样属性以允许运动模糊等。但是在Katana UI 中，通常仅使用单个样本检索属性，并且实时渲染更新来自Katana UI。这意味着实时更新期间发送的属性通常只有一个时间样本。

非持久更新

当渲染开始时，用于生成场景的操作树由Katana写入磁盘并由渲染进程读取，渲染进程使用自己的 Geolib3 运行时。渲染插件可以访问 SceneGraphIterator 来查询场景图及其属性。然而这一幕却是一成不变的。当从Katana传递实时渲染更新时，它无法更新 Geolib3 运行时。这意味着 SceneGraphIterators 将始终返回原始场景，即使渲染插件已收到实时更新。因此，要求实时更新属性包含渲染插件所需的所有信息，因为您无法安全地使用 SceneGraphIterator 来获取其他信息。