blender/blender-manual
29
29
Fork 171
Code Issues 79 Pull Requests 7 Projects 1 Releases Wiki Activity

VR: Update scene inspection add-on documentation

Browse Source
This commit is contained in:
Peter Kim 2021-10-26 06:33:13 +00:00
parent 8b9f1275a6
commit 2b3d8038ab
7 changed files with 96 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
manual/addons/3d_view/vr_scene_inspection.rst
View File

@ -25,36 +25,66 @@ Interface
Located in the :menuselection:`3D Viewport --> Sidebar --> VR tab`. Located in the :menuselection:`3D Viewport --> Sidebar --> VR tab`.
.. figure:: /images/addons_3d-view_vr-scene-inspection_example.jpg .. figure:: /images/addons_3d-view_vr-scene-inspection_example.jpg
:align: right
:width: 220px :width: 220px
VR Session VR Session
---------- ----------
.. figure:: /images/addons_3d-view_vr-scene-inspection_vr-session.jpg
:align: right
:width: 220px
Start VR Session Start VR Session
Try to set up a connection to the OpenXR platform to share the viewport with Try to set up a connection to the OpenXR platform to share the viewport with
an :ref:`HMD <hardware-head-mounted-displays>`. an :ref:`HMD <hardware-head-mounted-displays>`.
Positional Tracking Tracking
Only track rotational changes of the head, do not allow the HMD to affect the ___location of - Positional
the viewer in virtual space. Only track rotational changes of the head, do not allow the HMD
to affect the ___location of the viewer in virtual space.
- Absolute
Skip eye offsets that are normally added for placing the viewer
exactly at landmarks. This allows the tracking origin to be defined
independently of the HMD position.
Use Controller Actions
Enable default controller actions for viewport navigation,
controller tracking, and haptics.
View View
---- ----
Floor .. figure:: /images/addons_3d-view_vr-scene-inspection_view.jpg
:align: right
:width: 220px
Show
- Floor
Set visibility of the ground plane in the VR view. Set visibility of the ground plane in the VR view.
Annotations - Annotations
Set visibility of annotation strokes in the VR view. Set visibility of annotation strokes in the VR view.
- Selection
Set visibility of selection outlines in the VR view.
- Controllers
Set visibility of VR motion controllers.
Requires enabling the `Use Controller Actions <VR Session_>`_ option.
- Custom Overlays
Set visibility of custom operator drawing (e.g. default teleport beam).
Controller Style
Preferred visualization of VR motion controllers.
Clip Start/End Clip Start/End
Clipping values of the VR view, :ref:`as in the 3D Viewport <3dview-view-clip>`. Clipping values of the VR view, :ref:`as in the 3D Viewport<3dview-view-clip>`.
Landmarks Landmarks
--------- ---------
Landmarks are used to store reusable base poses (position and rotation) for the viewer in the virtual space. Landmarks are used to store reusable base poses (position and rotation) for the viewer in the virtual space.
In addition, a base viewer reference scale can be set for landmarks of types Custom Object and Custom Pose.
.. figure:: /images/addons_3d-view_vr-scene-inspection_landmarks.jpg
:align: right
:width: 220px
Landmark Landmark
A :ref:`list view <ui-list-view>`. A :ref:`list view <ui-list-view>`.
@ -62,7 +92,7 @@ Landmark
Selected Landmark Selected Landmark
Defines which landmark's settings are shown below the list. Defines which landmark's settings are shown below the list.
Changing the selected landmark does not have an influence on the VR view. Changing the selected landmark does not have an influence on the VR view.
Activate (star icon) Activate (circle icon)
Activates a landmark, making it change the base pose of the VR view. Activates a landmark, making it change the base pose of the VR view.
Add ``+`` Add ``+``
Create a landmark. Create a landmark.
@ -71,16 +101,50 @@ Landmark
Type Type
Scene Camera Scene Camera
Follow the :ref:`scene's active camera<scene-camera>` to define the base pose of the viewer. Follow the :ref:`scene's active camera<scene-camera>` to define the base pose of the viewer.
Custom Camera Custom Object
Set an arbitrary camera to define the base pose of the viewer. Set an arbitrary object to define the base pose of the viewer.
Custom Pose
Manually define a position and rotation to use as the base pose of the viewer.
Action Maps
-----------
.. figure:: /images/addons_3d-view_vr-scene-inspection_action-maps.jpg
:align: right
:width: 220px
Gamepad
Use input from a gamepad (Microsoft Xbox Controller) instead of motion controllers for
VR actions such as viewport navigation.
Extensions
Enable additional controller bindings to ensure correct input-to-action mappings.
Note that a given extension may not be supported by all
:ref:`VR platforms <hardware-head-mounted-displays>`.
- HP Reverb G2
Enable bindings for the HP Reverb G2 controllers.
- HTC Vive Cosmos
Enable bindings for the HTC Vive Cosmos controllers.
- Huawei
Enable bindings for the Huawei controllers.
Viewport Feedback Viewport Feedback
----------------- -----------------
.. figure:: /images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg
:align: right
:width: 220px
Show VR Camera Show VR Camera
Draw an indicator of the current VR viewer pose (___location and rotation in the virtual space) Draw an indicator of the current VR viewer pose (___location and rotation in the virtual space)
in the current 3D Viewport. in the current 3D Viewport.
Show VR Controllers
Draw indicators of tracked VR motion controllers in the current 3D viewport.
Requires enabling the `Use Controller Actions <VR Session_>`_ option.
Show Landmarks
Draw `landmark <Landmarks_>`_ indicators in the current 3D Viewport.
Mirror VR Session Mirror VR Session
Make the current 3D Viewport follow the perspective of the VR view. Make the current 3D Viewport follow the perspective of the VR view.
@ -90,9 +154,9 @@ Mirror VR Session
:Category: 3D View :Category: 3D View
:Description: View the viewport with virtual reality glasses (head-mounted displays). :Description: View the viewport with virtual reality glasses (head-mounted displays).
:Location: :menuselection:`3D Viewport --> Sidebar --> VR tab` :Location: :menuselection:`3D Viewport --> Sidebar --> VR tab`
:File: viewport_vr_preview.py :File: viewport_vr_preview/__init__.py
:Author: Julian Eisel :Author: Julian Eisel, Sebastian Koenig, Peter Kim
:Maintainer: Julian Eisel :Maintainer: Julian Eisel, Peter Kim
:License: GPL :License: GPL
:Support Level: Official :Support Level: Official
:Note: This add-on is bundled with Blender. :Note: This add-on is bundled with Blender.

BIN
manual/images/addons_3d-view_vr-scene-inspection_action-maps.jpg (Stored with Git LFS) Normal file
View File

Binary file not shown.

BIN
manual/images/addons_3d-view_vr-scene-inspection_example.jpg (Stored with Git LFS)
View File

Binary file not shown.

BIN
manual/images/addons_3d-view_vr-scene-inspection_landmarks.jpg (Stored with Git LFS) Normal file
View File

Binary file not shown.

BIN
manual/images/addons_3d-view_vr-scene-inspection_view.jpg (Stored with Git LFS) Normal file
View File

Binary file not shown.

BIN
manual/images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg (Stored with Git LFS) Normal file
View File

Binary file not shown.

BIN
manual/images/addons_3d-view_vr-scene-inspection_vr-session.jpg (Stored with Git LFS) Normal file
View File

Binary file not shown.