viewport_vr_preview/properties.py

   1 # SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 import bpy
   4 from bpy.types import (
   5     PropertyGroup,
   6 )
   7 from bpy.app.handlers import persistent
   8
   9
  10 ### Landmarks.
  11 @persistent
  12 def vr_ensure_default_landmark(context: bpy.context):
  13     # Ensure there's a default landmark (scene camera by default).
  14     landmarks = bpy.context.scene.vr_landmarks
  15     if not landmarks:
  16         landmarks.add()
  17         landmarks[0].type = 'SCENE_CAMERA'
  18
  19
  20 def vr_landmark_active_type_update(self, context):
  21     wm = context.window_manager
  22     session_settings = wm.xr_session_settings
  23     landmark_active = VRLandmark.get_active_landmark(context)
  24
  25     # Update session's base pose type to the matching type.
  26     if landmark_active.type == 'SCENE_CAMERA':
  27         session_settings.base_pose_type = 'SCENE_CAMERA'
  28     elif landmark_active.type == 'OBJECT':
  29         session_settings.base_pose_type = 'OBJECT'
  30     elif landmark_active.type == 'CUSTOM':
  31         session_settings.base_pose_type = 'CUSTOM'
  32
  33
  34 def vr_landmark_active_base_pose_object_update(self, context):
  35     session_settings = context.window_manager.xr_session_settings
  36     landmark_active = VRLandmark.get_active_landmark(context)
  37
  38     # Update the anchor object to the (new) camera of this landmark.
  39     session_settings.base_pose_object = landmark_active.base_pose_object
  40
  41
  42 def vr_landmark_active_base_pose_location_update(self, context):
  43     session_settings = context.window_manager.xr_session_settings
  44     landmark_active = VRLandmark.get_active_landmark(context)
  45
  46     session_settings.base_pose_location = landmark_active.base_pose_location
  47
  48
  49 def vr_landmark_active_base_pose_angle_update(self, context):
  50     session_settings = context.window_manager.xr_session_settings
  51     landmark_active = VRLandmark.get_active_landmark(context)
  52
  53     session_settings.base_pose_angle = landmark_active.base_pose_angle
  54
  55
  56 def vr_landmark_active_base_scale_update(self, context):
  57     session_settings = context.window_manager.xr_session_settings
  58     landmark_active = VRLandmark.get_active_landmark(context)
  59
  60     session_settings.base_scale = landmark_active.base_scale
  61
  62
  63 def vr_landmark_type_update(self, context):
  64     landmark_selected = VRLandmark.get_selected_landmark(context)
  65     landmark_active = VRLandmark.get_active_landmark(context)
  66
  67     # Don't allow non-trivial base scale for scene camera landmarks.
  68     if landmark_selected.type == 'SCENE_CAMERA':
  69         landmark_selected.base_scale = 1.0
  70
  71     # Only update session settings data if the changed landmark is actually
  72     # the active one.
  73     if landmark_active == landmark_selected:
  74         vr_landmark_active_type_update(self, context)
  75
  76
  77 def vr_landmark_base_pose_object_update(self, context):
  78     landmark_selected = VRLandmark.get_selected_landmark(context)
  79     landmark_active = VRLandmark.get_active_landmark(context)
  80
  81     # Only update session settings data if the changed landmark is actually
  82     # the active one.
  83     if landmark_active == landmark_selected:
  84         vr_landmark_active_base_pose_object_update(self, context)
  85
  86
  87 def vr_landmark_base_pose_location_update(self, context):
  88     landmark_selected = VRLandmark.get_selected_landmark(context)
  89     landmark_active = VRLandmark.get_active_landmark(context)
  90
  91     # Only update session settings data if the changed landmark is actually
  92     # the active one.
  93     if landmark_active == landmark_selected:
  94         vr_landmark_active_base_pose_location_update(self, context)
  95
  96
  97 def vr_landmark_base_pose_angle_update(self, context):
  98     landmark_selected = VRLandmark.get_selected_landmark(context)
  99     landmark_active = VRLandmark.get_active_landmark(context)
 100
 101     # Only update session settings data if the changed landmark is actually
 102     # the active one.
 103     if landmark_active == landmark_selected:
 104         vr_landmark_active_base_pose_angle_update(self, context)
 105
 106
 107 def vr_landmark_base_scale_update(self, context):
 108     landmark_selected = VRLandmark.get_selected_landmark(context)
 109     landmark_active = VRLandmark.get_active_landmark(context)
 110
 111     # Only update session settings data if the changed landmark is actually
 112     # the active one.
 113     if landmark_active == landmark_selected:
 114         vr_landmark_active_base_scale_update(self, context)
 115
 116
 117 def vr_landmark_active_update(self, context):
 118     wm = context.window_manager
 119
 120     vr_landmark_active_type_update(self, context)
 121     vr_landmark_active_base_pose_object_update(self, context)
 122     vr_landmark_active_base_pose_location_update(self, context)
 123     vr_landmark_active_base_pose_angle_update(self, context)
 124     vr_landmark_active_base_scale_update(self, context)
 125
 126     if wm.xr_session_state:
 127         wm.xr_session_state.reset_to_base_pose(context)
 128
 129
 130 class VRLandmark(PropertyGroup):
 131     name: bpy.props.StringProperty(
 132         name="VR Landmark",
 133         default="Landmark"
 134     )
 135     type: bpy.props.EnumProperty(
 136         name="Type",
 137         items=[
 138             ('SCENE_CAMERA', "Scene Camera",
 139              "Use scene's currently active camera to define the VR view base "
 140              "location and rotation"),
 141             ('OBJECT', "Custom Object",
 142              "Use an existing object to define the VR view base location and "
 143              "rotation"),
 144             ('CUSTOM', "Custom Pose",
 145              "Allow a manually defined position and rotation to be used as "
 146              "the VR view base pose"),
 147         ],
 148         default='SCENE_CAMERA',
 149         update=vr_landmark_type_update,
 150     )
 151     base_pose_object: bpy.props.PointerProperty(
 152         name="Object",
 153         type=bpy.types.Object,
 154         update=vr_landmark_base_pose_object_update,
 155     )
 156     base_pose_location: bpy.props.FloatVectorProperty(
 157         name="Base Pose Location",
 158         subtype='TRANSLATION',
 159         update=vr_landmark_base_pose_location_update,
 160     )
 161     base_pose_angle: bpy.props.FloatProperty(
 162         name="Base Pose Angle",
 163         subtype='ANGLE',
 164         update=vr_landmark_base_pose_angle_update,
 165     )
 166     base_scale: bpy.props.FloatProperty(
 167         name="Base Scale",
 168         description="Viewer reference scale associated with this landmark",
 169         default=1.0,
 170         min=0.000001,
 171         update=vr_landmark_base_scale_update,
 172     )
 173
 174     @staticmethod
 175     def get_selected_landmark(context):
 176         scene = context.scene
 177         landmarks = scene.vr_landmarks
 178
 179         return (
 180             None if (len(landmarks) <
 181                      1) else landmarks[scene.vr_landmarks_selected]
 182         )
 183
 184     @staticmethod
 185     def get_active_landmark(context):
 186         scene = context.scene
 187         landmarks = scene.vr_landmarks
 188
 189         return (
 190             None if (len(landmarks) <
 191                      1) else landmarks[scene.vr_landmarks_active]
 192         )
 193
 194
 195 classes = (
 196     VRLandmark,
 197 )
 198
 199
 200 def register():
 201     for cls in classes:
 202         bpy.utils.register_class(cls)
 203
 204     bpy.types.Scene.vr_landmarks = bpy.props.CollectionProperty(
 205         name="Landmark",
 206         type=VRLandmark,
 207     )
 208     bpy.types.Scene.vr_landmarks_selected = bpy.props.IntProperty(
 209         name="Selected Landmark"
 210     )
 211     bpy.types.Scene.vr_landmarks_active = bpy.props.IntProperty(
 212         update=vr_landmark_active_update,
 213     )
 214
 215     bpy.app.handlers.load_post.append(vr_ensure_default_landmark)
 216
 217
 218 def unregister():
 219     for cls in classes:
 220         bpy.utils.unregister_class(cls)
 221
 222     del bpy.types.Scene.vr_landmarks
 223     del bpy.types.Scene.vr_landmarks_selected
 224     del bpy.types.Scene.vr_landmarks_active
 225
 226     bpy.app.handlers.load_post.remove(vr_ensure_default_landmark)