Read the latest documentation here
Creating VR Projects¶
What this is¶
Creating a VR project means building a simulated environment from ready-made models. The resulting environment will contain required objects and will function by pre-defined script.
Creating a project, adding scenes¶
- Run the Varwin RMS app.
- Enter the Project List section. Click ‘Add Project.’ Name your project, then click ‘Add.’
- Your project appeared on the list. The project structure automatically opens at once.
- You are in the Project Structure section. Click ‘Add scene’. Name your new scene and select a scene template for it.
- Now that the scene is added, you can place objects in it. It can be done within or without VR.
Editing without VR (Desktop editor)¶
Use your mouse and keyboard to edit VR scenes. The Desktop Editor feature allows editing without VR, namely place objects on the scene and set their positions. To use this feature, click “Edit on desktop.”
- place objects on the scene
- move objects, set precise coordinates (choose the exact location with the help of coordinate axes)
- rotate objects along the chosen axis, set precise parameters
- scale objects along the chosen axis, set precise parameters
- search objects within the list
- delete objects
- Grab: Q
- Place: W
- Rotate: E
- Scale: R
- Focus on the object: F
- Clone objects: Ctrl+C, Ctrl+V
- Orthographic projection of the scene available
- Go to VR with one button
- cancel action
- repeat action
- move camera
- move object
- rotate object
- scale object
Local - the object rotation and movement are relative to its own axis. World - the object rotates and moves accordingly to world space orientation.
Pivot - the object rotates and moves around its pivot point selected by the developer. Center - the object rotates and moves around its geometric center
Perspective projection toggle
The toggle switches the perspective projection between standard and orthographic.
Switch to other modes
1 - go to VR 2 - go to Desktop View mode*
*To leave the Desktop View mode, press Escape. You’ll receive suggestions to switch to VR, return to Desktop Edit mode, or cancel exiting.
Library and objects
Toggle between the object library and the list of spawned objects. You can also search objects here. By selecting a spawned object in the list, you also select it on the scene.
Here you can see the name, ID and type of the selected object, and parameters of its position. Also, here you can delete the selected object.
Editing in VR¶
- Click “Edit in VR.” You’ll see the boot screen, then the scene will open in a new window.
- Open the VR menu and select an object.
See also: VR menu functions
- Place the object in the scene:
- Carry it to the desired place,
- Press the Trigger button on your controller,
- The object appears in the scene; it will hang in the air or stick to the surface.
- At the same time, this object will stay in your hand. You can spawn a lot of identical objects by pressing the Trigger button required number of times.
- Press the Grip button to remove the object from your hand.
- Open the VR menu and save changes. The objects spawned in VR appear in the Varwin RMS interface immediately after you save changes in VR.
- Go back to the Project Structure tab. You’ll see the list of spawned objects appeared in the scene. The objects can be renamed.
- Click ‘Open the visual logic editor.’
- Here you can work with the project script.
- Create a script and click ‘Apply.’ The changes will apply in VR. You can also view the script as code; to do that, click ‘Open code editor.’
You can preview each scene of your future project both in VR and on desktop.
Preview in VR¶
You can preview your project in VR.
Preview without VR (Desktop Player)¶
The Desktop Player feature allows previewing both separate scenes and the whole project without VR equipment.
- W, A, S, D buttons - movement
- Q - teleportation
- Ctrl - squatting
- Shift - running
- Space - jumping
- LMB - Use (Trigger button analog),
- RMB - Grab (Grip button analog),
- MMB + mouse movement - turning the object
- Left Alt +mouse movement - moving the object.
App launch configurations¶
An app launch configuration is a sequence of the scenes in the project.
A default configuration is created automatically when the user adds the first scene to the project. Other custom configurations can be added.
If there are several scenes in the project, the user can select a start scene.
In the App launch configurations section, you can select a loading scene. The users will see it at the moments of transition from one scene to another in the VR.
To select a loading scene,
- Open your project. Select an app launch configuration. Click Edit,
- Click Loading scene. Select one from the dropdown list,
- Click Apply.
Selecting a loading scene is optional. If you choose not to do it, the default Varwin scene will be displayed as the loading scene.
You can create a custom loading scene. It can display information about the loading process, or other data. To learn how to do it, follow this link.
When the logic is created, you can view your future project. In the View mode, you will see the whole project, while the Preview mode refers to separate scenes.
The View mode can be switched on if the project has at least one configuration. You can view your project either in VR or on the desktop.
Building apps out of projects¶
When the project is completed, an app for the end user can be built out of it. The apps are exported as .exe files. They can be launched on any PC. Varwin platform installation is not needed to launch an exported app. Export of the ready apps is not available for Starter Edition.