omniverse-realtime-viewer
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chinese<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. -->
<!-- SPDX-License-Identifier: Apache-2.0 -->
<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. -->
<!-- SPDX-License-Identifier: Apache-2.0 -->
Omniverse Realtime Viewer
Omniverse Realtime Viewer
This is the top-level entry point for the Omniverse Realtime Viewer skill package.
It is self-contained: all required routing, conventions, and validation
guidance live in the selected references.
Use the focused reference documents as implementation recipes. This file chooses the
right recipes and preserves the architectural rules that must hold across all
generated viewer apps.
这是Omniverse Realtime Viewer技能包的顶级入口点。它是自包含的:所有必需的路由规则、约定和验证指南都在选定的参考文档中。
请将聚焦型参考文档作为实现方案使用。本文件会选择合适的方案,并保留所有生成的查看器应用必须遵循的架构规则。
Instructions
说明
Start by classifying the requested viewer, then read only the references needed
for that delivery path and feature set. Implement the render path first, layer
interaction and UI behavior on top of it, and finish by capturing validation
evidence from .
references/validation.md首先对请求的查看器进行分类,然后仅阅读该交付路径和功能集所需的参考文档。先实现渲染路径,再在其之上添加交互和UI行为,最后从中收集验证证据。
references/validation.mdRead Order
阅读顺序
- Read to choose the delivery path and focused references.
references/routing.md - Read before implementing camera, input, selection, viewport, streaming protocol, scene loading, or environment behavior.
references/conventions.md - For broad viewer requests, read .
references/usd-viewer-app/README.md - If the delivery path is unclear, read .
references/streaming-vs-local/README.md - If the prompt includes layout, panels, controls, inspectors, status, or UX,
read and then the focused viewer UI references. This applies to React/WebRTC, Tauri, Electron,
references/viewer-ux-workflow/README.md,ovui, and Dear ImGui apps; "frontend" means user-facing UI, not only browser UI.ovwidgets - For viewport interaction, read before
references/viewer-input-routing/README.md,references/camera-controls/README.md, orreferences/native-picking-selection/README.md.references/object-selection/README.md - Read only the focused capability references needed for the requested app.
- Use to capture review evidence before handoff.
references/validation.md
- 阅读以选择交付路径和聚焦型参考文档。
references/routing.md - 在实现相机、输入、选择、视口、流协议、场景加载或环境行为之前,阅读。
references/conventions.md - 对于通用查看器请求,阅读。
references/usd-viewer-app/README.md - 如果交付路径不明确,阅读。
references/streaming-vs-local/README.md - 如果需求包含布局、面板、控件、检查器、状态或UX,请先阅读,然后阅读聚焦型查看器UI参考文档。这适用于React/WebRTC、Tauri、Electron、
references/viewer-ux-workflow/README.md、ovui和Dear ImGui应用;“前端”指面向用户的UI,而非仅浏览器UI。ovwidgets - 对于视口交互,在阅读、
references/camera-controls/README.md或references/native-picking-selection/README.md之前,先阅读references/object-selection/README.md。references/viewer-input-routing/README.md - 仅阅读请求应用所需的聚焦型功能参考文档。
- 在交接前,使用收集评审证据。
references/validation.md
Non-Negotiables
不可协商规则
- Use for all USD and 3D rendering.
ovrtx - Browser apps display an WebRTC video stream plus UI. The browser does not render USD geometry.
ovstream - Do not substitute WebGL, Three.js, Babylon.js, PlayCanvas, A-Frame, model-viewer, react-three-fiber, glTF browser viewers, or other client-side 3D renderers.
- If local validation cannot run because the GPU/runtime environment is absent,
scaffold the path and document the runtime requirement. Do not add a browser-renderer fallback.
ovrtx - Keep user USD files unmodified. Viewer cameras, render products, render vars, settings, selection metadata, and runtime state belong in session/composite layers or app state.
- Keep one owner for , stage mutation, native picking, selection writes, and live attribute writes.
renderer.step() - Keep dependency acquisition in and deployment choices in
references/dependencies/README.md; do not duplicate package locations or deployment setup.references/cloud-deployment/README.md
- 所有USD和3D渲染均使用。
ovrtx - 浏览器应用显示WebRTC视频流及UI。浏览器不渲染USD几何图形。
ovstream - 不得替换为WebGL、Three.js、Babylon.js、PlayCanvas、A-Frame、model-viewer、react-three-fiber、glTF浏览器查看器或其他客户端3D渲染器。
- 如果因缺少GPU/运行时环境而无法进行本地验证,请搭建路径并记录运行时要求。不得添加浏览器渲染器作为 fallback。
ovrtx - 保持用户USD文件未修改。查看器的相机、渲染产物、渲染变量、设置、选择元数据和运行时状态应存储在会话/合成层或应用状态中。
- 由单一所有者负责、场景突变、原生拾取、选择写入和实时属性写入。
renderer.step() - 依赖项获取请参考,部署选择请参考
references/dependencies/README.md;请勿重复包位置或部署设置。references/cloud-deployment/README.md
Focused Reference Families
聚焦型参考文档分类
- Entry points and recipes: ,
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 - Rendering and stage: ,
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/prim-transform-safety/README.md.references/usd-sample-data/README.md - Delivery and runtime: ,
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 - Viewer 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 - Interaction: ,
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/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 - Infrastructure: ,
references/dependencies/README.md,references/windows-native-setup/README.md,references/cloud-assets/README.md,references/cloud-deployment/README.md.references/troubleshooting/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/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/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/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/dependencies/README.md、references/windows-native-setup/README.md、references/cloud-assets/README.md、references/cloud-deployment/README.md。references/troubleshooting/README.md
Build Workflow
构建流程
- Classify the prompt by delivery path, target user, required capabilities, runtime environment, validation needs, and explicit constraints.
- Select a small reference set. Start with the recipe or routing reference, then add focused capabilities such as camera, picking, hierarchy, properties, render settings, transform tools, cloud assets, or deployment.
- Read selected references before writing app code. Follow their build order, import order, data-channel contracts, and renderer ownership rules.
- Implement the core render path first, then input routing and camera, then selection and data panels, then scene/settings features, then packaging or deployment.
- Treat the selected references as the behavior contract for API shape, compatibility, and generated project structure.
- Capture validation evidence before calling the viewer ready.
- 根据交付路径、目标用户、所需功能、运行时环境、验证需求和明确约束对需求进行分类。
- 选择少量参考文档。从方案或路由参考文档开始,然后添加聚焦型功能,如相机、拾取、层级结构、属性、渲染设置、变换工具、云资产或部署。
- 在编写应用代码前阅读选定的参考文档。遵循其中的构建顺序、导入顺序、数据通道约定和渲染器所有权规则。
- 先实现核心渲染路径,然后是输入路由和相机,接着是选择和数据面板,之后是场景/设置功能,最后是打包或部署。
- 将选定的参考文档视为API形态、兼容性和生成项目结构的行为契约。
- 在宣布查看器就绪前收集验证证据。
Examples
示例
- For a browser viewer request, use the streaming recipe references plus camera, picking, hierarchy, properties, render settings, and stream-status references.
- For a local workstation viewer request, use the local or native delivery references plus renderer setup, stage loading, viewport input, and validation.
- 对于浏览器查看器请求,使用流方案参考文档以及相机、拾取、层级结构、属性、渲染设置和流状态参考文档。
- 对于本地工作站查看器请求,使用本地或原生交付参考文档以及渲染器设置、场景加载、视口输入和验证参考文档。
Completion Checklist
完成检查清单
- Selected references match the user's intent and delivery path.
- No code path uses a browser-side 3D renderer for USD.
- The generated app has one clear owner for render stepping and stage mutation.
- User USD files remain untouched by viewer-owned session data.
- Camera, input, selection, scene loading, and stream behavior follow
.
references/conventions.md - Setup/build/run results and visual interaction evidence are captured with
.
references/validation.md
- 选定的参考文档符合用户意图和交付路径。
- 没有代码路径使用浏览器端3D渲染器处理USD。
- 生成的应用有一个明确的所有者负责渲染步进和场景突变。
- 用户USD文件未被查看器所属的会话数据修改。
- 相机、输入、选择、场景加载和流行为遵循。
references/conventions.md - 使用记录了设置/构建/运行结果和视觉交互证据。
references/validation.md