real_pose_copy.py

"""
Real pose copy addon.

Encodes the matrices of the selected bones in JSON, and places that on the
clipboard. This can be pasted as text into a text file, or, using this same
addon, pasted onto another rig in another Blend file. Bones are mapepd
by name.
"""

bl_info = {
    'name': 'Real pose copy',
    'author': 'Sybren A. Stüvel',
    'version': (1, 1),
    'blender': (2, 80, 0),
    'location': '3D View Numerical Panel > Pose Tools',
    'category': 'Animation',
}

from collections import defaultdict, deque
import json

import bpy
from mathutils import Matrix
from bpy.types import Menu, Panel, UIList


class POSE_OT_copy_as_json(bpy.types.Operator):
    bl_idname = 'pose.copy_as_json'
    bl_label = 'Copy pose as JSON'
    bl_description = 'Copies the matrices of the selected bones as JSON onto ' \
        'the clipboard'

    @classmethod
    def poll(cls, context):
        return context.mode == 'POSE' and context.selected_pose_bones

    def execute(self, context):
        context.scene.update()
        bone_data = defaultdict(dict)
        for bone in context.selected_pose_bones:
            # Convert matrix to list-of-tuples.
            vals = [tuple(v) for v in bone.matrix]
            bone_data[bone.name]['matrix'] = vals

        context.window_manager.clipboard = json.dumps(bone_data)
        self.report({'INFO'}, 'Selected pose bone matrices copied.')

        return {'FINISHED'}


class POSE_OT_paste_from_json(bpy.types.Operator):
    bl_idname = 'pose.paste_from_json'
    bl_label = 'Paste pose from JSON'
    bl_description = 'Copies the matrices of the selected bones as JSON onto the clipboard'

    @classmethod
    def poll(cls, context):
        return context.mode == 'POSE'

    def execute(self, context):
        # Parse the JSON
        the_json = context.window_manager.clipboard
        try:
            bone_data = json.loads(the_json)
        except ValueError as ex:
            self.report({'ERROR'}, 'No valid JSON on clipboard: %s' % ex)
            return {'CANCELLED'}

        # Iterate over bones hierarchically, updating parents before children.
        bones = deque(bone for bone in context.active_object.pose.bones
                      if not bone.parent)
        while bones:
            bone = bones.popleft()

            try:
                matrix_components = bone_data[bone.name]['matrix']
            except KeyError:
                pass  # This bone is not included in the pose JSON.
            else:
                bone.matrix = Matrix(matrix_components)
                context.scene.update()  # Required due to known issue in Blender.

            bones.extend(bone.children)

        self.report({'INFO'}, 'Pose bone matrices pasted.')
        return {'FINISHED'}


class VIEW3D_PT_pose_tools(Panel):
    bl_space_type = 'VIEW_3D'
    bl_region_type = 'UI'
    bl_category = "View"
    bl_label = "Copy Pose"

    def draw(self, context):
        layout = self.layout

        col = layout.column(align=True)
        col.operator("pose.copy_as_json", text="Copy as JSON")
        col.operator("pose.paste_from_json", text="Paste from JSON")


classes = (
    POSE_OT_copy_as_json,
    POSE_OT_paste_from_json,
    VIEW3D_PT_pose_tools,
)

register, unregister = bpy.utils.register_classes_factory(classes)