io_shape_mdd/__init__.py

   1 # SPDX-FileCopyrightText: 2011-2022 Blender Foundation
   2 #
   3 # SPDX-License-Identifier: GPL-2.0-or-later
   4
   5 bl_info = {
   6     "name": "NewTek MDD format",
   7     "author": "Bill L.Nieuwendorp",
   8     "version": (1, 0, 1),
   9     "blender": (2, 80, 0),
  10     "location": "File > Import-Export",
  11     "description": "Import-Export MDD as mesh shape keys",
  12     "warning": "",
  13     "doc_url": "{BLENDER_MANUAL_URL}/addons/import_export/shape_mdd.html",
  14     "support": 'OFFICIAL',
  15     "category": "Import-Export",
  16 }
  17
  18 if "bpy" in locals():
  19     import importlib
  20     if "import_mdd" in locals():
  21         importlib.reload(import_mdd)
  22     if "export_mdd" in locals():
  23         importlib.reload(export_mdd)
  24
  25
  26 import bpy
  27 from bpy.props import (
  28         BoolProperty,
  29         FloatProperty,
  30         IntProperty,
  31         StringProperty,
  32         )
  33 from bpy_extras.io_utils import ExportHelper, ImportHelper
  34
  35
  36 class ImportMDD(bpy.types.Operator, ImportHelper):
  37     """Import MDD vertex keyframe file to shape keys"""
  38     bl_idname = "import_shape.mdd"
  39     bl_label = "Import MDD"
  40     bl_options = {'UNDO'}
  41
  42     filename_ext = ".mdd"
  43
  44     filter_glob: StringProperty(
  45             default="*.mdd",
  46             options={'HIDDEN'},
  47             )
  48     frame_start: IntProperty(
  49             name="Start Frame",
  50             description="Start frame for inserting animation",
  51             min=-300000, max=300000,
  52             default=0,
  53             )
  54     frame_step: IntProperty(
  55             name="Step",
  56             min=1, max=1000,
  57             default=1,
  58             )
  59
  60     @classmethod
  61     def poll(cls, context):
  62         obj = context.active_object
  63         return (obj and obj.type == 'MESH')
  64
  65     def invoke(self, context, event):
  66         scene = context.scene
  67         self.frame_start = scene.frame_start
  68
  69         return super().invoke(context, event)
  70
  71     def execute(self, context):
  72         keywords = self.as_keywords(ignore=("filter_glob",))
  73
  74         from . import import_mdd
  75         return import_mdd.load(context, **keywords)
  76
  77
  78 class ExportMDD(bpy.types.Operator, ExportHelper):
  79     """Animated mesh to MDD vertex keyframe file"""
  80     bl_idname = "export_shape.mdd"
  81     bl_label = "Export MDD"
  82
  83     filename_ext = ".mdd"
  84     filter_glob: StringProperty(default="*.mdd", options={'HIDDEN'})
  85
  86     # get first scene to get min and max properties for frames, fps
  87
  88     minframe = 0
  89     maxframe = 300000
  90     minfps = 1.0
  91     maxfps = 120.0
  92
  93     # List of operator properties, the attributes will be assigned
  94     # to the class instance from the operator settings before calling.
  95     fps: FloatProperty(
  96             name="Frames Per Second",
  97             description="Number of frames/second",
  98             min=minfps, max=maxfps,
  99             default=25.0,
 100             )
 101     frame_start: IntProperty(
 102             name="Start Frame",
 103             description="Start frame for baking",
 104             min=minframe, max=maxframe,
 105             default=1,
 106             )
 107     frame_end: IntProperty(
 108             name="End Frame",
 109             description="End frame for baking",
 110             min=minframe, max=maxframe,
 111             default=250,
 112             )
 113     use_rest_frame: BoolProperty(
 114             name="Rest Frame",
 115             description="Write the rest state at the first frame",
 116             default=False,
 117             )
 118
 119     @classmethod
 120     def poll(cls, context):
 121         obj = context.active_object
 122         return (obj and obj.type == 'MESH')
 123
 124     def invoke(self, context, event):
 125         scene = context.scene
 126         self.frame_start = scene.frame_start
 127         self.frame_end = scene.frame_end
 128         self.fps = scene.render.fps / scene.render.fps_base
 129
 130         return super().invoke(context, event)
 131
 132     def execute(self, context):
 133         keywords = self.as_keywords(ignore=("check_existing", "filter_glob"))
 134
 135         from . import export_mdd
 136         return export_mdd.save(context, **keywords)
 137
 138
 139 def menu_func_import(self, context):
 140     self.layout.operator(ImportMDD.bl_idname,
 141                          text="Lightwave Point Cache (.mdd)",
 142                          )
 143
 144
 145 def menu_func_export(self, context):
 146     self.layout.operator(ExportMDD.bl_idname,
 147                          text="Lightwave Point Cache (.mdd)",
 148                          )
 149
 150
 151 classes = (
 152     ImportMDD,
 153     ExportMDD
 154 )
 155
 156 def register():
 157     for cls in classes:
 158         bpy.utils.register_class(cls)
 159
 160     bpy.types.TOPBAR_MT_file_import.append(menu_func_import)
 161     bpy.types.TOPBAR_MT_file_export.append(menu_func_export)
 162
 163
 164 def unregister():
 165     for cls in classes:
 166         bpy.utils.unregister_class(cls)
 167
 168     bpy.types.TOPBAR_MT_file_import.remove(menu_func_import)
 169     bpy.types.TOPBAR_MT_file_export.remove(menu_func_export)
 170
 171 if __name__ == "__main__":
 172     register()