change python scripts so modules which register with blender have a register() functi...
[blender.git] / release / scripts / io / export_ply.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 compliant>
20
21 import bpy
22
23 __author__ = "Bruce Merry"
24 __version__ = "0.93"
25 __bpydoc__ = """\
26 This script exports Stanford PLY files from Blender. It supports normals,
27 colours, and texture coordinates per face or per vertex.
28 Only one mesh can be exported at a time.
29 """
30
31 # Copyright (C) 2004, 2005: Bruce Merry, bmerry@cs.uct.ac.za
32 #
33 # This program is free software; you can redistribute it and/or
34 # modify it under the terms of the GNU General Public License
35 # as published by the Free Software Foundation; either version 2
36 # of the License, or (at your option) any later version.
37 #
38 # This program is distributed in the hope that it will be useful,
39 # but WITHOUT ANY WARRANTY; without even the implied warranty of
40 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
41 # GNU General Public License for more details.
42 #
43 # You should have received a copy of the GNU General Public License
44 # along with this program; if not, write to the Free Software Foundation,
45 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
46 # Vector rounding se we can use as keys
47 #
48 # Updated on Aug 11, 2008 by Campbell Barton
49 #    - added 'comment' prefix to comments - Needed to comply with the PLY spec.
50 #
51 # Updated on Jan 1, 2007 by Gabe Ghearing
52 #    - fixed normals so they are correctly smooth/flat
53 #    - fixed crash when the model doesn't have uv coords or vertex colors
54 #    - fixed crash when the model has vertex colors but doesn't have uv coords
55 #    - changed float32 to float and uint8 to uchar for compatibility
56 # Errata/Notes as of Jan 1, 2007
57 #    - script exports texture coords if they exist even if TexFace isn't selected (not a big deal to me)
58 #    - ST(R) should probably be renamed UV(T) like in most PLY files (importer needs to be updated to take either)
59 #
60 # Updated on Jan 3, 2007 by Gabe Ghearing
61 #    - fixed "sticky" vertex UV exporting
62 #    - added pupmenu to enable/disable exporting normals, uv coords, and colors
63 # Errata/Notes as of Jan 3, 2007
64 #    - ST(R) coords should probably be renamed UV(T) like in most PLY files (importer needs to be updated to take either)
65 #    - edges should be exported since PLY files support them
66 #    - code is getting spaghettish, it should be refactored...
67 #
68
69
70 def rvec3d(v):
71     return round(v[0], 6), round(v[1], 6), round(v[2], 6)
72
73
74 def rvec2d(v):
75     return round(v[0], 6), round(v[1], 6)
76
77
78 def write(filename, scene, ob, \
79         EXPORT_APPLY_MODIFIERS=True,\
80         EXPORT_NORMALS=True,\
81         EXPORT_UV=True,\
82         EXPORT_COLORS=True):
83
84     if not filename.lower().endswith('.ply'):
85         filename += '.ply'
86
87     if not ob:
88         raise Exception("Error, Select 1 active object")
89         return
90
91     file = open(filename, 'w')
92
93
94     #EXPORT_EDGES = Draw.Create(0)
95     """
96     is_editmode = Blender.Window.EditMode()
97     if is_editmode:
98         Blender.Window.EditMode(0, '', 0)
99
100     Window.WaitCursor(1)
101     """
102
103     #mesh = BPyMesh.getMeshFromObject(ob, None, EXPORT_APPLY_MODIFIERS, False, scn) # XXX
104     if EXPORT_APPLY_MODIFIERS:
105         mesh = ob.create_mesh(True, 'PREVIEW')
106     else:
107         mesh = ob.data
108
109     if not mesh:
110         raise ("Error, could not get mesh data from active object")
111         return
112
113     # mesh.transform(ob.matrixWorld) # XXX
114
115     faceUV = (len(mesh.uv_textures) > 0)
116     vertexUV = (len(mesh.sticky) > 0)
117     vertexColors = len(mesh.vertex_colors) > 0
118
119     if (not faceUV) and (not vertexUV):
120         EXPORT_UV = False
121     if not vertexColors:
122         EXPORT_COLORS = False
123
124     if not EXPORT_UV:
125         faceUV = vertexUV = False
126     if not EXPORT_COLORS:
127         vertexColors = False
128
129     if faceUV:
130         active_uv_layer = mesh.active_uv_texture
131         if not active_uv_layer:
132             EXPORT_UV = False
133             faceUV = None
134         else:
135             active_uv_layer = active_uv_layer.data
136
137     if vertexColors:
138         active_col_layer = mesh.active_vertex_color
139         if not active_col_layer:
140             EXPORT_COLORS = False
141             vertexColors = None
142         else:
143             active_col_layer = active_col_layer.data
144
145     # incase
146     color = uvcoord = uvcoord_key = normal = normal_key = None
147
148     mesh_verts = mesh.verts # save a lookup
149     ply_verts = [] # list of dictionaries
150     # vdict = {} # (index, normal, uv) -> new index
151     vdict = [{} for i in range(len(mesh_verts))]
152     ply_faces = [[] for f in range(len(mesh.faces))]
153     vert_count = 0
154     for i, f in enumerate(mesh.faces):
155
156
157         smooth = f.smooth
158         if not smooth:
159             normal = tuple(f.normal)
160             normal_key = rvec3d(normal)
161
162         if faceUV:
163             uv = active_uv_layer[i]
164             uv = uv.uv1, uv.uv2, uv.uv3, uv.uv4 # XXX - crufty :/
165         if vertexColors:
166             col = active_col_layer[i]
167             col = col.color1, col.color2, col.color3, col.color4
168
169         f_verts = f.verts
170
171         pf = ply_faces[i]
172         for j, vidx in enumerate(f_verts):
173             v = mesh_verts[vidx]
174
175             if smooth:
176                 normal = tuple(v.normal)
177                 normal_key = rvec3d(normal)
178
179             if faceUV:
180                 uvcoord = uv[j][0], 1.0 - uv[j][1]
181                 uvcoord_key = rvec2d(uvcoord)
182             elif vertexUV:
183                 uvcoord = v.uvco[0], 1.0 - v.uvco[1]
184                 uvcoord_key = rvec2d(uvcoord)
185
186             if vertexColors:
187                 color = col[j]
188                 color = int(color[0] * 255.0), int(color[1] * 255.0), int(color[2] * 255.0)
189
190
191             key = normal_key, uvcoord_key, color
192
193             vdict_local = vdict[vidx]
194             pf_vidx = vdict_local.get(key) # Will be None initially
195
196             if pf_vidx == None: # same as vdict_local.has_key(key)
197                 pf_vidx = vdict_local[key] = vert_count
198                 ply_verts.append((vidx, normal, uvcoord, color))
199                 vert_count += 1
200
201             pf.append(pf_vidx)
202
203     file.write('ply\n')
204     file.write('format ascii 1.0\n')
205     file.write('comment Created by Blender3D %s - www.blender.org, source file: %s\n' % (bpy.app.version_string, bpy.data.filename.split('/')[-1].split('\\')[-1]))
206
207     file.write('element vertex %d\n' % len(ply_verts))
208
209     file.write('property float x\n')
210     file.write('property float y\n')
211     file.write('property float z\n')
212
213     # XXX
214     """
215     if EXPORT_NORMALS:
216         file.write('property float nx\n')
217         file.write('property float ny\n')
218         file.write('property float nz\n')
219     """
220     if EXPORT_UV:
221         file.write('property float s\n')
222         file.write('property float t\n')
223     if EXPORT_COLORS:
224         file.write('property uchar red\n')
225         file.write('property uchar green\n')
226         file.write('property uchar blue\n')
227
228     file.write('element face %d\n' % len(mesh.faces))
229     file.write('property list uchar uint vertex_indices\n')
230     file.write('end_header\n')
231
232     for i, v in enumerate(ply_verts):
233         file.write('%.6f %.6f %.6f ' % tuple(mesh_verts[v[0]].co)) # co
234         """
235         if EXPORT_NORMALS:
236             file.write('%.6f %.6f %.6f ' % v[1]) # no
237         """
238         if EXPORT_UV:
239             file.write('%.6f %.6f ' % v[2]) # uv
240         if EXPORT_COLORS:
241             file.write('%u %u %u' % v[3]) # col
242         file.write('\n')
243
244     for pf in ply_faces:
245         if len(pf) == 3:
246             file.write('3 %d %d %d\n' % tuple(pf))
247         else:
248             file.write('4 %d %d %d %d\n' % tuple(pf))
249
250     file.close()
251     print("writing", filename, "done")
252
253     if EXPORT_APPLY_MODIFIERS:
254         bpy.data.meshes.remove(mesh)
255
256     # XXX
257     """
258     if is_editmode:
259         Blender.Window.EditMode(1, '', 0)
260     """
261
262 from bpy.props import *
263
264
265 class ExportPLY(bpy.types.Operator):
266     '''Export a single object as a stanford PLY with normals, colours and texture coordinates.'''
267     bl_idname = "export.ply"
268     bl_label = "Export PLY"
269
270     # List of operator properties, the attributes will be assigned
271     # to the class instance from the operator settings before calling.
272
273
274     path = StringProperty(name="File Path", description="File path used for exporting the PLY file", maxlen=1024, default="")
275     check_existing = BoolProperty(name="Check Existing", description="Check and warn on overwriting existing files", default=True, options={'HIDDEN'})
276     use_modifiers = BoolProperty(name="Apply Modifiers", description="Apply Modifiers to the exported mesh", default=True)
277     use_normals = BoolProperty(name="Normals", description="Export Normals for smooth and hard shaded faces", default=True)
278     use_uvs = BoolProperty(name="UVs", description="Exort the active UV layer", default=True)
279     use_colors = BoolProperty(name="Vertex Colors", description="Exort the active vertex color layer", default=True)
280
281     def poll(self, context):
282         return context.active_object != None
283
284     def execute(self, context):
285         # print("Selected: " + context.active_object.name)
286
287         if not self.properties.path:
288             raise Exception("filename not set")
289
290         write(self.properties.path, context.scene, context.active_object,\
291             EXPORT_APPLY_MODIFIERS=self.properties.use_modifiers,
292             EXPORT_NORMALS=self.properties.use_normals,
293             EXPORT_UV=self.properties.use_uvs,
294             EXPORT_COLORS=self.properties.use_colors,
295         )
296
297         return {'FINISHED'}
298
299     def invoke(self, context, event):
300         wm = context.manager
301         wm.add_fileselect(self)
302         return {'RUNNING_MODAL'}
303
304     def draw(self, context):
305         layout = self.layout
306         props = self.properties
307
308         row = layout.row()
309         row.prop(props, "use_modifiers")
310         row.prop(props, "use_normals")
311         row = layout.row()
312         row.prop(props, "use_uvs")
313         row.prop(props, "use_colors")
314
315
316 def menu_func(self, context):
317     default_path = bpy.data.filename.replace(".blend", ".ply")
318     self.layout.operator(ExportPLY.bl_idname, text="Stanford (.ply)...").path = default_path
319
320
321 def register():
322     bpy.types.register(ExportPLY)
323     bpy.types.INFO_MT_file_export.append(menu_func)
324     
325 def unregister():
326     bpy.types.unregister(ExportPLY)
327     bpy.types.INFO_MT_file_export.remove(menu_func)