Use the VRED xR Home Menu to access tools when wearing an HMD.

About the xR Home Menu

For participants in VR, click the xR Home Menu controller button to display the xR Home Menu. It houses an assortment of desktop tools, making them accessible while in VR.

Along the top of the Home Panel are icons and names of all collaboration session participants. To disable this feature, use the Python command, vrImmersiveUiService.setHideParticipantsVRPanel(true).

The current file name and time are found along the bottom.

The panel contains the following default options and more tools can be added using Python.

Variant Sets

Opens the Variant Sets (VSets) panel to access all variant sets created for the scene. Any variant sets set in a scene are automatically loaded into the Variant Sets panel of the xR Home Menu.

Viewpoints

Opens the Viewpoints panel to access all viewpoints created for the scene. Any viewpoints set in a scene are automatically loaded into the Viewpoints panel of the xR Home Menu.

Controller/Hand

Switches between displaying the controllers or hands. To do this another way, see How to Switch Between Hands and Controllers.

To set the displayed default, see Default Visualization.

Hand Poses Only

Toggles between using the pointer or hand gestures for communication. When enabled, you can point, give a thumbs up or down, make a fist, punch, or open your hand. It also disables all tools mapped to these button, with the exception of the xR Home Menu button. Use hand poses to interact with touch sensors and communicate with others, while in a session.

Teleport Ground

Sets the teleporting ground mode to either On Geometry or On Ground Plane. When Teleport Ground is enabled, teleport around the scene or into spaces, such as inside a car. When disabled, teleport onto geometry in the scene. To set a teleporting Ground Mode preference, see Virtual Reality Preferences.

Calibrate Ground

Provides a way to set where the ground plane is. When working with a model not created at the origin, participants will need to calibrate the ground to match that of the model.

Virtual Reality

Switches from the mixed reality mode to virtual reality.

Mixed Reality

Switches from virtual reality to the mixed reality mode. Avatars disappears. In their place is the user's nametag, displayed above the user's location.

Clear

Turns off virtual or mixed reality, so the user can see their actual surroundings while still wearing the HMD. This helps the user to avoid cables and other obsticles, as VRED uses the camera lenses of the headset to see the contents of the room.

Share Pointer

(Only available for VR Room participants) Changes whether other participants see or do not see your pointer. The default state is for it to be seen by others, enabled. For you, your pointer will be visible, whether this option is activated or not.

Since the pointer is meant to draw participants' attention to things during a collaboration session, when activating touch sensors or WebEngines, disable Share Pointer. Enable Share Pointer again when you need to get the others' attention.

Python-created Tools

Python-created tools can also be added to the xR Home Menu. These tools display this icon in the upper right corner. See VRED Python Examples for more examples of Python scripts.

Show Avatars

Shows or hides avatars. See Hide Avatars in a collaboration session.

Clipping Plane

Makes changes to the position of the clipping plane in the scene. See Module vrClippingModule.

Flashlight

(Only available for VR Room participants)

Shows or hides a flashlight. See Showing a flash light in VR.

Gather Users

Teleports all users in a collaboration session to a shared location. This enables all participants to look at the same thing from the same view. This is useful for design reviews. See Gather all users in a collaboration session.

Measure

Measures the distance between two selectable points in VR. See Measure distances in VR.

Place

Only available in MR mode.

Use for placing objects on and moving them along the ground of the scene, using the laser pointer. These objects must have an assigned scene tag, called Place.

The Place tool uses a similar approach to Teleport for rotating objects, that is rotating your wrist. You can snap the rotation to a 10° angle by pressing the controller's Grip button. Use this when trying to align one object with another. It is also possible to place objects atop one another.

Marker

Only available for Varjo XR mixed reality headset users.

Use a visible marker, known as the origin marker, for easy placement of objects in a mixed reality scene. The coordinate system is automatically synced. Your nodes need to be prepared before entering MR.

How to Access Tools

To access any of these tools, either tap with your virtual hand or use the pointer. For how to use these tools, see the following:

• How to Switch Between Hands and Controllers
• For Left-handed Users
• Using Hand Poses
• How to Use the Pointer
• How to Calibrate the Ground Level

To exit a panel and return to the previous one, press the X in the top right.

How to Scroll Through Lists

There are two ways to scroll through lists in the xR Home Menu.

• Click and drag a scroll bar up or down.

  

• Press the trigger and move the controller up or down to scroll through lists of options.

How to Add Functionality to the xR Home Menu

Use Python add functionality to the xR Home Menu, such as web content and access to VRED modules.

1. To see sample Python functions for adding functionality, select File > Open Example > vr > customMenuButton.py and click Open.

2. Select Edit > Script Editor to open the editor and take a look at the code.

   

3. Select Help > Python Documentation to refer to the Python documentation for details on these functions.

For more information on how to create xR Home Menu entries with Python, see Creating xR Home Menu Entries.

How to Hide Options in the xR Home Menu

If there are options you do or don't want displayed in the xR Home Menu, use Scripts > xR Home Menu to toggle them on or off.

In the menu bar, select Scripts > xR Home Menu, then either check an option to display it or uncheck it to hide it.

How to Remove Variant Sets from the xR Home Menu

There are two ways to do this:

To turn off the display of Variant Sets in the xR Home Menu from the desktop, select Scripts > xR Home Menu > Variant Sets, then remove the check next to it.

To remove Variant Sets from the xR Home Menu while in VR, so they cannot be seen in VR, use the Variant Sets module.

1. In the Variant Sets module, select the Variant Set groups to be removed from the left side.

2. In the General tab, uncheck Show in xR Home Menu. This removes all the selected Variant Sets from the xR Home Menu.

   

   

How to Display Hidden Variant Sets

To display hidden variant sets groups in the xR Home Menu, select the variant sets group along the left of the xR Home Menu, then in the Variant Sets module General tab, check Show in xR Home Menu.

How to Remove and Display Single Variant Sets

To remove single variant sets from a group, in the Variant Sets module, select the individual variant set, then uncheck Show in xR Home Menu.

To display a hidden variant set, select it, then in the General tab, check Show in xR Home Menu.

How to Start the VR Experience at a Certain Position in a Scene

VRED starts in a VR mode that uses the current camera position. The camera height is set to the ground.

Setting a Floor Detection Mode

VRED supports these two floor detection modes for teleporting:

• On Ground Plane - VRED uses a ground level and always positions the user at this height. The level can be set with Calibrate Ground in the xR Home Menu tool.

• On Geometry - VRED looks for geometry at the target of a teleport action. If geometry is found, the user is places on top of this geometry.

Click Teleport Ground to toggle between these modes.

Setting Viewpoint Position

Viewpoint adjustment modes are used to set viewpoint positions in relation to the position of the current HMD. For example, if you look directly at a viewport, independent from the current HMD position, orientation, and height, all modes should be set to True.

Mode	True	False
Adjust Height	Height will be Viewpoint Height - HMD height	Height will be floor height
Adjust Orientation	Orientation will be Viewpoint Orientation - HMD orientaiton	Orientation will be viewpoint orientation
Adjust Position	Position will be Viewpoint Position - HMD position	Position will be viewpoint position

Preparing Nodes for Placement

To pick and place objects in MR, you must first prepare the nodes. If objects are too large or small for your room, they will need to be scaled to an appropriate size before entering MR.

1. Create a tag and rename is Place.
2. Drag and drop an object node onto this tag.

Using Place

Nodes from your scene must be tagged before continuing. If this has not been done, see Preparing Nodes for Placement before continuing.

1. Wearing a connected Varjo HMD that supports MR, in VRED, select View > Display > Varjo HMD. The objects that were tagged with the Place appear in MR.

2. Open the xR Home Menu with your controller and select Place.

   

   When highlighted orange, the tool is enabled. When gray, the tool is disabled. An indicator appears above your controller stating what is active and picked.

3. Point to an object and continually squeeze the trigger to pick and move it on the virtual ground.

4. Use your controller to rotate it around the up axis.

   Tip:

   Squeeze the Grip button to snap to 10 degree angle increments. Use this to help with the alignment of your object to another.

Preparing Nodes for Markers

Follow these steps to prepare your nodes before entering MR. Note that objects that won't fit in your room will need to be scaled down before entering MR.

1. Add a tag and rename it VarjoMarker.
2. Drag and drop an object node onto this tag to assign it.
3. Create another tag and rename it to the number printed on the Varjo marker.
4. Drag and drop the same object node onto this tag.

Using Markers

Nodes from your scene must be tagged before continuing. If this has not been done, see Preparing Nodes for Markers before continuing.

1. Wearing a connected Varjo HMD that supports MR, in VRED, select View > Display > Varjo HMD. The objects that were tagged with the VarjoMarker and number tags appear in MR.

2. Open the xR Home Menu with your controller and select Enable Markers.

   

   The geometry jumps directly onto the marker.

   Tip:

   Disable Enable Marker in the xR Home Menu to stop any jiggling of the object that may occur.

You can attach nodes to tracked markers, using a Python script. This script enables out-of-the-box functionality. The script attaches to all nodes with a name related to the marker id to the corresponding tracked marker. Use it to turn off some visual hints regarding the detection of markers.