- bug fix #1874
[blender.git] / release / scripts / obj_export.py
1 #!BPY
2
3 """
4 Name: 'Wavefront (.obj)...'
5 Blender: 232
6 Group: 'Export'
7 Tooltip: 'Save a Wavefront OBJ File'
8 """
9
10 __author__ = "Campbell Barton, Jiri Hnidek"
11 __url__ = ["blender", "elysiun"]
12 __version__ = "0.9"
13
14 __bpydoc__ = """\
15 This script is an exporter to OBJ file format.
16
17 Usage:
18
19 Run this script from "File->Export" menu to export all meshes.
20 """
21
22
23 # --------------------------------------------------------------------------
24 # OBJ Export v0.9 by Campbell Barton (AKA Ideasman)
25 # --------------------------------------------------------------------------
26 # ***** BEGIN GPL LICENSE BLOCK *****
27 #
28 # This program is free software; you can redistribute it and/or
29 # modify it under the terms of the GNU General Public License
30 # as published by the Free Software Foundation; either version 2
31 # of the License, or (at your option) any later version.
32 #
33 # This program is distributed in the hope that it will be useful,
34 # but WITHOUT ANY WARRANTY; without even the implied warranty of
35 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
36 # GNU General Public License for more details.
37 #
38 # You should have received a copy of the GNU General Public License
39 # along with this program; if not, write to the Free Software Foundation,
40 # Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
41 #
42 # ***** END GPL LICENCE BLOCK *****
43 # --------------------------------------------------------------------------
44
45 #==================================================#
46 # New name based on old with a different extension #
47 #==================================================#
48 def newFName(ext):
49   return Get('filename')[: -len(Get('filename').split('.', -1)[-1]) ] + ext
50
51
52 #===============================================#
53 # Strips the slashes from the front of a string #
54 #===============================================#
55 def stripPath(path):
56         for CH in range(len(path), 0, -1):
57                 if path[CH-1] == "/" or path[CH-1] == "\\":
58                         path = path[CH:]
59                         break
60         return path
61
62 #==================#
63 # Apply Transform  #
64 #==================#
65 def apply_transform(vert, matrix_4x4):
66         vertCopy = Mathutils.CopyVec(vert)
67         vertCopy.resize4D()
68         return Mathutils.VecMultMat(vertCopy, matrix_4x4)
69
70 #=================================#
71 # Apply Transform (normal vector) #
72 #=================================#
73 def apply_normal_transform(norm, matrix_3x3):
74         vertCopy = Mathutils.CopyVec(norm)
75         vertCopy.resize3D()
76         return Mathutils.VecMultMat(vertCopy, matrix_3x3)
77
78 from Blender import *
79
80 NULL_MAT = '(null)'
81 NULL_IMG = '(null)'
82
83 def save_mtl(filename):
84         file = open(filename, "w")
85         for mat in Material.Get():
86                 
87                 file.write('newmtl %s\n' % (mat.getName())) # Define a new material
88
89                 # Hardness, convert blenders 1-511 to MTL's 
90                 file.write('Ns %s\n' % ((mat.getHardness()-1) * 1.9607843137254901 ) )
91                 
92                 col = mat.getRGBCol()
93                 # Diffuse
94                 file.write('Kd %s %s %s\n' % (col[0], col[1], col[2]))
95                 
96                 col = mat.getMirCol()
97                 # Ambient, uses mirror colour,
98                 file.write('Ka %s %s %s\n' % (col[0], col[1], col[2]))
99                 
100                 col = mat.getSpecCol()
101                 # Specular
102                 file.write('Ks %s %s %s\n' % (col[0],col[1], col[2]))
103
104                 # Alpha (dissolve)
105                 file.write('d %s\n' % (mat.getAlpha()))
106                 
107                 # illum, 0 to disable lightng, 2 is normal.
108                 if mat.getMode() & Material.Modes['SHADELESS']:
109                         file.write('illum 0\n') # ignore lighting
110                 else:
111                         file.write('illum 2\n') # light normaly
112                 
113                 # End OF Mat
114                 file.write('\n') # new line
115                 
116         file.close()
117
118 def save_obj(filename):
119         time1 = sys.time()
120         # First output all material
121         mtlfilename = filename[:-4] + '.mtl'
122         save_mtl(mtlfilename)
123
124         file = open(filename, "w")
125
126         # Write Header
127         file.write('# Blender OBJ File: %s\n' % (Get('filename')))
128         file.write('# www.blender.org\n')
129
130         # Tell the obj file what material file to use.
131         file.write('mtllib %s\n' % (stripPath(mtlfilename)))
132
133         # Initialize totals, these are updated each object
134         totverts = totuvco = 0
135
136         # Get all meshs
137         for ob in Object.Get():
138                 if ob.getType() != 'Mesh':
139                         continue
140                 m = NMesh.GetRawFromObject(ob.name)
141     
142                 # remove any edges, is not written back to the mesh so its not going to
143                 # modify the open file.
144                 for f in m.faces:
145                         if len(f.v) < 3:
146                                 m.faces.remove(f)
147   
148                 if len(m.faces) == 0: # Make sure there is somthing to write.
149                         continue #dont bother with this mesh.
150   
151                 # Set the default mat
152                 currentMatName = NULL_MAT
153                 currentImgName = NULL_IMG
154   
155                 #file.write('o ' + ob.getName() + '_' + m.name + '\n') # Write Object name
156                 file.write('o %s_%s\n' % (ob.getName(), m.name)) # Write Object name
157   
158                 # Works 100% Yay
159                 matrix_4x4 = ob.getMatrix('worldspace')
160
161                 # matrix for transformation of normal vectors
162                 matrix_3x3 = Mathutils.Matrix([matrix_4x4[0][0], matrix_4x4[0][1], matrix_4x4[0][2]],
163                         [matrix_4x4[1][0], matrix_4x4[1][1], matrix_4x4[1][2]],
164                         [matrix_4x4[2][0], matrix_4x4[2][1], matrix_4x4[2][2]])
165   
166                 # Vert
167                 for v in m.verts:
168                         # Transform the vert
169                         vTx = apply_transform(v.co, matrix_4x4)
170                         file.write('v %s %s %s\n' % (vTx[0], vTx[1], vTx[2]))
171   
172                 # UV
173                 for f in m.faces:
174                         for uvIdx in range(len(f.v)):
175                                 if f.uv:
176                                         file.write('vt %s %s 0.0\n' % (f.uv[uvIdx][0], f.uv[uvIdx][1]))
177                                 else:
178                                         file.write('vt 0.0 0.0 0.0\n')
179   
180                 # NORMAL
181                 for f1 in m.faces:
182                         for v in f1.v:
183                                 # Transform the normal
184                                 noTx = apply_normal_transform(v.no, matrix_3x3)
185                                 noTx.normalize()
186                                 file.write('vn %s %s %s\n' % (noTx[0], noTx[1], noTx[2]))
187
188                 uvIdx = 0
189                 for f in m.faces:
190                         # Check material and change if needed.
191                         if len(m.materials) > f.mat:
192                                 if currentMatName != m.materials[f.mat].getName():
193                                         currentMatName = m.materials[f.mat].getName()
194                                         file.write('usemtl %s\n' % (currentMatName))
195       
196                         elif currentMatName != NULL_MAT:
197                                 currentMatName = NULL_MAT
198                                 file.write('usemtl %s\n' % (currentMatName))
199     
200                         # UV IMAGE
201                         # If the face uses a different image from the one last set then add a usemap line.
202                         if f.image:
203                                 if f.image.filename != currentImgName:
204                                         currentImgName = f.image.filename
205                                         # Set a new image for all following faces
206                                         file.write( 'usemat %s\n' % (stripPath(currentImgName)))
207         
208                         elif currentImgName != NULL_IMG: # Not using an image so set to NULL_IMG
209                                 currentImgName = NULL_IMG
210                                 # Set a new image for all following faces
211                                 file.write( 'usemat %s\n' % (stripPath(currentImgName)))
212
213                         file.write('f ')
214                         for v in f.v:
215                                 file.write( '%s/%s/%s ' % (m.verts.index(v) + totverts+1, uvIdx+totuvco+1, uvIdx+totuvco+1))
216
217                                 uvIdx+=1
218                         file.write('\n')
219     
220                 # Make the indicies global rather then per mesh
221                 totverts += len(m.verts)
222                 totuvco += uvIdx
223         file.close()
224         print "obj export time: ", sys.time() - time1
225
226 Window.FileSelector(save_obj, 'Export Wavefront OBJ', newFName('obj'))