03. Mockup Review Tool

The Mockup Review Tool provides an interactive review environment for presenting and evaluating prepared 3D mockups. It supports desktop-based review workflows as well as immersive XR/VR experiences, with features for variant switching, animation playback, screenshot capture, and collaborative review.

Getting Started

Access the Mockup Review Tool windows from the main menu under Overtools:

• Variant Based Animations — Animation playback controls.
• Mock-up Review Settings — Review configuration dialog.
• Toolbar Tools — Tool palette for review actions.
• Toolbar Variants — Variant switching panel.
• Toolbar Animation — Animation bar.
• Camera — Dynamic focus and camera controls.
• Screenshot Tool — Image capture tool.

For the best review experience, switch to the Mock-Up Review workspace layout via Overtools > Layout Mock-Up Review.

Review Windows

Animation Bar

The Animation Bar provides playback controls for animations associated with variant sets in the scene.

Features: - Automatically discovers all animations in the scene. - Displays individual animation controller frames for each animation. - Supports play/pause and step-by-step playback modes. - Responds dynamically to variant changes — animations update in real-time when variants are switched. - Refreshes automatically when the stage hierarchy changes.

Menu: Overtools > Toolbar Animation

Variant Bar

The Variant Bar is a floating panel for switching between variants during a review session.

Features: - Displays all configured variant sets as collapsible groups. - Uses buttons for single-selection within each variant set. - Color-coded variant set groups for visual organization. - Variant selections are persisted to the USD stage via the mockupVariantSets attribute. - Responds in real-time to variant rename and delete events.

Menu: Overtools > Toolbar Variants

Toolbar

The Toolbar is a floating tool palette providing quick access to review-specific tools:

Tools are displayed as icon-based buttons with hover highlighting and active state indication.

Menu: Overtools > Toolbar Tools

Settings Window

The Settings Window is the main configuration dialog for review sessions. It contains four tabs:

General Settings

• Animation mode — Choose between full animation playback or step-by-step mode.
• Start anchor point — Set the VR reference origin point.
• Interactor rotation offset — Adjust the pitch angle of the hand controller (in degrees).
• Enable hand menu — Toggle the VR hand menu on or off.
• Hand menu position offset — Fine-tune the menu position relative to the hand (X, Y, Z in cm).
• Controller presets — Quick-apply settings for common controllers: Quest, HTC, Varjo.

Variant Bar Settings

• Add or remove variant sets from the review variant bar.
• Add or remove individual variants within each set.
• Configure variant set display using dropdown selectors.

XR Grabbable Objects

• Configure which scene objects can be grabbed and manipulated in VR.

Seatbuck Alignment

• Set up vehicle seat positioning for automotive review:
• Car — Top-level vehicle hierarchy.
• Seat — Seat positions within a vehicle.
• Eyepoint — Camera/viewing positions.
• Forward vector — Direction selection (X±, Y±, Z±).
• Supports drag-and-drop from the stage tree for hierarchy building.

Menu: Overtools > Mock-up Review Settings

Screenshot Window

The Screenshot Window provides viewport image capture with configurable resolution.

Resolution presets:

Features: - Destination folder — Browse and select the output directory (supports Omniverse/Nucleus paths). - Capture button — Takes a screenshot with automatic timestamped naming: screenshot-YYYYMMDDHHMMSS-WIDTHxHEIGHT.png. - Asynchronous capture with automatic viewport state restoration. - Success/error notification feedback.

Menu: Overtools > Screenshot Tool

XR/VR Support

The Mockup Review Tool includes comprehensive XR/VR functionality for immersive design review sessions.

XR Interactor

The primary interaction system for VR review sessions.

Grab Mechanics: - Objects configured as grabbable can be picked up and manipulated. - Grab detection range: 0.20 m with 64-sample raycasting. - Visual feedback: the interactor turns green when hovering over a grabbable object. - Trigger pressure controls interactor size (1.0 → 0.1 scale).

Selection Beam: - A selection beam extends from the controller for pointing and selecting. - Yellow beam indicates a pickable animation target. - Red beam indicates a hoverable/grabbable object. - Beam visibility can be toggled.

Animation Picking: - Click on prims with the enablePicking attribute to trigger associated animations. - Picking events include world-space position data.

UI Interaction: - Joystick scrolling support for navigating UI panels in VR. - Poke detection for pressing buttons in the virtual interface.

XR Navigation

Movement modes: - Fly/Walk — Joystick-based movement with configurable speed (default: 3.0 units/second). - Vertical movement activated by holding the vertical input. - Left/right rotation in 30° increments per click. - Acceleration boost (2×–3× speed) available. - Respects the stage coordinate system (Z-up or Y-up). - Teleportation — Point-and-jump movement (see XR Teleport). - Seatbuck — Vehicle-based seating (see XR Seatbuck Tool).

XR Teleport

Point-and-teleport navigation for VR environments.

How it works: 1. Press the teleport button on the controller. 2. A parabolic arc appears, projecting from the controller toward the ground. 3. A teleport marker appears at the landing point (only on level, coplanar surfaces with an upward-facing normal). 4. Release the button to teleport to the marked position.

Parameters: - Maximum arc height: 5.0 m (configurable). - Arc visualization: 32 segments. - Player height estimation: 1.7 m (adjusted using HMD position). - Coordinate-system aware (respects metersPerUnit stage setting).

XR Seatbuck Tool

Positions the viewer in a vehicle seat with proper eye alignment for automotive design review.

Vehicle hierarchy: - Cars — Top-level vehicle objects. - Seats — Seat positions within each car. - Eyepoints — Camera/viewing positions for each seat. - Natural Eye — Default head-based eye position.

Calibration workflow: 1. Position the left controller at your left hip and press any trigger. 2. Position the right controller at your right hip and press any trigger. 3. Sit up straight, look forward, and press any trigger. 4. The system computes your position and aligns the camera to the configured eye point. 5. Use the relocalize option to adjust if needed.

Configuration: Forward vector alignment with 6 axis options (X±, Y±, Z±).

XR Settings

In-VR settings panel for adjusting XR parameters during a review session.

Available settings: - Enable/disable hand menu. - Hand menu placement (same hand or opposite hand). - Hand menu position offset (X, Y, Z in cm). - Interactor pitch angle (0°–360°). - Teleport arc maximum height.

The settings menu appears as a floating 3.5×3.0 unit panel positioned 1 unit in front of the user, with a draggable handle for repositioning.

XR Debug Menu

A diagnostic overlay for development and troubleshooting.

Features: - Real-time information display updated every 500 ms. - Timestamp display (MM/DD/YYYY HH:MM:SS). - Custom debug content via static property. - Follows the left hand controller position.

XR Localization

Calibration tool for aligning the virtual and physical spaces in VR.

Calibration steps: 1. "Position your left controller next to your left hip, and then press any trigger button." 2. "Position your right controller next to your right hip, and then press any trigger button." 3. "Sit up straight and look in front of you, and then press any trigger button." 4. "Done."

The system computes the hip barycenter (average of left/right positions) and extracts the Y-rotation from the head pose to establish the user's position and orientation. Supports both Z-up and Y-up coordinate systems. A hand menu option allows re-localization at any time during the session.

Preferences

Access Mockup Review preferences via Edit > Preferences > Overtools Preferences or through the Settings Window.

Keyboard Shortcuts

All review tool windows are toggled via their corresponding Overtools menu items. XR interactions use controller buttons as described in each XR section above.

Related Documentation