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