io_scene_x3d/__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": "Web3D X3D/VRML2 format",
   7     "author": "Campbell Barton, Bart, Bastien Montagne, Seva Alekseyev",
   8     "version": (2, 3, 1),
   9     "blender": (2, 93, 0),
  10     "location": "File > Import-Export",
  11     "description": "Import-Export X3D, Import VRML2",
  12     "warning": "",
  13     "doc_url": "{BLENDER_MANUAL_URL}/addons/import_export/scene_x3d.html",
  14     "category": "Import-Export",
  15 }
  16
  17 if "bpy" in locals():
  18     import importlib
  19     if "import_x3d" in locals():
  20         importlib.reload(import_x3d)
  21     if "export_x3d" in locals():
  22         importlib.reload(export_x3d)
  23
  24 import bpy
  25 from bpy.props import (
  26         BoolProperty,
  27         EnumProperty,
  28         FloatProperty,
  29         StringProperty,
  30         )
  31 from bpy_extras.io_utils import (
  32         ImportHelper,
  33         ExportHelper,
  34         orientation_helper,
  35         axis_conversion,
  36         path_reference_mode,
  37         )
  38
  39
  40 @orientation_helper(axis_forward='Z', axis_up='Y')
  41 class ImportX3D(bpy.types.Operator, ImportHelper):
  42     """Import an X3D or VRML2 file"""
  43     bl_idname = "import_scene.x3d"
  44     bl_label = "Import X3D/VRML2"
  45     bl_options = {'PRESET', 'UNDO'}
  46
  47     filename_ext = ".x3d"
  48     filter_glob: StringProperty(default="*.x3d;*.wrl", options={'HIDDEN'})
  49
  50     def execute(self, context):
  51         from . import import_x3d
  52
  53         keywords = self.as_keywords(ignore=("axis_forward",
  54                                             "axis_up",
  55                                             "filter_glob",
  56                                             ))
  57         global_matrix = axis_conversion(from_forward=self.axis_forward,
  58                                         from_up=self.axis_up,
  59                                         ).to_4x4()
  60         keywords["global_matrix"] = global_matrix
  61
  62         return import_x3d.load(context, **keywords)
  63
  64     def draw(self, context):
  65         pass
  66
  67
  68 class X3D_PT_export_include(bpy.types.Panel):
  69     bl_space_type = 'FILE_BROWSER'
  70     bl_region_type = 'TOOL_PROPS'
  71     bl_label = "Include"
  72     bl_parent_id = "FILE_PT_operator"
  73
  74     @classmethod
  75     def poll(cls, context):
  76         sfile = context.space_data
  77         operator = sfile.active_operator
  78
  79         return operator.bl_idname == "EXPORT_SCENE_OT_x3d"
  80
  81     def draw(self, context):
  82         layout = self.layout
  83         layout.use_property_split = True
  84         layout.use_property_decorate = False  # No animation.
  85
  86         sfile = context.space_data
  87         operator = sfile.active_operator
  88
  89         layout.prop(operator, "use_selection")
  90         layout.prop(operator, "use_hierarchy")
  91         layout.prop(operator, "name_decorations")
  92         layout.prop(operator, "use_h3d")
  93
  94
  95 class X3D_PT_export_transform(bpy.types.Panel):
  96     bl_space_type = 'FILE_BROWSER'
  97     bl_region_type = 'TOOL_PROPS'
  98     bl_label = "Transform"
  99     bl_parent_id = "FILE_PT_operator"
 100
 101     @classmethod
 102     def poll(cls, context):
 103         sfile = context.space_data
 104         operator = sfile.active_operator
 105
 106         return operator.bl_idname == "EXPORT_SCENE_OT_x3d"
 107
 108     def draw(self, context):
 109         layout = self.layout
 110         layout.use_property_split = True
 111         layout.use_property_decorate = False  # No animation.
 112
 113         sfile = context.space_data
 114         operator = sfile.active_operator
 115
 116         layout.prop(operator, "global_scale")
 117         layout.prop(operator, "axis_forward")
 118         layout.prop(operator, "axis_up")
 119
 120
 121 class X3D_PT_export_geometry(bpy.types.Panel):
 122     bl_space_type = 'FILE_BROWSER'
 123     bl_region_type = 'TOOL_PROPS'
 124     bl_label = "Geometry"
 125     bl_parent_id = "FILE_PT_operator"
 126
 127     @classmethod
 128     def poll(cls, context):
 129         sfile = context.space_data
 130         operator = sfile.active_operator
 131
 132         return operator.bl_idname == "EXPORT_SCENE_OT_x3d"
 133
 134     def draw(self, context):
 135         layout = self.layout
 136         layout.use_property_split = True
 137         layout.use_property_decorate = False  # No animation.
 138
 139         sfile = context.space_data
 140         operator = sfile.active_operator
 141
 142         layout.prop(operator, "use_mesh_modifiers")
 143         layout.prop(operator, "use_triangulate")
 144         layout.prop(operator, "use_normals")
 145         layout.prop(operator, "use_compress")
 146
 147
 148 @orientation_helper(axis_forward='Z', axis_up='Y')
 149 class ExportX3D(bpy.types.Operator, ExportHelper):
 150     """Export selection to Extensible 3D file (.x3d)"""
 151     bl_idname = "export_scene.x3d"
 152     bl_label = 'Export X3D'
 153     bl_options = {'PRESET'}
 154
 155     filename_ext = ".x3d"
 156     filter_glob: StringProperty(default="*.x3d", options={'HIDDEN'})
 157
 158     use_selection: BoolProperty(
 159             name="Selection Only",
 160             description="Export selected objects only",
 161             default=False,
 162             )
 163     use_mesh_modifiers: BoolProperty(
 164             name="Apply Modifiers",
 165             description="Use transformed mesh data from each object",
 166             default=True,
 167             )
 168     use_triangulate: BoolProperty(
 169             name="Triangulate",
 170             description="Write quads into 'IndexedTriangleSet'",
 171             default=False,
 172             )
 173     use_normals: BoolProperty(
 174             name="Normals",
 175             description="Write normals with geometry",
 176             default=False,
 177             )
 178     use_compress: BoolProperty(
 179             name="Compress",
 180             description="Compress the exported file",
 181             default=False,
 182             )
 183     use_hierarchy: BoolProperty(
 184             name="Hierarchy",
 185             description="Export parent child relationships",
 186             default=True,
 187             )
 188     name_decorations: BoolProperty(
 189             name="Name decorations",
 190             description=("Add prefixes to the names of exported nodes to "
 191                          "indicate their type"),
 192             default=True,
 193             )
 194     use_h3d: BoolProperty(
 195             name="H3D Extensions",
 196             description="Export shaders for H3D",
 197             default=False,
 198             )
 199
 200     global_scale: FloatProperty(
 201             name="Scale",
 202             min=0.01, max=1000.0,
 203             default=1.0,
 204             )
 205
 206     path_mode: path_reference_mode
 207
 208     def execute(self, context):
 209         from . import export_x3d
 210
 211         from mathutils import Matrix
 212
 213         keywords = self.as_keywords(ignore=("axis_forward",
 214                                             "axis_up",
 215                                             "global_scale",
 216                                             "check_existing",
 217                                             "filter_glob",
 218                                             ))
 219         global_matrix = axis_conversion(to_forward=self.axis_forward,
 220                                         to_up=self.axis_up,
 221                                         ).to_4x4() @ Matrix.Scale(self.global_scale, 4)
 222         keywords["global_matrix"] = global_matrix
 223
 224         return export_x3d.save(context, **keywords)
 225
 226     def draw(self, context):
 227         pass
 228
 229
 230 class X3D_PT_import_transform(bpy.types.Panel):
 231     bl_space_type = 'FILE_BROWSER'
 232     bl_region_type = 'TOOL_PROPS'
 233     bl_label = "Transform"
 234     bl_parent_id = "FILE_PT_operator"
 235
 236     @classmethod
 237     def poll(cls, context):
 238         sfile = context.space_data
 239         operator = sfile.active_operator
 240
 241         return operator.bl_idname == "IMPORT_SCENE_OT_x3d"
 242
 243     def draw(self, context):
 244         layout = self.layout
 245         layout.use_property_split = True
 246         layout.use_property_decorate = False  # No animation.
 247
 248         sfile = context.space_data
 249         operator = sfile.active_operator
 250
 251         layout.prop(operator, "axis_forward")
 252         layout.prop(operator, "axis_up")
 253
 254
 255 def menu_func_import(self, context):
 256     self.layout.operator(ImportX3D.bl_idname,
 257                          text="X3D Extensible 3D (.x3d/.wrl)")
 258
 259
 260 def menu_func_export(self, context):
 261     self.layout.operator(ExportX3D.bl_idname,
 262                          text="X3D Extensible 3D (.x3d)")
 263
 264
 265 classes = (
 266     ExportX3D,
 267     X3D_PT_export_include,
 268     X3D_PT_export_transform,
 269     X3D_PT_export_geometry,
 270     ImportX3D,
 271     X3D_PT_import_transform,
 272 )
 273
 274
 275 def register():
 276     for cls in classes:
 277         bpy.utils.register_class(cls)
 278
 279     bpy.types.TOPBAR_MT_file_import.append(menu_func_import)
 280     bpy.types.TOPBAR_MT_file_export.append(menu_func_export)
 281
 282
 283 def unregister():
 284     bpy.types.TOPBAR_MT_file_import.remove(menu_func_import)
 285     bpy.types.TOPBAR_MT_file_export.remove(menu_func_export)
 286
 287     for cls in classes:
 288         bpy.utils.unregister_class(cls)
 289
 290
 291 if __name__ == "__main__":
 292     register()