Overview#

This extension provides a viewport widget that displays the camera names and mesh for users working in a live session. It is intended for use in collaborative sessions where multiple users work on the same stage, offering visual cues to identify peer camera views quickly. With built‐in mechanisms to track and display live camera information, it enhances the collaborative experience in the viewport.

Concepts#

Live Collaboration: The extension taps into a live session’s data to display a peer’s camera name and status, helping users easily recognize who is active in the shared stage, and where their camera position is.

Functionality#

User Name Display: Once enabled, the extension automatically shows camera names in the viewport. It monitors changes in the camera’s position and direction, updating the UI in real time.
Peer Camera Tracking: The extension tracks peer user cameras through a dedicated manipulation system. As users interact with their cameras, related widgets update accordingly. Offscreen indicators may appear when a peer camera is outside of the scope of the current view.

Configuration#

Visual Update Delay: The setting visual.delayFrame establishes a frame delay (default set to 3) for camera updates. This helps to provide a smoother render result.
User Name Sanitization: A configuration option strips mail addresses from user names, ensuring cleaner display names in the camera widget.

Relationships#

Dependencies: This extension relies on modules such as omni.usd, omni.ui, omni.ui.scene, and several viewport-specific extensions like omni.kit.viewport.menubar.camera. It also integrates with the presence and live session management tools to obtain and synchronize user information.
Integration with Live Sessions: Close collaboration with the presence_layer and live session management ensures that camera data for each user is current and accurately reflected in the viewport.