Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
collabviewer-UserInterface.png

Cavrnus Menu

Adding Cavrnus to your Collab Viewer Template project brings new menu options to your runtime user interface. These menu options give you additional navigation and content controls in in the Space, as well as communication tools for your collaborative team.

Button_CavrnusMenu.png

Clicking the Cavrnus logo at the top center of the screen expands or collapses the Cavrnus menu. By default, the Cavrnus menu appears collapsed.

icn_insert.png

Insert Menu

Using Cavrnus, you can insert images and models into a scene at runtime. You can choose from a library of pre-loaded content, or upload new files during a session. Other users in the Space will see the new objects in the Space once the files are converted to the Holo format. Their transform and state properties are stored in the Journal, and will persist in that Space until removed.

To learn more about the Holo format, see the Cavrnus knowledge base on Holos.

image-20240530-134207.png

icn_view_all.png

Insert Content

Opens the Content Library dialog box. From here you can insert models, images, PDF’s, and videos. The Cavrnus plugin includes a variety of pre-loaded content, or you can import new files to automatically convert them to the Holo format.

See the Cavrnus Knowledge Base to learn more about the Insert Content dialog box.

image-20240530-135140.png

icn_whiteboard.png

Add Boards

Select either “White Board” or “Stream Board” to add a board to your scene, then click a location in the Space to place the board.

See the Cavrnus Knowledge Base for more information on Boards.

Stream Boards

Flat surfaces for projecting a user’s screenshare. In a Cavrnus Space, you can view multiple user’s screens at once by setting up multiple Stream boards.

White Boards

Flat surfaces for writing, sketching, or posting notes for collaboration.

icn_layers.png

Object List

Toggle the Object List panel which lists all of the editable models in the scene. From this list, you can directly edit exposed properties for each object.

See the Cavrnus Knowledge Base for more information on the Object List.

image-20240530-145832.png

microphone-black-shape_off.png

icn_microphone.png

Audio Options

Toggles the microphone between Mute and Unmute. The state of the button icon indicates the current state of the microphone. This synchronizes with the headset icon in the standard CVT user interface.

The arrow to the right of the icon opens a dropdown list giving you quick access to configure your local audio input/output. These settings can also be configured in the Settings dialog box (described below).

If your selected microphone source picks up an audio signal while this feature is muted, you may see this popup over the microphone button. Simply click the 'X' button to close the warning.

image-20240530-161312.png
image-20240530-150839.png

icn_cam_on.png

icn_cam_off.png

Video/Screen Sharing Options

Toggles the video setting between Sharing and Not Sharing. The state of the button icon indicates the current state of the screen sharing. If a video source has not been selected (set to None), clicking the icon will open the dropdown list described below.

The vertical ellipsis to the right of the icon opens the Presentation Setting dialog giving you quick access to configure your local video sharing settings. From here you can select your video source and any presentation targets (stream boards) on which to display.

See the Cavrnus Knowledge Base for more information on the Object List.

image-20240530-151138.png

icn_users.png

User List

Toggles the user list which appears on the right side of the screen. The user list displays all of the users logged into the current Space, with each user card displaying either their thumbnail image or screenshare.

See the Cavrnus Knowledge Base for more information on the User List.

Note: Pressing the F10 key cycles through 4 states:

  • Cavrnus Menu on

  • User List on

  • Both on

  • Both off

icn_settings.png

User Settings

Opens the Settings dialog box. This dialog box allows each user to configure their own local preferences. These settings do not affect the local Space, only how the local user interacts with the Cavrnus system.

See the Cavrnus Knowledge Base for more information on the User Settings.

image-20240530-155915.png

icn_exit.png

Space Settings

Opens a menu with additional tools for navigating Spaces. See below for additional details.

image-20240530-160819.png

icn_view_all.png

View Spaces

Opens the Lobby as a dialog box. From here you can manage Spaces, create new Spaces, and switch to a different Space.

See the Cavrnus Knowledge Base to learn more about the Cavrnus Lobby.

image-20240530-161057.png

icn_create.png

Create Space

Opens a dialog prompting for the name of a new Space. Clicking OK on the dialog creates a new Space and automatically joins the user to it.

Note that all content in the project will reset to its original state in this new Space. Changes made in the previous Space will still be available in the Journal, but will not carry forward to the new Space.

To carry changes forward to a new Space, try using the “Duplicate Space” feature.

icn_duplicate.png

Duplicate Space

Creates a copy of the current Space, along with all property settings in the Journal. You can specify a new name for the Space in the dialog that pops up.

After the new Space is created, you will be prompted whether or not to join the new Space.

image-20240530-172551.png
icn_settings.png

Settings

Same as above.

icn_profile.png

User Profile

Opens the Profile Settings dialog box. Use this dialog to configure identity settings such as name, location, and profile image.

See the Cavrnus Knowledge Base to learn more about the Profile Dialog.

image-20240530-173949.png
icn_image.png

Set Space Thumbnail

Captures a screenshot of the current camera view and sets that as a thumbnail image for the Space. This is the image that will appear when the Space is listed in the Lobby.

icn_exit_Space.png

Exit Space

Leaves the current space and returns the user to the Lobby. The user will no longer appear within that Space to other users, and will no longer share screens or audio with that Space.

Collab Viewer Template Desktop Controls

The existing Collab Viewer Template tools work the same way as always, with additional functionality as listed below.

Navigation Mode Toolbar

Activate Walk mode

Walk mode

The avatar’s root follows the closest surface below it, with collisions turned on.

Third Person mode

The Cavrnus plugin adds a checkbox to swap the standard CVT bot avatar with the Third Person Character pawn. (e.g. Manny or Quinn by default). These avatars can be changed with your own content.

NOTE: Checking this box from any mode will automatically set the navigation mode to Walk.

CONTROLS:

Activate: Press the I key on your keyboard.

Move Forward: W
Move Backward: S
Strafe Left: A
Strafe Right: D

Look Around: Right-click and drag

Interaction Menu: Space Bar

Activate Fly mode

Fly mode

This performs the same way as standard CVT.

NOTE: Switching from Fly mode to Walk mode enables gravity. If the avatar is above the ground, it will free fall. Otherwise it will snap to the closest ground surface.

See the Epic Documentation for more details on Fly Mode Controls.

CONTROLS:

Activate: Press the U key on your keyboard.

Move Forward: W
Move Backward: S
Strafe Left: A
Strafe Right: D
Move Up: E
Move Down: Q

Look Around: Right-click and drag

Interaction Menu: Space Bar

Activate Orbit mode

Orbit mode

This performs the same way as standard CVT.

See the Epic Documentation for more details on Orbit Mode Controls.

CONTROLS:

Activate: Press the O key on your keyboard.

Orbit around POI: Right-click and drag
Reposition POI: Middle-click
Reposition POI and frame the object: Double middle-click
Zoom towards or away from POI: Scroll wheel

Look Around: Right-click and drag

Interaction Menu: Space Bar

Activate VR mode

VR mode

This performs the same way as standard CVT.

See the Epic Documentation for more details on VR controls.

CONTROLS:

Activate: Press the P key on your keyboard.

Set Teleport Location: Press and hold action button (varies based on HMD)
Set Orientation: Turn wrist while setting teleport location
Jump to New Location: Release action button (varies)

Interaction Menu: Move right thumbstick to select, and click to select.

Additional UI

Save

Saved State

While the Cavrnus Journal stores a more comprehensive history of changes, the Saving and Loading function still functions for storing changes locally and applying to a scene. This may be useful for duplicating changes in one Cavrnus Space to another.

See the Epic Documentation for more on Saving and Loading

USAGE:

  1. Click the save icon.

  2. Enter a name for the state in the field.

  3. Recall the state at a later time using the dropdown.

Voice Over IP

Mute/Unmute

The headset icon is synchronized with the Cavrnus mute/unmute function. Clicking this icon will also toggle the mute button in the Cavrnus toolbar.

USAGE:

Click the button to mute the microphone. The icon changes to show an 'x' inside the headset.


ON THIS PAGE

Table of Contents
minLevel1
maxLevel3
outlinefalse
stylenone
typelist
printabletrue
Auibutton
selectedUrlhttps://cavrnus.atlassian.net/wiki/spaces/CSM/pages/916586497
an.spaceKeyCSM
color#0B2942
filterSpacetrue
destinationconfluencePage
textColorPalettecfm-space-colors-Cavrnus Colors
idpplpcix26kq
typestandard
title<< Previous
textColor#FFFFFF
backgroundColorPalettecfm-space-colors-Cavrnus Colors
urlhttps://cavrnus.atlassian.net/wiki/spaces/CSM/pages/916586497
Auibutton
selectedUrlhttps://cavrnus.atlassian.net/wiki/spaces/CSM/pages/916586687
an.spaceKeyCSM
color#0B2942
filterSpacetrue
destinationconfluencePage
textColorPalettecfm-space-colors-Cavrnus Colors
idlfznotsne7e
typestandard
titleNext >>
textColor#FFFFFF
backgroundColorPalettecfm-space-colors-Cavrnus Colors
urlhttps://cavrnus.atlassian.net/wiki/spaces/CSM/pages/916586687