io_anim_bvh/__init__.py

   1 # ##### BEGIN GPL LICENSE BLOCK #####
   2 #
   3 #  This program is free software; you can redistribute it and/or
   4 #  modify it under the terms of the GNU General Public License
   5 #  as published by the Free Software Foundation; either version 2
   6 #  of the License, or (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software Foundation,
  15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16 #
  17 # ##### END GPL LICENSE BLOCK #####
  18
  19 # <pep8-80 compliant>
  20
  21 bl_info = {
  22     "name": "BioVision Motion Capture (BVH) format",
  23     "author": "Campbell Barton",
  24     "version": (1, 0, 0),
  25     "blender": (2, 74, 0),
  26     "location": "File > Import-Export",
  27     "description": "Import-Export BVH from armature objects",
  28     "warning": "",
  29     "wiki_url": "http://wiki.blender.org/index.php/Extensions:2.6/Py/"
  30                 "Scripts/Import-Export/BVH_Importer_Exporter",
  31     "support": 'OFFICIAL',
  32     "category": "Import-Export"}
  33
  34 if "bpy" in locals():
  35     import importlib
  36     if "import_bvh" in locals():
  37         importlib.reload(import_bvh)
  38     if "export_bvh" in locals():
  39         importlib.reload(export_bvh)
  40
  41 import bpy
  42 from bpy.props import (
  43         StringProperty,
  44         FloatProperty,
  45         IntProperty,
  46         BoolProperty,
  47         EnumProperty,
  48         )
  49 from bpy_extras.io_utils import (
  50         ImportHelper,
  51         ExportHelper,
  52         orientation_helper,
  53         axis_conversion,
  54         )
  55
  56
  57 @orientation_helper(axis_forward='-Z', axis_up='Y')
  58 class ImportBVH(bpy.types.Operator, ImportHelper):
  59     """Load a BVH motion capture file"""
  60     bl_idname = "import_anim.bvh"
  61     bl_label = "Import BVH"
  62     bl_options = {'REGISTER', 'UNDO'}
  63
  64     filename_ext = ".bvh"
  65     filter_glob = StringProperty(default="*.bvh", options={'HIDDEN'})
  66
  67     target = EnumProperty(items=(
  68             ('ARMATURE', "Armature", ""),
  69             ('OBJECT', "Object", ""),
  70             ),
  71                 name="Target",
  72                 description="Import target type",
  73                 default='ARMATURE')
  74
  75     global_scale = FloatProperty(
  76             name="Scale",
  77             description="Scale the BVH by this value",
  78             min=0.0001, max=1000000.0,
  79             soft_min=0.001, soft_max=100.0,
  80             default=1.0,
  81             )
  82     frame_start = IntProperty(
  83             name="Start Frame",
  84             description="Starting frame for the animation",
  85             default=1,
  86             )
  87     use_fps_scale = BoolProperty(
  88             name="Scale FPS",
  89             description=("Scale the framerate from the BVH to the current scenes, "
  90                          "otherwise each BVH frame maps directly to a Blender frame"),
  91             default=False,
  92             )
  93     update_scene_fps = BoolProperty(
  94             name="Update Scene FPS",
  95             description="Set the scene framerate to that of the BVH file (note that this "
  96                         "nullifies the 'Scale FPS' option, as the scale will be 1:1)",
  97             default=False
  98             )
  99     update_scene_duration = BoolProperty(
 100             name="Update Scene Duration",
 101             description="Extend the scene's duration to the BVH duration (never shortens the scene)",
 102             default=False,
 103             )
 104     use_cyclic = BoolProperty(
 105             name="Loop",
 106             description="Loop the animation playback",
 107             default=False,
 108             )
 109     rotate_mode = EnumProperty(
 110             name="Rotation",
 111             description="Rotation conversion",
 112             items=(('QUATERNION', "Quaternion",
 113                     "Convert rotations to quaternions"),
 114                    ('NATIVE', "Euler (Native)",
 115                               "Use the rotation order defined in the BVH file"),
 116                    ('XYZ', "Euler (XYZ)", "Convert rotations to euler XYZ"),
 117                    ('XZY', "Euler (XZY)", "Convert rotations to euler XZY"),
 118                    ('YXZ', "Euler (YXZ)", "Convert rotations to euler YXZ"),
 119                    ('YZX', "Euler (YZX)", "Convert rotations to euler YZX"),
 120                    ('ZXY', "Euler (ZXY)", "Convert rotations to euler ZXY"),
 121                    ('ZYX', "Euler (ZYX)", "Convert rotations to euler ZYX"),
 122                    ),
 123             default='NATIVE',
 124             )
 125
 126     def execute(self, context):
 127         keywords = self.as_keywords(ignore=("axis_forward",
 128                                             "axis_up",
 129                                             "filter_glob",
 130                                             ))
 131
 132         global_matrix = axis_conversion(from_forward=self.axis_forward,
 133                                         from_up=self.axis_up,
 134                                         ).to_4x4()
 135
 136         keywords["global_matrix"] = global_matrix
 137
 138         from . import import_bvh
 139         return import_bvh.load(context, report=self.report, **keywords)
 140
 141
 142 class ExportBVH(bpy.types.Operator, ExportHelper):
 143     """Save a BVH motion capture file from an armature"""
 144     bl_idname = "export_anim.bvh"
 145     bl_label = "Export BVH"
 146
 147     filename_ext = ".bvh"
 148     filter_glob = StringProperty(
 149             default="*.bvh",
 150             options={'HIDDEN'},
 151             )
 152
 153     global_scale = FloatProperty(
 154             name="Scale",
 155             description="Scale the BVH by this value",
 156             min=0.0001, max=1000000.0,
 157             soft_min=0.001, soft_max=100.0,
 158             default=1.0,
 159             )
 160     frame_start = IntProperty(
 161             name="Start Frame",
 162             description="Starting frame to export",
 163             default=0,
 164             )
 165     frame_end = IntProperty(
 166             name="End Frame",
 167             description="End frame to export",
 168             default=0,
 169             )
 170     rotate_mode = EnumProperty(
 171             name="Rotation",
 172             description="Rotation conversion",
 173             items=(('NATIVE', "Euler (Native)",
 174                               "Use the rotation order defined in the BVH file"),
 175                    ('XYZ', "Euler (XYZ)", "Convert rotations to euler XYZ"),
 176                    ('XZY', "Euler (XZY)", "Convert rotations to euler XZY"),
 177                    ('YXZ', "Euler (YXZ)", "Convert rotations to euler YXZ"),
 178                    ('YZX', "Euler (YZX)", "Convert rotations to euler YZX"),
 179                    ('ZXY', "Euler (ZXY)", "Convert rotations to euler ZXY"),
 180                    ('ZYX', "Euler (ZYX)", "Convert rotations to euler ZYX"),
 181                    ),
 182             default='NATIVE',
 183             )
 184     root_transform_only = BoolProperty(
 185             name="Root Translation Only",
 186             description="Only write out translation channels for the root bone",
 187             default=False,
 188             )
 189
 190     @classmethod
 191     def poll(cls, context):
 192         obj = context.object
 193         return obj and obj.type == 'ARMATURE'
 194
 195     def invoke(self, context, event):
 196         self.frame_start = context.scene.frame_start
 197         self.frame_end = context.scene.frame_end
 198
 199         return super().invoke(context, event)
 200
 201     def execute(self, context):
 202         if self.frame_start == 0 and self.frame_end == 0:
 203             self.frame_start = context.scene.frame_start
 204             self.frame_end = context.scene.frame_end
 205
 206         keywords = self.as_keywords(ignore=("check_existing", "filter_glob"))
 207
 208         from . import export_bvh
 209         return export_bvh.save(self, context, **keywords)
 210
 211
 212 def menu_func_import(self, context):
 213     self.layout.operator(ImportBVH.bl_idname, text="Motion Capture (.bvh)")
 214
 215
 216 def menu_func_export(self, context):
 217     self.layout.operator(ExportBVH.bl_idname, text="Motion Capture (.bvh)")
 218
 219
 220 def register():
 221     bpy.utils.register_module(__name__)
 222
 223     bpy.types.TOPBAR_MT_file_import.append(menu_func_import)
 224     bpy.types.TOPBAR_MT_file_export.append(menu_func_export)
 225
 226
 227 def unregister():
 228     bpy.utils.unregister_module(__name__)
 229
 230     bpy.types.TOPBAR_MT_file_import.remove(menu_func_import)
 231     bpy.types.TOPBAR_MT_file_export.remove(menu_func_export)
 232
 233 if __name__ == "__main__":
 234     register()