Create a Viewer Modules Cloud (FGI) application

Introduction

A Viewer Modules Cloud application is a full custom application for on cloud or on premises solutions, built on a template that provides navigation functionalities with Gamepad, Mouse, and Keyboard and support for Windows, mobile platforms, and VR devices.

Steps

1. Use the New Project Wizard to create a Viewer Modules Cloud (FGI) project. The template is based on the Viewer (FGI) Module, which provides the needed basic elements to manage proper illumination in an FGI-based Viewer application.

2. Open the project graphic_context.xml file and populate the scene with content using the functionalities offered by the Graphic Context Editor.

3. Add item objects as described in Add Content in Graphic Context Editor.

4. Import from CAD.

5. Open the graphic_context_logic.xml file and write any project specific logic that is needed using the XR scripting language.

6. Use modules.xml to customize input, camera, and navigation behaviors. In particular, do the following:

   • Use the Input module to configure the input key associated to different actions

   • Use the Navigation module to customize navigation parameters (for example, speed, sprint speed, mouse rotation speed).

   • Use the MovableNode module to define the type of camera or avatar to use.

     If:

     • thirdPersonEnabled="false" and collisionsEnabled="false", a Camera node of type matrix will automatically be created.

     • thirdPersonEnabled="false" and collisionsEnabled="true", a Camera node of type avatar, an Avatar node with mode set to controller and an avatarController node will be created.

     • thirdPersonEnabled="true" and collisionsEnabled="true”, a Camera node of type avatar, an Avatar node with mode set to player will be created. In this case, you can use the “SwitchCameraMode” action to switch between three different cameraMode options (fps, behind and over).

       You can find a complete and detailed list of configurations, input and output, in the modules’ dedicated session.

7. Use files in RPC Commands Session to add your custom behaviors or edit existing ones.

   • In _cloud_manager.xml you can edit or add commands in CVSCloudManager commandRoutes.

   • In _rpc_examples.xml you can implement your own commands.

   • In _rpc_response_templates.xml you can find response and notification templates to be edited or reused in your commands implementation.

   • In _rpc_mandatory_behaviors.xml you can find the implementation of the predefined commands listed in the CVSCloudManager.

     • cmd_default—returns an error message in case the command for the current method has not been implemented or added to the cloud_manager.commandRoutes.

     • cmd_saveState—saves position and orientation of the selected MovableNode to be able to restore these in the rpc response.

     • cmd_loadState—receives the request to load previously saved data. A notification is sent when the process of retrieving the information starts and a second notification is sent when the process is completed.

In the template, different behaviors are associated to the different kind of MovableNode that can be created using the MovableNode module.

You can find a complete and detailed list of configurations, inputs, and outputs, in the dedicated XR Modules Guide.

Start the application

For Cloud solutions developers, to start the application:

8. In XRStudio, run Make Release Module Cloud. This will generate a pak named <project_name>_core.pak.

9. Add the pak from your cloud application solution and launch the framework using config_cloud.xml.

For mobile solutions developers, to test your project for NX on Windows, remember to copy the modules pak files (xrmodules_movable_node.pak, xrmodules_input.pak and xrmodules_navigation.pak) from XRStudio\bin\runtime\current\bin into your project folder before running the NX_OnPrem run configuration.

Project template

• Viewer Modules Cloud (FGI) template

Modules

• MovableNode Module

• Input Module

• Navigation Module

Procedures

• New Project Wizard: How to create a project based on a template.

• CAD importers and converters: How to import external data into an XR Studio project using Graphic Context Editor.

• Importing FBX: Details about importing FBX.