Skip to content
Snippets Groups Projects
operators.py 15.7 KiB
Newer Older
  • Learn to ignore specific revisions
  • 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
    # ##### BEGIN GPL LICENSE BLOCK #####
    #
    #  This program is free software; you can redistribute it and/or
    #  modify it under the terms of the GNU General Public License
    #  as published by the Free Software Foundation; either version 2
    #  of the License, or (at your option) any later version.
    #
    #  This program is distributed in the hope that it will be useful,
    #  but WITHOUT ANY WARRANTY; without even the implied warranty of
    #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    #  GNU General Public License for more details.
    #
    #  You should have received a copy of the GNU General Public License
    #  along with this program; if not, write to the Free Software Foundation,
    #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
    #
    # ##### END GPL LICENSE BLOCK #####
    
    # <pep8 compliant>
    
    if "bpy" in locals():
        import importlib
        importlib.reload(properties)
    else:
        from . import properties
    
    import bpy
    from bpy.types import (
        Gizmo,
        GizmoGroup,
        Operator,
    )
    import bgl
    import math
    from math import radians
    from mathutils import Euler, Matrix, Quaternion, Vector
    
    
    ### Landmarks.
    class VIEW3D_OT_vr_landmark_add(Operator):
        bl_idname = "view3d.vr_landmark_add"
        bl_label = "Add VR Landmark"
        bl_description = "Add a new VR landmark to the list and select it"
        bl_options = {'UNDO', 'REGISTER'}
    
        def execute(self, context):
            scene = context.scene
            landmarks = scene.vr_landmarks
    
            landmarks.add()
    
            # select newly created set
            scene.vr_landmarks_selected = len(landmarks) - 1
    
            return {'FINISHED'}
    
    
    class VIEW3D_OT_vr_landmark_from_camera(Operator):
        bl_idname = "view3d.vr_landmark_from_camera"
        bl_label = "Add VR Landmark from Camera"
        bl_description = "Add a new VR landmark from the active camera object to the list and select it"
        bl_options = {'UNDO', 'REGISTER'}
    
        @classmethod
        def poll(cls, context):
            cam_selected = False
    
            vl_objects = bpy.context.view_layer.objects
            if vl_objects.active and vl_objects.active.type == 'CAMERA':
                cam_selected = True
            return cam_selected
    
        def execute(self, context):
            scene = context.scene
            landmarks = scene.vr_landmarks
            cam = context.view_layer.objects.active
            lm = landmarks.add()
            lm.type = 'OBJECT'
            lm.base_pose_object = cam
            lm.name = "LM_" + cam.name
    
            # select newly created set
            scene.vr_landmarks_selected = len(landmarks) - 1
    
            return {'FINISHED'}
    
    
    class VIEW3D_OT_vr_landmark_from_session(Operator):
        bl_idname = "view3d.vr_landmark_from_session"
        bl_label = "Add VR Landmark from Session"
        bl_description = "Add VR landmark from the viewer pose of the running VR session to the list and select it"
        bl_options = {'UNDO', 'REGISTER'}
    
        @classmethod
        def poll(cls, context):
            return bpy.types.XrSessionState.is_running(context)
    
        def execute(self, context):
            scene = context.scene
            landmarks = scene.vr_landmarks
            wm = context.window_manager
    
            lm = landmarks.add()
            lm.type = "CUSTOM"
            scene.vr_landmarks_selected = len(landmarks) - 1
    
            loc = wm.xr_session_state.viewer_pose_location
            rot = wm.xr_session_state.viewer_pose_rotation.to_euler()
    
            lm.base_pose_location = loc
            lm.base_pose_angle = rot[2]
    
            return {'FINISHED'}
    
    
    class VIEW3D_OT_update_vr_landmark(Operator):
        bl_idname = "view3d.update_vr_landmark"
        bl_label = "Update Custom VR Landmark"
        bl_description = "Update the selected landmark from the current viewer pose in the VR session"
        bl_options = {'UNDO', 'REGISTER'}
    
        @classmethod
        def poll(cls, context):
            selected_landmark = properties.VRLandmark.get_selected_landmark(context)
            return bpy.types.XrSessionState.is_running(context) and selected_landmark.type == 'CUSTOM'
    
        def execute(self, context):
            wm = context.window_manager
    
            lm = properties.VRLandmark.get_selected_landmark(context)
    
            loc = wm.xr_session_state.viewer_pose_location
            rot = wm.xr_session_state.viewer_pose_rotation.to_euler()
    
            lm.base_pose_location = loc
            lm.base_pose_angle = rot
    
            # Re-activate the landmark to trigger viewer reset and flush landmark settings to the session settings.
            properties.vr_landmark_active_update(None, context)
    
            return {'FINISHED'}
    
    
    class VIEW3D_OT_vr_landmark_remove(Operator):
        bl_idname = "view3d.vr_landmark_remove"
        bl_label = "Remove VR Landmark"
        bl_description = "Delete the selected VR landmark from the list"
        bl_options = {'UNDO', 'REGISTER'}
    
        def execute(self, context):
            scene = context.scene
            landmarks = scene.vr_landmarks
    
            if len(landmarks) > 1:
                landmark_selected_idx = scene.vr_landmarks_selected
                landmarks.remove(landmark_selected_idx)
    
                scene.vr_landmarks_selected -= 1
    
            return {'FINISHED'}
    
    
    class VIEW3D_OT_cursor_to_vr_landmark(Operator):
        bl_idname = "view3d.cursor_to_vr_landmark"
        bl_label = "Cursor to VR Landmark"
        bl_description = "Move the 3D Cursor to the selected VR Landmark"
        bl_options = {'UNDO', 'REGISTER'}
    
        @classmethod
        def poll(cls, context):
            lm = properties.VRLandmark.get_selected_landmark(context)
            if lm.type == 'SCENE_CAMERA':
                return context.scene.camera is not None
            elif lm.type == 'OBJECT':
                return lm.base_pose_object is not None
    
            return True
    
        def execute(self, context):
            scene = context.scene
            lm = properties.VRLandmark.get_selected_landmark(context)
            if lm.type == 'SCENE_CAMERA':
                lm_pos = scene.camera.location
            elif lm.type == 'OBJECT':
                lm_pos = lm.base_pose_object.location
            else:
                lm_pos = lm.base_pose_location
            scene.cursor.location = lm_pos
    
            return{'FINISHED'}
    
    
    class VIEW3D_OT_add_camera_from_vr_landmark(Operator):
        bl_idname = "view3d.add_camera_from_vr_landmark"
        bl_label = "New Camera from VR Landmark"
        bl_description = "Create a new Camera from the selected VR Landmark"
        bl_options = {'UNDO', 'REGISTER'}
    
        def execute(self, context):
            scene = context.scene
            lm = properties.VRLandmark.get_selected_landmark(context)
    
            cam = bpy.data.cameras.new("Camera_" + lm.name)
            new_cam = bpy.data.objects.new("Camera_" + lm.name, cam)
            scene.collection.objects.link(new_cam)
            angle = lm.base_pose_angle
            new_cam.location = lm.base_pose_location
            new_cam.rotation_euler = (math.pi, 0, angle)
    
            return {'FINISHED'}
    
    
    class VIEW3D_OT_camera_to_vr_landmark(Operator):
        bl_idname = "view3d.camera_to_vr_landmark"
        bl_label = "Scene Camera to VR Landmark"
        bl_description = "Position the scene camera at the selected landmark"
        bl_options = {'UNDO', 'REGISTER'}
    
        @classmethod
        def poll(cls, context):
            return context.scene.camera is not None
    
        def execute(self, context):
            scene = context.scene
            lm = properties.VRLandmark.get_selected_landmark(context)
    
            cam = scene.camera
            angle = lm.base_pose_angle
            cam.location = lm.base_pose_location
            cam.rotation_euler = (math.pi / 2, 0, angle)
    
            return {'FINISHED'}
    
    
    class VIEW3D_OT_vr_landmark_activate(Operator):
        bl_idname = "view3d.vr_landmark_activate"
        bl_label = "Activate VR Landmark"
        bl_description = "Change to the selected VR landmark from the list"
        bl_options = {'UNDO', 'REGISTER'}
    
        index: bpy.props.IntProperty(
            name="Index",
            options={'HIDDEN'},
        )
    
        def execute(self, context):
            scene = context.scene
    
            if self.index >= len(scene.vr_landmarks):
                return {'CANCELLED'}
    
            scene.vr_landmarks_active = (
                self.index if self.properties.is_property_set(
                    "index") else scene.vr_landmarks_selected
            )
    
            return {'FINISHED'}
    
    
    ### Gizmos.
    class VIEW3D_GT_vr_camera_cone(Gizmo):
        bl_idname = "VIEW_3D_GT_vr_camera_cone"
    
        aspect = 1.0, 1.0
    
        def draw(self, context):
            if not hasattr(self, "frame_shape"):
                aspect = self.aspect
    
                frame_shape_verts = (
                    (-aspect[0], -aspect[1], -1.0),
                    (aspect[0], -aspect[1], -1.0),
                    (aspect[0], aspect[1], -1.0),
                    (-aspect[0], aspect[1], -1.0),
                )
                lines_shape_verts = (
                    (0.0, 0.0, 0.0),
                    frame_shape_verts[0],
                    (0.0, 0.0, 0.0),
                    frame_shape_verts[1],
                    (0.0, 0.0, 0.0),
                    frame_shape_verts[2],
                    (0.0, 0.0, 0.0),
                    frame_shape_verts[3],
                )
    
                self.frame_shape = self.new_custom_shape(
                    'LINE_LOOP', frame_shape_verts)
                self.lines_shape = self.new_custom_shape(
                    'LINES', lines_shape_verts)
    
            # Ensure correct GL state (otherwise other gizmos might mess that up)
            bgl.glLineWidth(1)
            bgl.glEnable(bgl.GL_BLEND)
    
            self.draw_custom_shape(self.frame_shape)
            self.draw_custom_shape(self.lines_shape)
    
    
    class VIEW3D_GT_vr_controller_grip(Gizmo):
        bl_idname = "VIEW_3D_GT_vr_controller_grip"
    
        def draw(self, context):
            bgl.glLineWidth(1)
            bgl.glEnable(bgl.GL_BLEND)
    
            self.color = 0.422, 0.438, 0.446
            self.draw_preset_circle(self.matrix_basis, axis='POS_X')
            self.draw_preset_circle(self.matrix_basis, axis='POS_Y')
            self.draw_preset_circle(self.matrix_basis, axis='POS_Z')
    
    
    class VIEW3D_GT_vr_controller_aim(Gizmo):
        bl_idname = "VIEW_3D_GT_vr_controller_aim"
    
        def draw(self, context):
            bgl.glLineWidth(1)
            bgl.glEnable(bgl.GL_BLEND)
            
            self.color = 1.0, 0.2, 0.322
            self.draw_preset_arrow(self.matrix_basis, axis='POS_X')
            self.color = 0.545, 0.863, 0.0
            self.draw_preset_arrow(self.matrix_basis, axis='POS_Y')
            self.color = 0.157, 0.565, 1.0
            self.draw_preset_arrow(self.matrix_basis, axis='POS_Z')
    
    
    class VIEW3D_GGT_vr_viewer_pose(GizmoGroup):
        bl_idname = "VIEW3D_GGT_vr_viewer_pose"
        bl_label = "VR Viewer Pose Indicator"
        bl_space_type = 'VIEW_3D'
        bl_region_type = 'WINDOW'
        bl_options = {'3D', 'PERSISTENT', 'SCALE', 'VR_REDRAWS'}
    
        @classmethod
        def poll(cls, context):
            view3d = context.space_data
            return (
                view3d.shading.vr_show_virtual_camera and
                bpy.types.XrSessionState.is_running(context) and
                not view3d.mirror_xr_session
            )
    
        @staticmethod
        def _get_viewer_pose_matrix(context):
            wm = context.window_manager
    
            loc = wm.xr_session_state.viewer_pose_location
            rot = wm.xr_session_state.viewer_pose_rotation
    
            rotmat = Matrix.Identity(3)
            rotmat.rotate(rot)
            rotmat.resize_4x4()
            transmat = Matrix.Translation(loc)
    
            return transmat @ rotmat
    
        def setup(self, context):
            gizmo = self.gizmos.new(VIEW3D_GT_vr_camera_cone.bl_idname)
            gizmo.aspect = 1 / 3, 1 / 4
    
            gizmo.color = gizmo.color_highlight = 0.2, 0.6, 1.0
            gizmo.alpha = 1.0
    
            self.gizmo = gizmo
    
        def draw_prepare(self, context):
            self.gizmo.matrix_basis = self._get_viewer_pose_matrix(context)
    
    
    class VIEW3D_GGT_vr_controller_poses(GizmoGroup):
        bl_idname = "VIEW3D_GGT_vr_controller_poses"
        bl_label = "VR Controller Poses Indicator"
        bl_space_type = 'VIEW_3D'
        bl_region_type = 'WINDOW'
        bl_options = {'3D', 'PERSISTENT', 'SCALE', 'VR_REDRAWS'}
    
        @classmethod
        def poll(cls, context):
            view3d = context.space_data
            return (
                view3d.shading.vr_show_controllers and
                bpy.types.XrSessionState.is_running(context) and
                not view3d.mirror_xr_session
            )
    
        @staticmethod
        def _get_controller_pose_matrix(context, idx, is_grip, scale):
            wm = context.window_manager
    
            loc = None
            rot = None
            if is_grip:
                loc = wm.xr_session_state.controller_grip_location_get(context, idx)
                rot = wm.xr_session_state.controller_grip_rotation_get(context, idx)
            else:
                loc = wm.xr_session_state.controller_aim_location_get(context, idx)
                rot = wm.xr_session_state.controller_aim_rotation_get(context, idx)
    
            rotmat = Matrix.Identity(3)
            rotmat.rotate(Quaternion(Vector(rot)))
            rotmat.resize_4x4()
            transmat = Matrix.Translation(loc)
            scalemat = Matrix.Scale(scale, 4)
    
            return transmat @ rotmat @ scalemat
    
        def setup(self, context):
            for idx in range(2):
                self.gizmos.new(VIEW3D_GT_vr_controller_grip.bl_idname)
                self.gizmos.new(VIEW3D_GT_vr_controller_aim.bl_idname)
    
            for gizmo in self.gizmos:
                gizmo.aspect = 1 / 3, 1 / 4
                gizmo.color_highlight = 1.0, 1.0, 1.0
                gizmo.alpha = 1.0
                
        def draw_prepare(self, context):
            grip_idx = 0
            aim_idx = 0
            idx = 0
            scale = 1.0
            for gizmo in self.gizmos:
                is_grip = (gizmo.bl_idname == VIEW3D_GT_vr_controller_grip.bl_idname)
                if (is_grip):
                    idx = grip_idx
                    grip_idx += 1
                    scale = 0.1
                else:
                    idx = aim_idx
                    aim_idx += 1
                    scale = 0.5
                gizmo.matrix_basis = self._get_controller_pose_matrix(context, idx, is_grip, scale)
    
    
    class VIEW3D_GGT_vr_landmarks(GizmoGroup):
        bl_idname = "VIEW3D_GGT_vr_landmarks"
        bl_label = "VR Landmark Indicators"
        bl_space_type = 'VIEW_3D'
        bl_region_type = 'WINDOW'
        bl_options = {'3D', 'PERSISTENT', 'SCALE'}
    
        @classmethod
        def poll(cls, context):
            view3d = context.space_data
            return (
                view3d.shading.vr_show_landmarks
            )
    
        def setup(self, context):
            pass
    
        def draw_prepare(self, context):
            # first delete the old gizmos
            for g in self.gizmos:
                self.gizmos.remove(g)
    
            scene = context.scene
            landmarks = scene.vr_landmarks
    
            for lm in landmarks:
                if ((lm.type == 'SCENE_CAMERA' and not scene.camera) or
                        (lm.type == 'OBJECT' and not lm.base_pose_object)):
                    continue
    
                gizmo = self.gizmos.new(VIEW3D_GT_vr_camera_cone.bl_idname)
                gizmo.aspect = 1 / 3, 1 / 4
    
                gizmo.color = gizmo.color_highlight = 0.2, 1.0, 0.6
                gizmo.alpha = 1.0
    
                self.gizmo = gizmo
    
                if lm.type == 'SCENE_CAMERA':
                    cam = scene.camera
                    lm_mat = cam.matrix_world if cam else Matrix.Identity(4)
                elif lm.type == 'OBJECT':
                    lm_mat = lm.base_pose_object.matrix_world
                else:
                    angle = lm.base_pose_angle
                    raw_rot = Euler((radians(90.0), 0, angle))
    
                    rotmat = Matrix.Identity(3)
                    rotmat.rotate(raw_rot)
                    rotmat.resize_4x4()
    
                    transmat = Matrix.Translation(lm.base_pose_location)
    
                    lm_mat = transmat @ rotmat
    
                self.gizmo.matrix_basis = lm_mat
    
    
    classes = (
        VIEW3D_OT_vr_landmark_add,
        VIEW3D_OT_vr_landmark_remove,
        VIEW3D_OT_vr_landmark_activate,
        VIEW3D_OT_vr_landmark_from_session,
        VIEW3D_OT_add_camera_from_vr_landmark,
        VIEW3D_OT_camera_to_vr_landmark,
        VIEW3D_OT_vr_landmark_from_camera,
        VIEW3D_OT_cursor_to_vr_landmark,
        VIEW3D_OT_update_vr_landmark,
    
        VIEW3D_GT_vr_camera_cone,
        VIEW3D_GT_vr_controller_grip,
        VIEW3D_GT_vr_controller_aim,
        VIEW3D_GGT_vr_viewer_pose,
        VIEW3D_GGT_vr_controller_poses,
        VIEW3D_GGT_vr_landmarks,
    )
    
    
    def register():
        for cls in classes:
            bpy.utils.register_class(cls)
    
    
    def unregister():
        for cls in classes:
            bpy.utils.unregister_class(cls)