[Bf-docboard-svn] bf-manual: [8515] trunk/blender_docs/manual: VR: Update scene inspection add-on documentation

Peter Kim noreply at blender.org
Tue Oct 26 08:33:13 CEST 2021


Revision: 8515
          https://developer.blender.org/rBM8515
Author:   muxed-reality
Date:     2021-10-26 08:33:13 +0200 (Tue, 26 Oct 2021)
Log Message:
-----------
VR: Update scene inspection add-on documentation

Modified Paths:
--------------
    trunk/blender_docs/manual/addons/3d_view/vr_scene_inspection.rst
    trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_example.jpg

Added Paths:
-----------
    trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_action-maps.jpg
    trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_landmarks.jpg
    trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_view.jpg
    trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg
    trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_vr-session.jpg

Modified: trunk/blender_docs/manual/addons/3d_view/vr_scene_inspection.rst
===================================================================
--- trunk/blender_docs/manual/addons/3d_view/vr_scene_inspection.rst	2021-10-26 00:34:44 UTC (rev 8514)
+++ trunk/blender_docs/manual/addons/3d_view/vr_scene_inspection.rst	2021-10-26 06:33:13 UTC (rev 8515)
@@ -25,7 +25,6 @@
 Located in the :menuselection:`3D Viewport --> Sidebar --> VR tab`.
 
 .. figure:: /images/addons_3d-view_vr-scene-inspection_example.jpg
-   :align: right
    :width: 220px
 
 
@@ -32,23 +31,49 @@
 VR Session
 ----------
 
+.. figure:: /images/addons_3d-view_vr-scene-inspection_vr-session.jpg
+   :align: right
+   :width: 220px
+
 Start VR Session
    Try to set up a connection to the OpenXR platform to share the viewport with
    an :ref:`HMD <hardware-head-mounted-displays>`.
-Positional Tracking
-   Only track rotational changes of the head, do not allow the HMD to affect the location of
-   the viewer in virtual space.
+Tracking
+   - Positional
+      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
 ----
 
-Floor
-   Set visibility of the ground plane in the VR view.
-Annotations
-   Set visibility of annotation strokes in the VR view.
+.. 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.
+   - Annotations
+      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
-   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
@@ -55,7 +80,12 @@
 ---------
 
 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
    A :ref:`list view <ui-list-view>`.
 
@@ -62,7 +92,7 @@
    Selected Landmark
       Defines which landmark's settings are shown below the list.
       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.
    Add ``+``
       Create a landmark.
@@ -71,16 +101,50 @@
 Type
    Scene Camera
       Follow the :ref:`scene's active camera<scene-camera>` to define the base pose of the viewer.
-   Custom Camera
-      Set an arbitrary camera to define the base pose of the viewer.
+   Custom Object
+      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
 -----------------
 
+.. figure:: /images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg
+   :align: right
+   :width: 220px
+
 Show VR Camera
    Draw an indicator of the current VR viewer pose (location and rotation in the virtual space)
    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
    Make the current 3D Viewport follow the perspective of the VR view.
 
@@ -90,9 +154,9 @@
    :Category:  3D View
    :Description: View the viewport with virtual reality glasses (head-mounted displays).
    :Location: :menuselection:`3D Viewport --> Sidebar --> VR tab`
-   :File: viewport_vr_preview.py
-   :Author: Julian Eisel
-   :Maintainer: Julian Eisel
+   :File: viewport_vr_preview/__init__.py
+   :Author: Julian Eisel, Sebastian Koenig, Peter Kim
+   :Maintainer: Julian Eisel, Peter Kim
    :License: GPL
    :Support Level: Official
    :Note: This add-on is bundled with Blender.

Added: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_action-maps.jpg
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_action-maps.jpg
===================================================================
--- trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_action-maps.jpg	2021-10-26 00:34:44 UTC (rev 8514)
+++ trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_action-maps.jpg	2021-10-26 06:33:13 UTC (rev 8515)

Property changes on: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_action-maps.jpg
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Modified: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_example.jpg
===================================================================
(Binary files differ)

Added: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_landmarks.jpg
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_landmarks.jpg
===================================================================
--- trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_landmarks.jpg	2021-10-26 00:34:44 UTC (rev 8514)
+++ trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_landmarks.jpg	2021-10-26 06:33:13 UTC (rev 8515)

Property changes on: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_landmarks.jpg
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_view.jpg
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_view.jpg
===================================================================
--- trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_view.jpg	2021-10-26 00:34:44 UTC (rev 8514)
+++ trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_view.jpg	2021-10-26 06:33:13 UTC (rev 8515)

Property changes on: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_view.jpg
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg
===================================================================
--- trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg	2021-10-26 00:34:44 UTC (rev 8514)
+++ trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg	2021-10-26 06:33:13 UTC (rev 8515)

Property changes on: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_viewport-feedback.jpg
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_vr-session.jpg
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_vr-session.jpg
===================================================================
--- trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_vr-session.jpg	2021-10-26 00:34:44 UTC (rev 8514)
+++ trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_vr-session.jpg	2021-10-26 06:33:13 UTC (rev 8515)

Property changes on: trunk/blender_docs/manual/images/addons_3d-view_vr-scene-inspection_vr-session.jpg
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property


More information about the Bf-docboard-svn mailing list