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     "blender": (2, 74, 0),
  25     "location": "File > Import-Export",
  26     "description": "Import-Export BVH from armature objects",
  27     "warning": "",
  28     "wiki_url": "http://wiki.blender.org/index.php/Extensions:2.6/Py/"
  29                 "Scripts/Import-Export/BVH_Importer_Exporter",
  30     "support": 'OFFICIAL',
  31     "category": "Import-Export"}
  32
  33 if "bpy" in locals():
  34     import importlib
  35     if "import_bvh" in locals():
  36         importlib.reload(import_bvh)
  37     if "export_bvh" in locals():
  38         importlib.reload(export_bvh)
  39
  40 import bpy
  41 from bpy.props import (
  42         StringProperty,
  43         FloatProperty,
  44         IntProperty,
  45         BoolProperty,
  46         EnumProperty,
  47         )
  48 from bpy_extras.io_utils import (
  49         ImportHelper,
  50         ExportHelper,
  51         orientation_helper_factory,
  52         axis_conversion,
  53         )
  54
  55
  56 ImportBVHOrientationHelper = orientation_helper_factory("ImportBVHOrientationHelper", axis_forward='-Z', axis_up='Y')
  57
  58
  59 class ImportBVH(bpy.types.Operator, ImportHelper, ImportBVHOrientationHelper):
  60     """Load a BVH motion capture file"""
  61     bl_idname = "import_anim.bvh"
  62     bl_label = "Import BVH"
  63     bl_options = {'REGISTER', 'UNDO'}
  64
  65     filename_ext = ".bvh"
  66     filter_glob = StringProperty(default="*.bvh", options={'HIDDEN'})
  67
  68     target = EnumProperty(items=(
  69             ('ARMATURE', "Armature", ""),
  70             ('OBJECT', "Object", ""),
  71             ),
  72                 name="Target",
  73                 description="Import target type",
  74                 default='ARMATURE')
  75
  76     global_scale = FloatProperty(
  77             name="Scale",
  78             description="Scale the BVH by this value",
  79             min=0.0001, max=1000000.0,
  80             soft_min=0.001, soft_max=100.0,
  81             default=1.0,
  82             )
  83     frame_start = IntProperty(
  84             name="Start Frame",
  85             description="Starting frame for the animation",
  86             default=1,
  87             )
  88     use_fps_scale = BoolProperty(
  89             name="Scale FPS",
  90             description=("Scale the framerate from the BVH to the current scenes, "
  91                          "otherwise each BVH frame maps directly to a Blender frame"),
  92             default=False,
  93             )
  94     update_scene_fps = BoolProperty(
  95             name="Update Scene FPS",
  96             description="Set the scene framerate to that of the BVH file (note that this "
  97                         "nullifies the 'Scale FPS' option, as the scale will be 1:1)",
  98             default=False
  99             )
 100     update_scene_duration = BoolProperty(
 101             name="Update Scene Duration",
 102             description="Extend the scene's duration to the BVH duration (never shortens the scene)",
 103             default=False,
 104             )
 105     use_cyclic = BoolProperty(
 106             name="Loop",
 107             description="Loop the animation playback",
 108             default=False,
 109             )
 110     rotate_mode = EnumProperty(
 111             name="Rotation",
 112             description="Rotation conversion",
 113             items=(('QUATERNION', "Quaternion",
 114                     "Convert rotations to quaternions"),
 115                    ('NATIVE', "Euler (Native)",
 116                               "Use the rotation order defined in the BVH file"),
 117                    ('XYZ', "Euler (XYZ)", "Convert rotations to euler XYZ"),
 118                    ('XZY', "Euler (XZY)", "Convert rotations to euler XZY"),
 119                    ('YXZ', "Euler (YXZ)", "Convert rotations to euler YXZ"),
 120                    ('YZX', "Euler (YZX)", "Convert rotations to euler YZX"),
 121                    ('ZXY', "Euler (ZXY)", "Convert rotations to euler ZXY"),
 122                    ('ZYX', "Euler (ZYX)", "Convert rotations to euler ZYX"),
 123                    ),
 124             default='NATIVE',
 125             )
 126
 127     def execute(self, context):
 128         keywords = self.as_keywords(ignore=("axis_forward",
 129                                             "axis_up",
 130                                             "filter_glob",
 131                                             ))
 132
 133         global_matrix = axis_conversion(from_forward=self.axis_forward,
 134                                         from_up=self.axis_up,
 135                                         ).to_4x4()
 136
 137         keywords["global_matrix"] = global_matrix
 138
 139         from . import import_bvh
 140         return import_bvh.load(context, report=self.report, **keywords)
 141
 142
 143 class ExportBVH(bpy.types.Operator, ExportHelper):
 144     """Save a BVH motion capture file from an armature"""
 145     bl_idname = "export_anim.bvh"
 146     bl_label = "Export BVH"
 147
 148     filename_ext = ".bvh"
 149     filter_glob = StringProperty(
 150             default="*.bvh",
 151             options={'HIDDEN'},
 152             )
 153
 154     global_scale = FloatProperty(
 155             name="Scale",
 156             description="Scale the BVH by this value",
 157             min=0.0001, max=1000000.0,
 158             soft_min=0.001, soft_max=100.0,
 159             default=1.0,
 160             )
 161     frame_start = IntProperty(
 162             name="Start Frame",
 163             description="Starting frame to export",
 164             default=0,
 165             )
 166     frame_end = IntProperty(
 167             name="End Frame",
 168             description="End frame to export",
 169             default=0,
 170             )
 171     rotate_mode = EnumProperty(
 172             name="Rotation",
 173             description="Rotation conversion",
 174             items=(('NATIVE', "Euler (Native)",
 175                               "Use the rotation order defined in the BVH file"),
 176                    ('XYZ', "Euler (XYZ)", "Convert rotations to euler XYZ"),
 177                    ('XZY', "Euler (XZY)", "Convert rotations to euler XZY"),
 178                    ('YXZ', "Euler (YXZ)", "Convert rotations to euler YXZ"),
 179                    ('YZX', "Euler (YZX)", "Convert rotations to euler YZX"),
 180                    ('ZXY', "Euler (ZXY)", "Convert rotations to euler ZXY"),
 181                    ('ZYX', "Euler (ZYX)", "Convert rotations to euler ZYX"),
 182                    ),
 183             default='NATIVE',
 184             )
 185     root_transform_only = BoolProperty(
 186             name="Root Translation Only",
 187             description="Only write out translation channels for the root bone",
 188             default=False,
 189             )
 190
 191     @classmethod
 192     def poll(cls, context):
 193         obj = context.object
 194         return obj and obj.type == 'ARMATURE'
 195
 196     def invoke(self, context, event):
 197         self.frame_start = context.scene.frame_start
 198         self.frame_end = context.scene.frame_end
 199
 200         return super().invoke(context, event)
 201
 202     def execute(self, context):
 203         if self.frame_start == 0 and self.frame_end == 0:
 204             self.frame_start = context.scene.frame_start
 205             self.frame_end = context.scene.frame_end
 206
 207         keywords = self.as_keywords(ignore=("check_existing", "filter_glob"))
 208
 209         from . import export_bvh
 210         return export_bvh.save(self, context, **keywords)
 211
 212
 213 def menu_func_import(self, context):
 214     self.layout.operator(ImportBVH.bl_idname, text="Motion Capture (.bvh)")
 215
 216
 217 def menu_func_export(self, context):
 218     self.layout.operator(ExportBVH.bl_idname, text="Motion Capture (.bvh)")
 219
 220
 221 def register():
 222     bpy.utils.register_module(__name__)
 223
 224     bpy.types.INFO_MT_file_import.append(menu_func_import)
 225     bpy.types.INFO_MT_file_export.append(menu_func_export)
 226
 227
 228 def unregister():
 229     bpy.utils.unregister_module(__name__)
 230
 231     bpy.types.INFO_MT_file_import.remove(menu_func_import)
 232     bpy.types.INFO_MT_file_export.remove(menu_func_export)
 233
 234 if __name__ == "__main__":
 235     register()