Interacting with the Collab Viewer

Describes how to control the camera and interact with content at runtime in the Collab Viewer Template.

Choose your operating system:

Windows

macOS

Linux

This page describes the different ways you can control the camera and interact with content at runtime in the Collab Viewer Template, in both desktop and VR modes.

Desktop Controls

Toolbar

You can use the toolbars at the top of the window to teleport, switch navigation modes, and save the current session.

Icon

Description

Voice Over IP

Voice Over IP is enabled by default in the project. Toggle it on or off by clicking this icon.

Activate Fly mode

Activates Fly mode. In Fly mode, you can fly freely around the scene in all directions. In this mode, you pass through all geometry regardless of collision settings on the Actors. See Fly Mode Controls .

Returning to Walk mode after being in Fly mode re-enables gravity. Depending on your location, you will either free-fall until you reach the ground, or you will snap to the closest ground surface.

Activate Walk mode

Activates Walk mode. In Walk mode, you're held down to the ground by gravity. As you walk around the scene, you collide with any objects in the Level that are set up with collision volumes. See Walk Mode Controls .

Activate Orbit mode

Activates Orbit mode. In Orbit mode, you select a point of interest in the Level. Then, as you rotate the camera, you move around that point of interest, keeping it in the center of the screen. See Orbit Mode Controls .

Activate VR mode

Activates VR mode, if you have a supported VR headset installed and working. See VR controls .

Save

Saves the current state of the viewer, including annotations and measurements. See Saving and Loading a Session

Switch between modes quickly with the following hotkeys:

  • Activate Fly mode by pressing U on your keyboard.

  • Activate Walk mode by pressing I on your keyboard.

  • Activate Orbit mode by pressing O on your keyboard.

  • Activate VR mode by pressing P on your keyboard.

Common Desktop Controls

The following controls work the same way in all desktop movement modes: Fly mode, Walk mode, and Orbit mode.

To...

Do...

Activate the laser pointer

Move the mouse cursor to the object you want to highlight, then left-click.

Open the Interaction Menu

Press Spacebar . For details on using the items in this menu, see The Interaction Menu .

Move to a preset bookmark location

Press any number key from 0-9 that has been mapped to a specific bookmark location. See Working with Bookmarks in the Collab Viewer Template .

Exit the application

Press Esc .

Fly Mode Controls

In addition to the Common Desktop Controls , the following controls work in Fly mode.

To...

Do...

Look around the world from your current position

Right-click and drag.

Move forward, to the left, backward, or to the right from your current position

Hold the right mouse button and press W , A , S and D .

Move straight up or down (along the world's global Z axis)

Hold the right mouse button and press Q and E .

Walk Mode Controls

In addition to the Common Desktop Controls , the following controls work in Walk mode.

To...

Do...

Look around the world from your current position

Right-click and drag.

Move forward, to the left, backward, or to the right from your current position

Hold the right mouse button and press W , A , S and D .

Orbit Mode Controls

In addition to the Common Desktop Controls , the following controls work in Orbit mode.

To...

Do...

Orbit the camera around the point of interest

Right-click and drag.

Change the camera's point of interest to a new location, remaining at the current zoom level

Middle-click.

Choose a new point of interest, and zoom to fit the selected object in the viewport

Double middle-click.

Zoom in or out on the current point of interest

Turn the mouse wheel.

Pan the camera left, right, up, or down

Middle-click and drag.

VR Controls

To...

Do...

Teleport to a new location

  • Oculus Touch: Press and hold the B button on the right controller or the Y button on the left.

  • Valve Index Controller: Press and hold the B button on either controller.

  • HTC Vive Controller: Press and hold the Grip button on either controller. You'll see an arc emitted from your controller, and a target marker superimposed on the ground. The target marker represents your Teleport location. Move your controller in real world space to place the marker as close as possible to the place you want to move.

VR_Teleporting.gif

The pointer of the marker represents your facing direction after the teleport. You can control this facing direction by rotating your wrist. Release the button you're holding to complete the teleport.

Activate the laser pointer

Press the main trigger button on either controller, and move the controller around in real world space.

Open the Interaction Menu

Push the right-hand controller thumbstick forward or back. Use the thumbstick to highlight the option you want to activate, then press the thumbstick button to confirm your choice. For details on using the items in this menu, see The Interaction Menu .

Exit the application

Press Esc on your computer keyboard.

The Interaction Menu

The Interaction Menu offers you several commands and modes for interacting with the content in your scene at runtime.

The Interaction Menu

To open the Interaction Menu, press Spacebar in any desktop mode. See VR Controls for how to open the menu on your VR controller.

Command

Description

Xray

Use the options in the Xray sub-menu to apply and remove a see-through Material to selected objects in the scene.

Xray > Apply

Activates the Xray Apply mode. While this mode is active, any object you select in the scene with your laser pointer gets the see-through Material applied to it.

Xray > Isolate

Activates the Xray Isolate mode. While this mode is active, and you select an item in the scene with your laser pointer, the see-through Material is applied to all other Actors in the same hierarchy as the one you select.

Xray > Reset All

Instantly removes the see-through Material from all objects in the Level, returning them to their original Materials.

Explode

See Explode Option below.

Bookmark

Opens a list of all Bookmarks in the current Level. Select any Bookmark to teleport to its viewpoint. See also Working with Bookmarks .

Transform

Use the options in the Transform sub-menu to move selected objects around in the scene.

Transform > Move

Activates the Transform Move mode. When you select an object in the scene with your laser pointer, you can drag the laser pointer to move the selected object around in 3D space.

Transform > Reset

Activates the Transform Reset mode. When you select an object in the scene with your laser pointer, you instantly reset the selected object to its original position and rotation.

Transform > Reset All

Instantly returns all objects in the scene to their original positions and rotations.

Measurement

Use the options in the Measurement sub-menu to add and remove measurements. See Measuring in the Collab Viewer .

Measurement > Add

Activates the Measurement Add mode. While this mode is active, a measurement is drawn between each pair of points that you select.

Measurement > Delete

Activates the Measurement Delete mode. While this mode is active, you can select a measurement with your laser pointer to delete it.

Annotation

Use the options in the Annotation sub-menu to add and remove annotations. See Annotating in the Collab Viewer .

Annotation > Paint

Activates the Annotation Paint mode. While this mode is active, you can paint on a grid.

Annotation > Delete Stroke

Activates the Annotation Delete Stroke mode. While this mode is active, you can select a paint stroke with your laser pointer to delete it.

Snapshot > Take

Select to take a snapshot. Snapshots are saved as .PNG files in the YourProjectName/Saved/Snapshot sub-folder of the collaborative view package.

Bookmark

Opens a list of all Bookmarks in the current Level. Select any Bookmark in the sub-menu to teleport to its viewpoint. See also Working with Bookmarks .

When an interaction mode is active, such as Xray Apply , the name of the mode appears in the lower right of the viewport.

Explode Option

The Interaction Menu displays an Explode command for the first Explode_BP Actor it finds in your Level, if any. You can use this option to toggle between the default and exploded positions for the Actors managed by that Explode_BP Actor. For details, see Setting Up Explode Animations .

The Collab Viewer template includes an Explode_Gears Blueprint that explodes and rebuilds the transmission assembly inside the building:

Testing in VR in the Unreal Editor

When you launch a packaged or standalone version of the Collab Template with VR set up on your computer, you'll be able to switch to VR mode using the icon in the Toolbar.

However, if you want to use VR controls while testing your Project in the Unreal Editor, you'll need to follow these steps:

  1. Find the BP_CollaborativeViewer_GameInstance Asset in the Content Browser under CollaborativeViewer/Blueprints/GameInstance .
    BP_CollaborativeViewer_GameInstance

  2. Double-click the Asset to open it in the Blueprint Editor.

  3. In the My Blueprint panel, select the NavigationMode variable.
    NavigationMode variable

  4. In the Details panel, under the Default Value section, select VR for the Navigation Mode option.
    Game Instance Details panel

  5. Compile and Save the Blueprint.

  6. To launch the preview, use the drop-down arrow next to the Play button in the Toolbar to select VR Preview .
    VR Preview

Remember to turn this setting back off before you package your application! If you don't, the resulting package will not work as you expect.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss