viewport_vr_preview/gui.py

   1 # SPDX-FileCopyrightText: 2021-2023 Blender Foundation
   2 #
   3 # SPDX-License-Identifier: GPL-2.0-or-later
   4
   5 if "bpy" in locals():
   6     import importlib
   7     importlib.reload(properties)
   8 else:
   9     from . import properties
  10
  11 import bpy
  12 from bpy.app.translations import pgettext_iface as iface_
  13 from bpy.types import (
  14     Menu,
  15     Panel,
  16     UIList,
  17 )
  18 # Add space_view3d.py to module search path for VIEW3D_PT_object_type_visibility import.
  19 import os.path, sys
  20 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../startup/bl_ui')))
  21 from space_view3d import VIEW3D_PT_object_type_visibility
  22
  23
  24 ### Session.
  25 class VIEW3D_PT_vr_session(Panel):
  26     bl_space_type = 'VIEW_3D'
  27     bl_region_type = 'UI'
  28     bl_category = "VR"
  29     bl_label = "VR Session"
  30
  31     def draw(self, context):
  32         layout = self.layout
  33         session_settings = context.window_manager.xr_session_settings
  34         scene = context.scene
  35
  36         layout.use_property_split = True
  37         layout.use_property_decorate = False  # No animation.
  38
  39         is_session_running = bpy.types.XrSessionState.is_running(context)
  40
  41         # Using SNAP_FACE because it looks like a stop icon -- I shouldn't
  42         # have commit rights...
  43         toggle_info = ((iface_("Start VR Session"), 'PLAY') if not is_session_running
  44                        else (iface_("Stop VR Session"), 'SNAP_FACE'))
  45         layout.operator("wm.xr_session_toggle", text=toggle_info[0],
  46                         translate=False, icon=toggle_info[1])
  47
  48         layout.separator()
  49
  50         col = layout.column(align=True, heading="Tracking")
  51         col.prop(session_settings, "use_positional_tracking", text="Positional")
  52         col.prop(session_settings, "use_absolute_tracking", text="Absolute")
  53
  54         col = layout.column(align=True, heading="Actions")
  55         col.prop(scene, "vr_actions_enable")
  56
  57
  58 ### View.
  59 class VIEW3D_PT_vr_session_view(Panel):
  60     bl_space_type = 'VIEW_3D'
  61     bl_region_type = 'UI'
  62     bl_category = "VR"
  63     bl_label = "View"
  64
  65     def draw(self, context):
  66         layout = self.layout
  67         session_settings = context.window_manager.xr_session_settings
  68
  69         layout.use_property_split = True
  70         layout.use_property_decorate = False  # No animation.
  71
  72         col = layout.column(align=True, heading="Show")
  73         col.prop(session_settings, "show_floor", text="Floor")
  74         col.prop(session_settings, "show_annotation", text="Annotations")
  75
  76         col.prop(session_settings, "show_selection", text="Selection")
  77         col.prop(session_settings, "show_controllers", text="Controllers")
  78         col.prop(session_settings, "show_custom_overlays", text="Custom Overlays")
  79         col.prop(session_settings, "show_object_extras", text="Object Extras")
  80
  81         col = col.row(align=True, heading=" ")
  82         col.scale_x = 2.0
  83         col.popover(
  84             panel="VIEW3D_PT_vr_session_view_object_type_visibility",
  85             icon_value=session_settings.icon_from_show_object_viewport,
  86             text="",
  87         )
  88
  89         col = layout.column(align=True)
  90         col.prop(session_settings, "controller_draw_style", text="Controller Style")
  91
  92         col = layout.column(align=True)
  93         col.prop(session_settings, "clip_start", text="Clip Start")
  94         col.prop(session_settings, "clip_end", text="End")
  95
  96
  97 class VIEW3D_PT_vr_session_view_object_type_visibility(VIEW3D_PT_object_type_visibility):
  98     def draw(self, context):
  99         session_settings = context.window_manager.xr_session_settings
 100         self.draw_ex(context, session_settings, False) # Pass session settings instead of 3D view.
 101
 102
 103 ### Landmarks.
 104 class VIEW3D_MT_vr_landmark_menu(Menu):
 105     bl_label = "Landmark Controls"
 106
 107     def draw(self, _context):
 108         layout = self.layout
 109
 110         layout.operator("view3d.vr_camera_landmark_from_session")
 111         layout.operator("view3d.vr_landmark_from_camera")
 112         layout.operator("view3d.update_vr_landmark")
 113         layout.separator()
 114         layout.operator("view3d.cursor_to_vr_landmark")
 115         layout.operator("view3d.camera_to_vr_landmark")
 116         layout.operator("view3d.add_camera_from_vr_landmark")
 117
 118
 119 class VIEW3D_UL_vr_landmarks(UIList):
 120     def draw_item(self, context, layout, _data, item, icon, _active_data,
 121                   _active_propname, index):
 122         landmark = item
 123         landmark_active_idx = context.scene.vr_landmarks_active
 124
 125         layout.emboss = 'NONE'
 126
 127         layout.prop(landmark, "name", text="")
 128
 129         icon = (
 130             'RADIOBUT_ON' if (index == landmark_active_idx) else 'RADIOBUT_OFF'
 131         )
 132         props = layout.operator(
 133             "view3d.vr_landmark_activate", text="", icon=icon)
 134         props.index = index
 135
 136
 137 class VIEW3D_PT_vr_landmarks(Panel):
 138     bl_space_type = 'VIEW_3D'
 139     bl_region_type = 'UI'
 140     bl_category = "VR"
 141     bl_label = "Landmarks"
 142     bl_options = {'DEFAULT_CLOSED'}
 143
 144     def draw(self, context):
 145         layout = self.layout
 146         scene = context.scene
 147         landmark_selected = properties.VRLandmark.get_selected_landmark(context)
 148
 149         layout.use_property_split = True
 150         layout.use_property_decorate = False  # No animation.
 151
 152         row = layout.row()
 153
 154         row.template_list("VIEW3D_UL_vr_landmarks", "", scene, "vr_landmarks",
 155                           scene, "vr_landmarks_selected", rows=3)
 156
 157         col = row.column(align=True)
 158         col.operator("view3d.vr_landmark_add", icon='ADD', text="")
 159         col.operator("view3d.vr_landmark_remove", icon='REMOVE', text="")
 160         col.operator("view3d.vr_landmark_from_session", icon='PLUS', text="")
 161
 162         col.menu("VIEW3D_MT_vr_landmark_menu", icon='DOWNARROW_HLT', text="")
 163
 164         if landmark_selected:
 165             layout.prop(landmark_selected, "type")
 166
 167             if landmark_selected.type == 'OBJECT':
 168                 layout.prop(landmark_selected, "base_pose_object")
 169                 layout.prop(landmark_selected, "base_scale", text="Scale")
 170             elif landmark_selected.type == 'CUSTOM':
 171                 layout.prop(landmark_selected,
 172                             "base_pose_location", text="Location")
 173                 layout.prop(landmark_selected,
 174                             "base_pose_angle", text="Angle")
 175                 layout.prop(landmark_selected,
 176                             "base_scale", text="Scale")
 177
 178
 179 ### Actions.
 180 class VIEW3D_PT_vr_actionmaps(Panel):
 181     bl_space_type = 'VIEW_3D'
 182     bl_region_type = 'UI'
 183     bl_category = "VR"
 184     bl_label = "Action Maps"
 185     bl_options = {'DEFAULT_CLOSED'}
 186
 187     def draw(self, context):
 188         layout = self.layout
 189         scene = context.scene
 190
 191         layout.use_property_split = True
 192         layout.use_property_decorate = False  # No animation.
 193
 194         col = layout.column(align=True)
 195         col.prop(scene, "vr_actions_use_gamepad", text="Gamepad")
 196
 197         col = layout.column(align=True, heading="Extensions")
 198         col.prop(scene, "vr_actions_enable_reverb_g2", text="HP Reverb G2")
 199         col.prop(scene, "vr_actions_enable_vive_cosmos", text="HTC Vive Cosmos")
 200         col.prop(scene, "vr_actions_enable_vive_focus", text="HTC Vive Focus")
 201         col.prop(scene, "vr_actions_enable_huawei", text="Huawei")
 202
 203
 204 ### Viewport feedback.
 205 class VIEW3D_PT_vr_viewport_feedback(Panel):
 206     bl_space_type = 'VIEW_3D'
 207     bl_region_type = 'UI'
 208     bl_category = "VR"
 209     bl_label = "Viewport Feedback"
 210     bl_options = {'DEFAULT_CLOSED'}
 211
 212     def draw(self, context):
 213         layout = self.layout
 214         scene = context.scene
 215         view3d = context.space_data
 216         session_settings = context.window_manager.xr_session_settings
 217
 218         col = layout.column(align=True)
 219         col.label(icon='ERROR', text="Note:")
 220         col.label(text="Settings here may have a significant")
 221         col.label(text="performance impact!")
 222
 223         layout.separator()
 224
 225         layout.prop(view3d.shading, "vr_show_virtual_camera")
 226         layout.prop(view3d.shading, "vr_show_controllers")
 227         layout.prop(view3d.shading, "vr_show_landmarks")
 228         layout.prop(view3d, "mirror_xr_session")
 229
 230
 231 ### Info.
 232 class VIEW3D_PT_vr_info(bpy.types.Panel):
 233     bl_space_type = 'VIEW_3D'
 234     bl_region_type = 'UI'
 235     bl_category = "VR"
 236     bl_label = "VR Info"
 237
 238     @classmethod
 239     def poll(cls, context):
 240         return not bpy.app.build_options.xr_openxr
 241
 242     def draw(self, context):
 243         layout = self.layout
 244         layout.label(icon='ERROR', text="Built without VR/OpenXR features")
 245
 246
 247 classes = (
 248     VIEW3D_PT_vr_session,
 249     VIEW3D_PT_vr_session_view,
 250     VIEW3D_PT_vr_session_view_object_type_visibility,
 251     VIEW3D_PT_vr_landmarks,
 252     VIEW3D_PT_vr_actionmaps,
 253     VIEW3D_PT_vr_viewport_feedback,
 254
 255     VIEW3D_UL_vr_landmarks,
 256     VIEW3D_MT_vr_landmark_menu,
 257 )
 258
 259
 260 def register():
 261     for cls in classes:
 262         bpy.utils.register_class(cls)
 263
 264     # View3DShading is the only per 3D-View struct with custom property
 265     # support, so "abusing" that to get a per 3D-View option.
 266     bpy.types.View3DShading.vr_show_virtual_camera = bpy.props.BoolProperty(
 267         name="Show VR Camera"
 268     )
 269     bpy.types.View3DShading.vr_show_controllers = bpy.props.BoolProperty(
 270         name="Show VR Controllers"
 271     )
 272     bpy.types.View3DShading.vr_show_landmarks = bpy.props.BoolProperty(
 273         name="Show Landmarks"
 274     )
 275
 276
 277 def unregister():
 278     for cls in classes:
 279         bpy.utils.unregister_class(cls)
 280
 281     del bpy.types.View3DShading.vr_show_virtual_camera
 282     del bpy.types.View3DShading.vr_show_controllers
 283     del bpy.types.View3DShading.vr_show_landmarks