Создание приложения на основе шаблона

UNIGINE has a ready-to-use template for making VR projects in C#. It supports Oculus Rift and HTC Vive / Vive Pro (OpenVR) out of the box. It also provides a sample project (VR Sample). Here, you will find a set of 3D models of all popular VR controllers and the implementation of basic mechanics such as grabbing and throwing objects, pressing buttons, opening/closing drawers, and a lot more.UNIGINE предлагает готовый шаблон для разработки на C# под VR, позволяющий сразу приступить к созданию собственных проектов. Он поддерживает Oculus Rift, HTC Vive / Vive Pro (OpenVR) "из коробки". Кроме того, имеется также пример проекта (VR Sample), который можно взять за основу для вашего собственного VR-приложения. Здесь вы найдете набор 3D-моделей популярных контроллеров VR, а также реализацию основных механик, таких как захват и толкание объектов, нажатие кнопок, открытие / закрытие ящиков и многое другое.

The world in this sample project has its settings optimized for best performance in VR.Мир в этом примере имеет свои настройки, оптимизированные для наилучшей производительности в VR.

Both the template and the sample project are created using the Component System — components attached to objects determine their functionality.Шаблон, как и пример проекта, созданы с использованием Компонентной системы, поэтому функциональность каждого объекта определяется набором добавленных к нему компонентов.

You can extend an object's functionality simply by assigning it more components. For example, the laser pointer object in the VR Sample has the following components attached:Вы можете расширить функциональность того или иного объекта, просто добавив к нему дополнительные компоненты. Например, к объекту лазерной указки прикреплены следующие компоненты:

• VRTransformMovableObject — enables grabbing and throwing an objectVRTransformMovableObject – позволяет хватать и бросать объект
• VRLaserPointer — enables casting a ray of light by the objectVRLaserPointer – позволяет включать луч света лазерной указки

You can also implement custom components to extend functionality.Кроме того, можно написать собственные компоненты, реализующие тот или иной функционал и расширить возможности шаблона.

The main features of the VR Sample:Базовый функционал сэмпла:

• VR support (OpenVR-compatible devices including Oculus Rift, HTC Vive, and others)Поддержка VR (Oculus Rift и HTC Vive/OpenVR)
• A set of physical objects that can be manipulated via controllers (physical objects, buttons, drawers)Набор физических объектов, которыми можно управлять с помощью контроллеров (физические объекты, кнопки, переключатель, выдвижной ящик)
• An interactive laser pointer objectИнтерактивный объект "лазерная указка"
• Teleportation around the sceneТелепортация по сцене
• GUIПользовательский интерфейс
• Interaction with GUI objects via controllersВзаимодействие с объектами графического интерфейса через контроллеры

Let's create a project based on the C# VR Template.Итак, давайте создадим проект на основе шаблона C# VR Template.

1. Open SDK Browser, go to the My Projects tab, and click Create New.Откройте SDK Browser, перейдите на вкладку My Projects и щелкните Create New.
2. 

   In the Create New Project window, specify the project name VRProject, select VR in the Template menu, then C#(.NET) in the API+IDE menu, and select Float in the Precision menu. Then click Create New Project.In the Create New Project window, specify the project name VRProject, select VR in the Template menu, then C#(.NET) in the API+IDE menu, and select Float in the Precision menu. Then click Create New Project.

   

   In the Create New Project window, specify the project name VRProject, select VR in the Template menu, then C#(.NET) in the API+IDE menu, and select Float in the Precision menu. Then click Create New Project.

   In the Create New Project window, specify the project name VRProject, select VR in the Template menu, then C#(.NET) in the API+IDE menu, and select Float in the Precision menu. Then click Create New Project.В открывшемся окне Create New Project задайте имя вашего проекта VRProject, в меню Template выберите шаблон приложения VR, в меню API+IDE выберите C#(.NET), а в меню Precision выберите Float. Затем нажмите Create New Project.

   

3. When the project is successfully created, open it in UnigineEditor.После успешного создания проекта откройте его в Редакторе.
4. In the Asset Browser, open the vr_sample.world file located in the data/vr_template/vr_sample/ folder. We will work with this world.Затем в Asset Browser откройте мир vr_sample.world, который лежит в папке data/vr_template/vr_sample/. С этим миром и будем работать.

Now, let's learn a bit more about the template structure. All components that implement the basic VR functionality are assigned to the corresponding nodes organized in the hierarchy with the vr_layer root node (see the picture below):Теперь давайте немного познакомимся со структурой шаблона. Для простоты понимания и удобства использования все компоненты, реализующие базовый VR-функционал, назначены на соответствующие ноды, которые организованы в иерархию с корневой нодой vr_layer (см. схему ниже):

A player is represented by the hierarchy of nodes with the vr_player node in the root (a Player Dummy camera), to which the VRPlayer component is assigned. The component implements the player's logic. The child nodes of vr_player represent models of HMDs and controllers, to which all necessary components are assigned to configure interactions and main parameters.Игрок представлен иерархией ноды vr_player (камера Player Dummy) с назначенным компонентом VRPlayer, реализующим логику игрока. Дочерними нодами vr_player являются модели шлема, контроллеров, на которые назначены все необходимые компоненты для настройки взаимодействий и основных параметров.

VRInput is the main component that implements operations on user input, it includes all available devices, controllers, controls (controllers + common ones), event handlers, and so on. Input parameters for each type of device, functionality for polling the status of controls, etc. are implemented in the corresponding classes (PCInput, ViveInput, OculusInput). The functionality of the devices is implemented in the components inherited from the VRHeadController component (for HMDs — ViveHeadController, OculusHeadController, PCHeadController) and from the VRHandController component (for controllers — ViveHandController, OculusHandController, PCHandController).VRInput – основной компонент, реализующий работу с пользовательским вводом, в нем содержатся списки возможных устройств, контроллеров, элементов управления (контроллеры + общие), обработчики событий и т.д. Параметры ввода для каждого конкретного типа оборудования, функционал опроса состояния элементов управления и т.д. реализованы в соответствующих классах (PCInput, ViveInput, OculusInput). Работа самих устройств реализована в соответствующих классах, унаследованных от VRHeadController (для шлемов – ViveHeadController, OculusHeadController, PCHeadController) и VRHandController (для контроллеров – ViveHandController, OculusHandController, PCHandController).

The VRMovementManager component is used for movement management. Different types of movements (rotating, walking, teleporting) are implemented in the components inherited from the base VRBaseMovement component (TurnMovement, WalkMovement, TeleportationMovement + implementation of movements for the VR emulation mode with keyboard control).VRMovementManager – компонент, реализующий управление движением. Различные типы движения (повороты, ходьба, телепортирование) реализованы в компонентах унаследованных от базового VRBaseMovement (TurnMovement, WalkMovement, TeleportationMovement + реализация движений для режима VR-эмуляции с управлением от клавиатуры).

The VRInteractionManager component is used for interaction management. Different types of interactions are implemented in the components inherited from the base VRBaseInteraction component:VRInteractionManager – компонент, реализующий управление взаимодействиями. Различные типы взаимодействий (повороты, ходьба, телепортирование) реализованы в компонентах унаследованных от базового VRBaseInteraction:

• RHandMenuInteraction — interaction with the menu using controllersRHandMenuInteraction – взаимодействие с меню при помощи контроллеров,
• VRHandShapeInteraction — interaction with objects using controllers and the keyboardVRHandShapeInteraction – взаимодействие с объектами при помощи контроллеров и клавиатуры,
• VRPCHeadMenuInteraction — interaction with the menu for the VR-emulation mode with keyboard controlVRPCHeadMenuInteraction – взаимодействие с меню для режима VR-эмуляции с управлением от клавиатуры),
• VRBaseInteractable is a base component for all interactive objects (objects you can interact with). It defines the main interactions: here you specify the available actions with the object. You can also add your own interaction type.VRBaseInteractable – это базовый класс для всех интерактивных объектов (тех, с которыми вы можете взаимодействовать). Другими словами, он определяет базовый набор взаимодействий: здесь вы указываете, что пользователь может делать с вашим объектом. Здесь же можно добавить и собственный тип взаимодействия.

The following components are inherited from VRBaseInteractable:Следующие классы компонентов унаследованы от VRBaseInteractable:

VRTransformMovableObject	This component type can be used for all objects that can be grabbed, held, and thrown (it can be a ball, a pistol, whatever you can take, carry and drop).Этот тип компонента можно использовать для всех объектов, которые можно схватить, удерживать и бросить (это может быть мяч, пистолет, все, что вы можете взять, нести и бросить).
VRKinematicMovableObject	This component type can be used for all objects that can be grabbed, held, and thrown (it can be a ball, a pistol, whatever you can take, carry and drop).Этот тип компонента можно использовать для всех объектов, которые можно схватить, удерживать и бросить (это может быть мяч, пистолет, все, что вы можете взять, нести и бросить).
VRPhysicMovableObject	This component type can be used for all objects that can be grabbed, held, and thrown (it can be a ball, a pistol, whatever you can take, carry and drop).Этот тип компонента можно использовать для всех объектов, которые можно схватить, удерживать и бросить (это может быть мяч, пистолет, все, что вы можете взять, нести и бросить).
VRObjectHandle	This component type can be used for all objects that can be rotated or moved while being held (various handles, levers, valves, etc.).Этот тип компонента можно использовать для всех объектов, которые можно поворачивать или перемещать при удерживании (различные ручки, рычаги, клапаны и т. д.).
VRObjectSwitch	This component type can be used for all objects that can be switched by grabbing (all sorts of buttons and on-off switches, including rotary ones). It can be used in combination with the VRNodeSwitchEnableByGrab component for additional effects.Этот тип компонента можно использовать для всех объектов, которые можно переключать захватом (всевозможные кнопки и переключатели, включая поворотные). Может использоваться в сочетании с компонентом VRNodeSwitchEnableByGrab для обеспечения дополнительных эффектов.
VRNodeSwitchEnableByGrab	This component type is used to control enabling/disabling of one or more nodes when grabbed.Этот тип компонента позволяет управлять включением/выключением одной или множества нод при захвате.
VRLaserPointer	This component enables casting a laser ray by the object. The laser pointer node has two components assigned — VRTransformMovableObject and VRLaserPointer.Этот компонент позволяет направить на объект лазерный луч. К объекту лазерной указки прикреплены компоненты VRTransformMovableObject и VRLaserPointer.

Suppose you have successfully installed your Head-Mounted Display (HMD) of choice (please visit Oculus Rift Setup or HTC Vive Setup if you did not). If you are having difficulties getting your HTC Vive to work, this Troubleshooting guide might be helpful.Предположим, вы успешно установили выбранный головной дисплей (HMD). Пожалуйста, посетите Oculus Rift Setup или HTC Vive Setup, если вы этого не сделали. При возникновении проблем с началом работы HTC Vive, может оказаться полезным это руководство по устранению неполадок.

Major VR devices (OpenVR-compatible) are supported out of the box.Основные устройства виртуальной реальности (OpenVR-совместимые) поддерживаются "из коробки".

Run the application and learn about basic mechanics, grab and throw objects, try to teleport and interact with objects in the scene.Запустите приложение и познакомьтесь с механиками в действии, попробуйте перемещение, телепортацию и взаимодействие со всеми интерактивным объектами в сцене.