poll() as a python '@staticmethod' was too limiting and didnt allow useful base class...
[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     if scene.objects.active:
103         bpy.ops.object.mode_set(mode='OBJECT')
104
105     #mesh = BPyMesh.getMeshFromObject(ob, None, EXPORT_APPLY_MODIFIERS, False, scn) # XXX
106     if EXPORT_APPLY_MODIFIERS:
107         mesh = ob.create_mesh(scene, True, 'PREVIEW')
108     else:
109         mesh = ob.data
110
111     if not mesh:
112         raise ("Error, could not get mesh data from active object")
113         return
114
115     # mesh.transform(ob.matrix_world) # XXX
116
117     faceUV = (len(mesh.uv_textures) > 0)
118     vertexUV = (len(mesh.sticky) > 0)
119     vertexColors = len(mesh.vertex_colors) > 0
120
121     if (not faceUV) and (not vertexUV):
122         EXPORT_UV = False
123     if not vertexColors:
124         EXPORT_COLORS = False
125
126     if not EXPORT_UV:
127         faceUV = vertexUV = False
128     if not EXPORT_COLORS:
129         vertexColors = False
130
131     if faceUV:
132         active_uv_layer = mesh.active_uv_texture
133         if not active_uv_layer:
134             EXPORT_UV = False
135             faceUV = None
136         else:
137             active_uv_layer = active_uv_layer.data
138
139     if vertexColors:
140         active_col_layer = mesh.active_vertex_color
141         if not active_col_layer:
142             EXPORT_COLORS = False
143             vertexColors = None
144         else:
145             active_col_layer = active_col_layer.data
146
147     # incase
148     color = uvcoord = uvcoord_key = normal = normal_key = None
149
150     mesh_verts = mesh.verts # save a lookup
151     ply_verts = [] # list of dictionaries
152     # vdict = {} # (index, normal, uv) -> new index
153     vdict = [{} for i in range(len(mesh_verts))]
154     ply_faces = [[] for f in range(len(mesh.faces))]
155     vert_count = 0
156     for i, f in enumerate(mesh.faces):
157
158
159         smooth = f.smooth
160         if not smooth:
161             normal = tuple(f.normal)
162             normal_key = rvec3d(normal)
163
164         if faceUV:
165             uv = active_uv_layer[i]
166             uv = uv.uv1, uv.uv2, uv.uv3, uv.uv4 # XXX - crufty :/
167         if vertexColors:
168             col = active_col_layer[i]
169             col = col.color1, col.color2, col.color3, col.color4
170
171         f_verts = f.verts
172
173         pf = ply_faces[i]
174         for j, vidx in enumerate(f_verts):
175             v = mesh_verts[vidx]
176
177             if smooth:
178                 normal = tuple(v.normal)
179                 normal_key = rvec3d(normal)
180
181             if faceUV:
182                 uvcoord = uv[j][0], 1.0 - uv[j][1]
183                 uvcoord_key = rvec2d(uvcoord)
184             elif vertexUV:
185                 uvcoord = v.uvco[0], 1.0 - v.uvco[1]
186                 uvcoord_key = rvec2d(uvcoord)
187
188             if vertexColors:
189                 color = col[j]
190                 color = int(color[0] * 255.0), int(color[1] * 255.0), int(color[2] * 255.0)
191
192
193             key = normal_key, uvcoord_key, color
194
195             vdict_local = vdict[vidx]
196             pf_vidx = vdict_local.get(key) # Will be None initially
197
198             if pf_vidx == None: # same as vdict_local.has_key(key)
199                 pf_vidx = vdict_local[key] = vert_count
200                 ply_verts.append((vidx, normal, uvcoord, color))
201                 vert_count += 1
202
203             pf.append(pf_vidx)
204
205     file.write('ply\n')
206     file.write('format ascii 1.0\n')
207     file.write('comment Created by Blender %s - www.blender.org, source file: %s\n' % (bpy.app.version_string, bpy.data.filepath.split('/')[-1].split('\\')[-1]))
208
209     file.write('element vertex %d\n' % len(ply_verts))
210
211     file.write('property float x\n')
212     file.write('property float y\n')
213     file.write('property float z\n')
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     if EXPORT_UV:
220         file.write('property float s\n')
221         file.write('property float t\n')
222     if EXPORT_COLORS:
223         file.write('property uchar red\n')
224         file.write('property uchar green\n')
225         file.write('property uchar blue\n')
226
227     file.write('element face %d\n' % len(mesh.faces))
228     file.write('property list uchar uint vertex_indices\n')
229     file.write('end_header\n')
230
231     for i, v in enumerate(ply_verts):
232         file.write('%.6f %.6f %.6f ' % tuple(mesh_verts[v[0]].co)) # co
233         if EXPORT_NORMALS:
234             file.write('%.6f %.6f %.6f ' % v[1]) # no
235         if EXPORT_UV:
236             file.write('%.6f %.6f ' % v[2]) # uv
237         if EXPORT_COLORS:
238             file.write('%u %u %u' % v[3]) # col
239         file.write('\n')
240
241     for pf in ply_faces:
242         if len(pf) == 3:
243             file.write('3 %d %d %d\n' % tuple(pf))
244         else:
245             file.write('4 %d %d %d %d\n' % tuple(pf))
246
247     file.close()
248     print("writing", filename, "done")
249
250     if EXPORT_APPLY_MODIFIERS:
251         bpy.data.meshes.remove(mesh)
252
253     # XXX
254     """
255     if is_editmode:
256         Blender.Window.EditMode(1, '', 0)
257     """
258
259 from bpy.props import *
260
261
262 class ExportPLY(bpy.types.Operator):
263     '''Export a single object as a stanford PLY with normals, colours and texture coordinates.'''
264     bl_idname = "export.ply"
265     bl_label = "Export PLY"
266
267     # List of operator properties, the attributes will be assigned
268     # to the class instance from the operator settings before calling.
269
270
271     filepath = StringProperty(name="File Path", description="Filepath used for exporting the PLY file", maxlen=1024, default="")
272     check_existing = BoolProperty(name="Check Existing", description="Check and warn on overwriting existing files", default=True, options={'HIDDEN'})
273     use_modifiers = BoolProperty(name="Apply Modifiers", description="Apply Modifiers to the exported mesh", default=True)
274     use_normals = BoolProperty(name="Normals", description="Export Normals for smooth and hard shaded faces", default=True)
275     use_uvs = BoolProperty(name="UVs", description="Exort the active UV layer", default=True)
276     use_colors = BoolProperty(name="Vertex Colors", description="Exort the active vertex color layer", default=True)
277
278     @classmethod
279     def poll(cls, context):
280         return context.active_object != None
281
282     def execute(self, context):
283         filepath = self.properties.filepath
284         filepath = bpy.path.ensure_ext(filepath, ".ply")
285
286         write(filepath, context.scene, context.active_object,\
287             EXPORT_APPLY_MODIFIERS=self.properties.use_modifiers,
288             EXPORT_NORMALS=self.properties.use_normals,
289             EXPORT_UV=self.properties.use_uvs,
290             EXPORT_COLORS=self.properties.use_colors,
291         )
292
293         return {'FINISHED'}
294
295     def invoke(self, context, event):
296         wm = context.manager
297         wm.add_fileselect(self)
298         return {'RUNNING_MODAL'}
299
300     def draw(self, context):
301         layout = self.layout
302         props = self.properties
303
304         row = layout.row()
305         row.prop(props, "use_modifiers")
306         row.prop(props, "use_normals")
307         row = layout.row()
308         row.prop(props, "use_uvs")
309         row.prop(props, "use_colors")
310
311
312 def menu_func(self, context):
313     import os
314     default_path = os.path.splitext(bpy.data.filepath)[0] + ".ply"
315     self.layout.operator(ExportPLY.bl_idname, text="Stanford (.ply)").filepath = default_path
316
317
318 def register():
319     bpy.types.INFO_MT_file_export.append(menu_func)
320
321
322 def unregister():
323     bpy.types.INFO_MT_file_export.remove(menu_func)
324
325 if __name__ == "__main__":
326     register()