Skip to content
Snippets Groups Projects
animation_animall.py 19.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 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
    # ##### 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 #####
    
    bl_info = {
        "name": "AnimAll",
        "author": "Daniel Salazar <zanqdo@gmail.com>",
        "version": (0, 8, 2),
        "blender": (2, 80, 0),
        "location": "3D View > Toolbox > Animation tab > AnimAll",
        "description": "Allows animation of mesh, lattice, curve and surface data",
        "warning": "",
        "wiki_url": "https://wiki.blender.org/index.php/Extensions:2.6/Py/"
                    "Scripts/Animation/AnimAll",
        "category": "Animation",
    }
    
    """
    Thanks to Campbell Barton and Joshua Leung for hes API additions and fixes
    Daniel 'ZanQdo' Salazar
    """
    
    import bpy
    from bpy.types import (
            Operator,
            Panel,
            AddonPreferences,
            )
    from bpy.props import (
            BoolProperty,
            StringProperty,
            )
    
    
    # Property Definitions
    class AnimallProperties(bpy.types.PropertyGroup):
        key_selected: BoolProperty(
            name="Selected Only",
            description="Insert keyframes only on selected elements",
            default=True
        )
        key_shape: BoolProperty(
            name="Shape",
            description="Insert keyframes on active Shape Key layer",
            default=False
        )
        key_uvs: BoolProperty(
            name="UVs",
            description="Insert keyframes on active UV coordinates",
            default=False
        )
        key_ebevel: BoolProperty(
            name="E-Bevel",
            description="Insert keyframes on edge bevel weight",
            default=False
        )
        key_vbevel: BoolProperty(
            name="V-Bevel",
            description="Insert keyframes on vertex bevel weight",
            default=False
        )
        key_crease: BoolProperty(
            name="Crease",
            description="Insert keyframes on edge creases",
            default=False
        )
        key_vcols: BoolProperty(
            name="V-Cols",
            description="Insert keyframes on active Vertex Color values",
            default=False
        )
        key_vgroups: BoolProperty(
            name="V-groups",
            description="Insert keyframes on active Vertex group values",
            default=False
        )
        key_points: BoolProperty(
            name="Points",
            description="Insert keyframes on point locations",
            default=False
        )
        key_radius: BoolProperty(
            name="Radius",
            description="Insert keyframes on point radius (Shrink/Fatten)",
            default=False
        )
        key_tilt: BoolProperty(
            name="Tilt",
            description="Insert keyframes on point tilt",
            default=False
        )
    
    
    # Utility functions
    
    def refresh_ui_keyframes():
        try:
            for area in bpy.context.screen.areas:
                if area.type in ('TIMELINE', 'GRAPH_EDITOR', 'DOPESHEET_EDITOR'):
                    area.tag_redraw()
        except:
            pass
    
    
    def insert_key(data, key, group=''):
        try:
            data.keyframe_insert(key, group=group)
        except:
            pass
    
    
    def delete_key(data, key):
        try:
            data.keyframe_delete(key)
        except:
            pass
    
    
    # GUI (Panel)
    
    class VIEW3D_PT_animall(Panel):
        bl_space_type = 'VIEW_3D'
        bl_region_type = 'UI'
        bl_category = "Animation"
        bl_label = 'AnimAll'
    
        @classmethod
        def poll(self, context):
            return context.active_object and context.active_object.type in {'MESH', 'LATTICE', 'CURVE', 'SURFACE'}
    
        def draw(self, context):
            obj = context.active_object
            animall_properties = context.window_manager.animall_properties
    
            layout = self.layout
            col = layout.column(align=True)
            row = col.row()
            row.prop(animall_properties, "key_selected")
            col.separator()
    
            row = col.row()
    
            if obj.type == 'LATTICE':
                row.prop(animall_properties, "key_points")
                row.prop(animall_properties, "key_shape")
    
            elif obj.type == 'MESH':
                row.prop(animall_properties, "key_points")
                row.prop(animall_properties, "key_shape")
                row = col.row()
                row.prop(animall_properties, "key_ebevel")
                row.prop(animall_properties, "key_vbevel")
                row = col.row()
                row.prop(animall_properties, "key_crease")
                row.prop(animall_properties, "key_uvs")
                row = col.row()
                row.prop(animall_properties, "key_vcols")
                row.prop(animall_properties, "key_vgroups")
    
            elif obj.type == 'CURVE':
                row.prop(animall_properties, "key_points")
                row.prop(animall_properties, "key_shape")
                row = col.row()
                row.prop(animall_properties, "key_radius")
                row.prop(animall_properties, "key_tilt")
    
            elif obj.type == 'SURFACE':
                row.prop(animall_properties, "key_points")
                row.prop(animall_properties, "key_shape")
                row = col.row()
                row.prop(animall_properties, "key_radius")
                row.prop(animall_properties, "key_tilt")
    
            layout.separator()
            row = layout.row(align=True)
            row.operator("anim.insert_keyframe_animall", icon="KEY_HLT")
            row.operator("anim.delete_keyframe_animall", icon="KEY_DEHLT")
            row = layout.row()
            row.operator("anim.clear_animation_animall", icon="X")
    
            if animall_properties.key_shape:
                shape_key = obj.active_shape_key
                shape_key_index = obj.active_shape_key_index
    
                split = layout.split()
                row = split.row()
    
                if shape_key_index > 0:
                    row.label(text=shape_key.name, icon="SHAPEKEY_DATA")
                    row.prop(shape_key, "value", text="")
                    row.prop(obj, "show_only_shape_key", text="")
                    if shape_key.value < 1:
                        row = layout.row()
                        row.label(text='Maybe set "%s" to 1.0?' % shape_key.name, icon="INFO")
                elif shape_key:
                    row.label(text="Cannot key on Basis Shape", icon="ERROR")
                else:
                    row.label(text="No active Shape Key", icon="ERROR")
    
            if animall_properties.key_points and animall_properties.key_shape:
                row = layout.row()
                row.label(text='"Points" and "Shape" are redundant?', icon="INFO")
    
    
    class ANIM_OT_insert_keyframe_animall(Operator):
        bl_label = "Insert"
        bl_idname = "anim.insert_keyframe_animall"
        bl_description = "Insert a Keyframe"
        bl_options = {'REGISTER', 'UNDO'}
    
        def invoke(self, context, event):
            self.execute(context)
    
            return {'FINISHED'}
    
        def execute(op, context):
            obj = context.active_object
            animall_properties = context.window_manager.animall_properties
    
            # Maybe this should be done for all object types,
            # but keys can only be inserted in Edit Mode for CURVEs and SURFACEs,
            # and Object Mode for MESHes and LATTICEs.
            # Putting it inside if blocks for now
            # # Set object mode
            # if obj.type in {'MESH', 'LATTICE', 'CURVE', 'SURFACE'}:
            #     mode = obj.mode
            #     bpy.ops.object.mode_set(mode='OBJECT')
            #     data = obj.data
    
            if obj.type == 'MESH':
                mode = obj.mode
                bpy.ops.object.mode_set(mode='OBJECT')
                data = obj.data
    
                if animall_properties.key_points:
                    for v_i, vert in enumerate(data.vertices):
                        if not animall_properties.key_selected or vert.select:
                            insert_key(vert, 'co', group="vertex %s" % v_i)
    
                if animall_properties.key_vbevel:
                    for v_i, vert in enumerate(data.vertices):
                        if not animall_properties.key_selected or vert.select:
                            insert_key(vert, 'bevel_weight', group="vertex %s" % v_i)
    
                if animall_properties.key_vgroups:
                    for v_i, vert in enumerate(data.vertices):
                        if not animall_properties.key_selected or vert.select:
                            for group in vert.groups:
                                insert_key(group, 'weight', group="vertex %s" % v_i)
    
                if animall_properties.key_ebevel:
                    for e_i, edge in enumerate(data.edges):
                        if not animall_properties.key_selected or edge.select:
                            insert_key(edge, 'bevel_weight', group="edge %s" % e_i)
    
                if animall_properties.key_crease:
                    for e_i, edge in enumerate(data.edges):
                        if not animall_properties.key_selected or edge.select:
                            insert_key(edge, 'crease', group="edge %s" % e_i)
    
                if animall_properties.key_shape:
                    if obj.active_shape_key_index > 0:
                        for v_i, vert in enumerate(obj.active_shape_key.data):
                            insert_key(vert, 'co', group="vertex %s" % v_i)
    
                if animall_properties.key_uvs:
                    if data.uv_layers.active is not None:
                        for uv_i, uv in enumerate(data.uv_layers.active.data):
                            insert_key(uv, 'uv', group="UV layer %s" % uv_i)
    
                if animall_properties.key_vcols:
                    for v_col_layer in data.vertex_colors:
                        if v_col_layer.active:  # only insert in active VCol layer
                            for v_i, data in enumerate(v_col_layer.data):
                                insert_key(data, 'color', group="Loop %s" % v_i)
    
                bpy.ops.object.mode_set(mode=mode)
    
            elif obj.type == 'LATTICE':
                mode = obj.mode
                bpy.ops.object.mode_set(mode='OBJECT')
                data = obj.data
    
                if animall_properties.key_shape:
                    if obj.active_shape_key_index > 0:
                        for p_i, point in enumerate(obj.active_shape_key.data):
                            insert_key(point, 'co', group="Point %s" % p_i)
    
                if animall_properties.key_points:
                    for p_i, point in enumerate(data.points):
                        if not animall_properties.key_selected or point.select:
                            insert_key(point, 'co_deform', group="Point %s" % p_i)
    
                bpy.ops.object.mode_set(mode=mode)
    
            elif obj.type in {'CURVE', 'SURFACE'}:
                data = obj.data
    
                # run this outside the splines loop (only once)
                if animall_properties.key_shape:
                    if obj.active_shape_key_index > 0:
                        for CV in obj.active_shape_key.data:
                            insert_key(CV, 'co')
                            insert_key(CV, 'handle_left')
                            insert_key(CV, 'handle_right')
    
                for s_i, spline in enumerate(data.splines):
                    if spline.type == 'BEZIER':
                        for v_i, CV in enumerate(spline.bezier_points):
                            if (not animall_properties.key_selected
                                    or CV.select_control_point
                                    or CV.select_left_handle
                                    or CV.select_right_handle):
                                if animall_properties.key_points:
                                    insert_key(CV, 'co', group="spline %s CV %s" % (s_i, v_i))
                                    insert_key(CV, 'handle_left', group="spline %s CV %s" % (s_i, v_i))
                                    insert_key(CV, 'handle_right', group="spline %s CV %s" % (s_i, v_i))
    
                                if animall_properties.key_radius:
                                    insert_key(CV, 'radius', group="spline %s CV %s" % (s_i, v_i))
    
                                if animall_properties.key_tilt:
                                    insert_key(CV, 'tilt', group="spline %s CV %s" % (s_i, v_i))
    
                    elif spline.type in ('POLY', 'NURBS'):
                        for v_i, CV in enumerate(spline.points):
                            if not animall_properties.key_selected or CV.select:
                                if animall_properties.key_points:
                                    insert_key(CV, 'co', group="spline %s CV %s" % (s_i, v_i))
    
                                if animall_properties.key_radius:
                                    insert_key(CV, 'radius', group="spline %s CV %s" % (s_i, v_i))
    
                                if animall_properties.key_tilt:
                                    insert_key(CV, 'tilt', group="spline %s CV %s" % (s_i, v_i))
    
            # See previous remark
            # # Set previous mode
            # if obj.type in {'MESH', 'LATTICE', 'CURVE', 'SURFACE'}:
            #     bpy.ops.object.mode_set(mode=mode)
    
            refresh_ui_keyframes()
    
            return {'FINISHED'}
    
    
    class ANIM_OT_delete_keyframe_animall(Operator):
        bl_label = "Delete"
        bl_idname = "anim.delete_keyframe_animall"
        bl_description = "Delete a Keyframe"
        bl_options = {'REGISTER', 'UNDO'}
    
        def invoke(self, context, event):
            self.execute(context)
    
            return {'FINISHED'}
    
        def execute(op, context):
            obj = context.active_object
            animall_properties = context.window_manager.animall_properties
    
            # Set object mode
            if obj.type in {'MESH', 'LATTICE', 'CURVE', 'SURFACE'}:
                mode = obj.mode
                bpy.ops.object.mode_set(mode='OBJECT')
    
                data = obj.data
    
            if obj.type == 'MESH':
                if animall_properties.key_shape:
                    if obj.active_shape_key:
                        for vert in obj.active_shape_key.data:
                            delete_key(vert, 'co')
    
                if animall_properties.key_points:
                    for vert in data.vertices:
                        delete_key(vert, 'co')
    
                if animall_properties.key_ebevel:
                    for edge in data.edges:
                        delete_key(edge, 'bevel_weight')
    
                if animall_properties.key_vbevel:
                    for vert in data.vertices:
                        delete_key(vert, 'bevel_weight')
    
                if animall_properties.key_crease:
                    for edge in data.edges:
                        delete_key(edge, 'crease')
    
                if animall_properties.key_vgroups:
                    for vert in data.vertices:
                        for group in vert.groups:
                            delete_key(group, 'weight')
    
                if animall_properties.key_uvs:
                    for UV in data.uv_layers.active.data:
                        delete_key(UV, 'uv')
    
                if animall_properties.key_vcols:
                    for v_col_layer in data.vertex_colors:
                        if v_col_layer.active:  # only delete in active VCol layer
                            for data in v_col_layer.data:
                                delete_key(data, 'color')
    
            if obj.type == 'LATTICE':
                if animall_properties.key_shape:
                    if obj.active_shape_key:
                        for point in obj.active_shape_key.data:
                            delete_key(point, 'co')
    
                if animall_properties.key_points:
                    for point in data.points:
                        delete_key(Point, 'co_deform')
    
            if obj.type in {'CURVE', 'SURFACE'}:
                # run this outside the splines loop (only once)
                if animall_properties.key_shape:
                    if obj.active_shape_key_index > 0:
                        for CV in obj.active_shape_key.data:
                            delete_key(CV, 'co')
                            delete_key(CV, 'handle_left')
                            delete_key(CV, 'handle_right')
    
                for spline in data.splines:
                    if spline.type == 'BEZIER':
                        for CV in spline.bezier_points:
                            if animall_properties.key_points:
                                delete_key(CV, 'co')
                                delete_key(CV, 'handle_left')
                                delete_key(CV, 'handle_right')
                            if animall_properties.key_radius:
                                delete_key(CV, 'radius')
                            if animall_properties.key_tilt:
                                delete_key(CV, 'tilt')
    
                    elif spline.type == 'NURBS':
                        for CV in spline.points:
                            if animall_properties.key_points:
                                delete_key(CV, 'co')
                            if animall_properties.key_radius:
                                delete_key(CV, 'radius')
                            if animall_properties.key_tilt:
                                delete_key(CV, 'tilt')
    
            # Set previous mode
            if obj.type in {'MESH', 'LATTICE', 'CURVE', 'SURFACE'}:
                bpy.ops.object.mode_set(mode=mode)
    
            refresh_ui_keyframes()
    
            return {'FINISHED'}
    
    
    class ANIM_OT_clear_animation_animall(Operator):
        bl_label = "Clear Animation"
        bl_idname = "anim.clear_animation_animall"
        bl_description = ("Delete all keyframes for this object\n"
                          "If in a specific case it doesn't work\n"
                          "try to delete the keys manually")
        bl_options = {'REGISTER', 'UNDO'}
    
        def invoke(self, context, event):
            wm = context.window_manager
            return wm.invoke_confirm(self, event)
    
        def execute(self, context):
            try:
                data = context.active_object.data
                data.animation_data_clear()
            except:
                self.report({'WARNING'}, "Clear Animation could not be performed")
                return {'CANCELLED'}
    
            refresh_ui_keyframes()
    
            return {'FINISHED'}
    
    
    # Add-ons Preferences Update Panel
    
    # Define Panel classes for updating
    panels = [
            VIEW3D_PT_animall
            ]
    
    
    def update_panel(self, context):
        message = "AnimAll: Updating Panel locations has failed"
        try:
            for panel in panels:
                if "bl_rna" in panel.__dict__:
                    bpy.utils.unregister_class(panel)
    
            for panel in panels:
                panel.bl_category = context.preferences.addons[__name__].preferences.category
                bpy.utils.register_class(panel)
    
        except Exception as e:
            print("\n[{}]\n{}\n\nError:\n{}".format(__name__, message, e))
            pass
    
    
    class AnimallAddonPreferences(AddonPreferences):
        # this must match the addon name, use '__package__'
        # when defining this in a submodule of a python package.
        bl_idname = __name__
    
        category: StringProperty(
            name="Tab Category",
            description="Choose a name for the category of the panel",
            default="Animation",
            update=update_panel
        )
    
        def draw(self, context):
            layout = self.layout
            row = layout.row()
            col = row.column()
    
            col.label(text="Tab Category:")
            col.prop(self, "category", text="")
    
    
    def register():
        bpy.utils.register_class(AnimallProperties)
        bpy.types.WindowManager.animall_properties = bpy.props.PointerProperty(type=AnimallProperties)
        bpy.utils.register_class(VIEW3D_PT_animall)
        bpy.utils.register_class(ANIM_OT_insert_keyframe_animall)
        bpy.utils.register_class(ANIM_OT_delete_keyframe_animall)
        bpy.utils.register_class(ANIM_OT_clear_animation_animall)
        bpy.utils.register_class(AnimallAddonPreferences)
        update_panel(None, bpy.context)
    
    
    def unregister():
        del bpy.types.WindowManager.animall_properties
        bpy.utils.unregister_class(AnimallProperties)
        bpy.utils.unregister_class(VIEW3D_PT_animall)
        bpy.utils.unregister_class(ANIM_OT_insert_keyframe_animall)
        bpy.utils.unregister_class(ANIM_OT_delete_keyframe_animall)
        bpy.utils.unregister_class(ANIM_OT_clear_animation_animall)
        bpy.utils.unregister_class(AnimallAddonPreferences)
    
    if __name__ == "__main__":
        register()