omniverse-realtime-viewer

Omniverse 实时查看器

这是 Omniverse 实时查看器技能包的顶层入口。 它是自包含的：所有必需的路由规则、约定和验证 指南都位于选定的参考文档中。

将专门的参考文档用作实现指南。本文件负责选择 合适的指南，并保留所有生成的查看器应用都必须遵守的架构规则。

说明

首先对所请求的查看器进行分类，然后仅阅读该交付路径和功能集所需的 参考文档。先实现渲染路径，再在其上添加交互和 UI 行为，最后按照 references/validation.md 收集验证证据。

阅读顺序

1. 阅读 references/routing.md，选择交付路径和专门的参考文档。
2. 在实现摄像机、输入、选择、视口、流式传输协议、场景加载或环境 行为之前，阅读 references/conventions.md。
3. 对于宽泛的查看器请求，阅读 references/usd-viewer-app/README.md。
4. 如果不清楚交付路径，阅读 references/streaming-vs-local/README.md。
5. 如果提示词涉及布局、面板、控件、检查器、状态或 UX， 阅读 references/viewer-ux-workflow/README.md，然后阅读专门的查看器 UI 参考文档。 这适用于 React/WebRTC、Tauri、Electron、ovui、ovwidgets 和 Dear ImGui 应用；“前端”指面向用户的 UI，而不只是浏览器 UI。
6. 对于视口交互，先阅读 references/viewer-input-routing/README.md，再阅读 references/camera-controls/README.md、references/native-picking-selection/README.md 或 references/object-selection/README.md。
7. 对于新的查看器应用或 ovrtx 工作，在阅读渲染器、场景加载、舞台管理、摄像机、选择或变换写入相关参考文档之前，先阅读 ovstage 参考文档。
8. 对于 NVCF 可自托管部署，在阅读选定的云部署和流式传输参考文档之前，先阅读 references/cloud-deployment/nvcf-self-hosted.md。
9. 仅阅读请求的应用所需的专门功能参考文档。
10. 交接前使用 references/validation.md 收集审查证据。

必须遵守的规则

• 所有 USD 和 3D 渲染均使用 ovrtx。
• 浏览器应用显示 ovstream WebRTC 视频流和 UI。浏览器 不渲染 USD 几何体。
• 不得替换为 WebGL、Three.js、Babylon.js、PlayCanvas、A-Frame、 model-viewer、react-three-fiber、glTF 浏览器查看器或其他客户端 3D 渲染器。
• 如果由于缺少 GPU/运行时环境而无法进行本地验证，应搭建 ovrtx 路径并说明运行时要求。不得添加 浏览器渲染器回退方案。
• 保持用户的 USD 文件不被修改。查看器摄像机、渲染产品、渲染变量、 设置、选择元数据和运行时状态应存放在会话/合成图层、OVStage 运行时状态或应用状态中。
• renderer.step()、舞台变更、原生拾取、 选择写入、OVStage 发布和实时属性写入都只能由一个所有者负责。
• 可互换的变换动画、材质/效果属性、可见性切换、物理姿态采样和可撤销的查看器自有状态，使用 OVStage 运行时写入。渲染、拾取队列和选择轮廓可视化则继续使用原生 OVRTX API。
• 依赖获取方式统一放在 references/dependencies/README.md，部署选项统一放在 references/cloud-deployment/README.md；不要重复列出软件包位置或部署设置。

重点参考系列

• 入口和示例：references/usd-viewer-app/README.md、references/streaming-viewer-recipe/README.md、 references/ovui-local-viewer-recipe/README.md、references/streaming-vs-local/README.md、references/electron-shm-viewer/README.md、 references/ovwidgets-editor-shell/README.md。
• 渲染和场景：references/ovstage-runtime/README.md、references/ovstage-population/README.md、 references/ovstage-data-plane/README.md、references/ovstage-ovrtx-integration/README.md、 references/ovrtx-rendering/README.md、references/stage-loading/README.md、 references/stage-management/README.md、references/render-settings/README.md、 references/aov-switching/README.md、references/stage-hierarchy/README.md、 references/stage-queries/README.md、references/stage-attribute-reads/README.md、 references/camera-auto-select/README.md、references/camera-picker/README.md、 references/prim-transform-safety/README.md、references/usd-sample-data/README.md。
• 交付和运行时：references/streaming-server/README.md、references/streaming-client/README.md、 references/streaming-messages/README.md、references/streaming-lifecycle/README.md、references/local-viewer/README.md、 references/tauri-local-viewer/README.md、references/cpp-native-viewer/README.md、references/headless-shm-cli/README.md、 references/viewer-backend-interface/README.md、references/webgl-shm-transport/README.md。
• 查看器 UI/UX：references/viewer-ux-workflow/README.md、references/viewer-layout-patterns/README.md、 references/viewer-control-patterns/README.md、references/viewer-data-view-patterns/README.md、 references/viewer-feedback-status/README.md。
• 交互：references/viewer-input-routing/README.md、references/camera-controls/README.md、 references/object-selection/README.md、references/native-picking-selection/README.md、references/selection-feedback/README.md、 references/physics-simulation/README.md、 references/selection-animation/README.md、references/transform-manipulator/README.md、references/gl-viewport-overlay/README.md、 references/ovui-library/README.md、references/prim-pick-effects/README.md、references/prim-info-display/README.md、 references/viewport-overlays/README.md、references/physics-simulation/README.md。
• 基础设施：references/dependencies/README.md、references/windows-native-setup/README.md、references/cloud-assets/README.md、 references/cloud-deployment/README.md、references/cloud-deployment/nvcf-self-hosted.md、 references/cloud-deployment/nvcf-viewer-container-contract.md、 references/cloud-deployment/gpu-container-runtime.md、 references/cloud-deployment/container-image-build.md、 references/cloud-deployment/webrtc-network-diagnostics.md、references/troubleshooting/README.md。
• AI/Agent：references/a2ui-scene-copilot/README.md。
• CAE/CFD 可视化：references/cae-cfd-visualization/README.md、 references/cae-cfd-visualization/data-and-operators.md、 references/cae-cfd-visualization/cae-data-ingestion.md、 references/cae-cfd-visualization/temporal-playback.md、 references/cae-cfd-visualization/usd-authoring-and-materials.md、 references/cae-cfd-visualization/ovstage-render-and-camera.md、 references/cae-cfd-visualization/ovui-controls.md、 references/cae-cfd-visualization/glyphs.md、 references/cae-cfd-visualization/volume-rendering.md、 references/cae-cfd-visualization/driving-cae-viz-via-ovstage.md、 references/cae-cfd-visualization/emitter-and-seed-sources.md、 references/cae-cfd-visualization/streaming-cae-viewer.md、 references/cae-cfd-visualization/rtwt-blueprint-recreation.md、 references/cae-cfd-visualization/coordinate-systems-and-up-axis.md。

构建工作流

1. 根据交付路径、目标用户、所需功能、运行时环境、验证需求和明确约束对提示词进行分类。
2. 选择一组精简的参考资料。先查看配方或路由参考资料，再添加相应的专项功能，例如摄像机、拾取、层级、属性、渲染设置、变换工具、云端资产或部署。
3. 编写应用代码前先阅读选定的参考资料。遵循其中的构建顺序、导入顺序、数据通道约定和渲染器所有权规则。
4. 先实现 OVStage 填充／数据平面路径和核心渲染路径，再实现输入路由和摄像机，然后实现选择和数据面板，接着实现场景／设置功能，最后完成打包或部署。
5. 将选定的参考资料视为 API 形式、兼容性和生成项目结构的行为约定。
6. 收集验证证据后，再将查看器标记为就绪。

示例

• 对于浏览器查看器请求，使用流式传输配方参考资料，以及摄像机、拾取、层级、属性、渲染设置和流状态参考资料。
• 对于本地工作站查看器请求，使用本地或原生交付参考资料，以及渲染器设置、舞台加载、视口输入和验证参考资料。
• 对于“实时可视化 CAE/CFD 数据”的请求，将 CAE/CFD 视为一个图层，而不是独立应用：首先选择交付路径（references/streaming-vs-local/README.md），然后使用相应的配方构建基础查看器（references/ovui-local-viewer-recipe/README.md 或 references/streaming-viewer-recipe/README.md），再叠加 references/cae-cfd-visualization/README.md（数据 → 算子 → USD 编写 → 场景），并通过 references/cae-cfd-visualization/driving-cae-viz-via-ovstage.md 接入控制项。

完成检查清单

• 选定的参考资料符合用户意图和交付路径。
• 没有代码路径使用浏览器端的 3D 渲染器来渲染 USD。
• 生成的应用明确由一个组件负责渲染步进和舞台变更。
• 用户的 USD 文件不会被查看器拥有的会话数据修改。
• 摄像机、输入、选择、场景加载和流行为遵循 references/conventions.md。
• 使用 references/validation.md 收集设置／构建／运行结果和视觉交互证据。

ovstage 参考资料

对于所有新的查看器应用，在阅读渲染器、场景、交互或交付相关参考资料前，先阅读以下内容：

• references/ovstage-runtime/README.md — 运行时所有权、序号、发布和恢复。
• references/ovstage-population/README.md — 组合后的 USD 填充和场景代次。
• references/ovstage-data-plane/README.md — 查询、写入、变换和运行时 DTO。
• references/ovstage-ovrtx-integration/README.md — 附加渲染器循环和运行时集成约定。