c860a9707df07e60f165589949a9f9d889e0e483
[blender.git] / release / scripts / obj_import.py
1 #!BPY
2  
3 """
4 Name: 'Wavefront (.obj)...'
5 Blender: 232
6 Group: 'Import'
7 Tooltip: 'Load a Wavefront OBJ File'
8 """
9
10 __author__ = "Campbell Barton"
11 __url__ = ["blender", "elysiun"]
12 __version__ = "0.9"
13
14 __bpydoc__ = """\
15 This script imports OBJ files to Blender.
16
17 Usage:
18
19 Run this script from "File->Import" menu and then load the desired OBJ file.
20 """
21
22 # $Id$
23 #
24 # --------------------------------------------------------------------------
25 # OBJ Import v0.9 by Campbell Barton (AKA Ideasman)
26 # --------------------------------------------------------------------------
27 # ***** BEGIN GPL LICENSE BLOCK *****
28 #
29 # This program is free software; you can redistribute it and/or
30 # modify it under the terms of the GNU General Public License
31 # as published by the Free Software Foundation; either version 2
32 # of the License, or (at your option) any later version.
33 #
34 # This program is distributed in the hope that it will be useful,
35 # but WITHOUT ANY WARRANTY; without even the implied warranty of
36 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
37 # GNU General Public License for more details.
38 #
39 # You should have received a copy of the GNU General Public License
40 # along with this program; if not, write to the Free Software Foundation,
41 # Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
42 #
43 # ***** END GPL LICENCE BLOCK *****
44 # --------------------------------------------------------------------------
45
46 NULL_MAT = '(null)' # Name for mesh's that have no mat set.
47 NULL_IMG = '(null)' # Name for mesh's that have no mat set.
48
49 MATLIMIT = 16 # This isnt about to change but probably should not be hard coded.
50
51 DIR = ''
52
53 #==============================================#
54 # Return directory, where is file              #
55 #==============================================#
56 def pathName(path,name):
57         length=len(path)
58         for CH in range(1, length):
59                 if path[length-CH:] == name:
60                         path = path[:length-CH]
61                         break
62         return path
63
64 #==============================================#
65 # Strips the slashes from the back of a string #
66 #==============================================#
67 def stripPath(path):
68         for CH in range(len(path), 0, -1):
69                 if path[CH-1] == "/" or path[CH-1] == "\\":
70                         path = path[CH:]
71                         break
72         return path
73         
74 #====================================================#
75 # Strips the prefix off the name before writing      #
76 #====================================================#
77 def stripName(name): # name is a string
78         prefixDelimiter = '.'
79         return name[ : name.find(prefixDelimiter) ]
80
81
82 from Blender import *
83
84 #==================================================================================#
85 # This gets a mat or creates one of the requested name if none exist.              #
86 #==================================================================================#
87 def getMat(matName):
88         # Make a new mat
89         try:
90                 return Material.Get(matName)
91         except:
92                 return Material.New(matName)
93
94
95 #==================================================================================#
96 # This function sets textures defined in .mtl file                                 #
97 #==================================================================================#
98 def getImg(img_fileName):
99         for i in Image.Get():
100                 if i.filename == img_fileName:
101                         return i
102         
103         # if we are this far it means the image hasnt been loaded.
104         try:
105                 return Image.Load(img_fileName)
106         except:
107                 print "unable to open", img_fileName
108                 return
109
110
111
112 #==================================================================================#
113 # This function sets textures defined in .mtl file                                 #
114 #==================================================================================#
115 def load_mat_image(mat, img_fileName, type, mesh):
116         try:
117                 image = Image.Load(img_fileName)
118         except:
119                 print "unable to open", img_fileName
120                 return
121         
122         texture = Texture.New(type)
123         texture.setType('Image')
124         texture.image = image
125         
126         # adds textures to faces (Textured/Alt-Z mode)
127         # Only apply the diffuse texture to the face if the image has not been set with the inline usemat func.
128         if type == 'Kd':
129                 for f in mesh.faces:
130                         if mesh.materials[f.mat].name == mat.name:
131                         
132                                 # the inline usemat command overides the material Image
133                                 if not f.image:
134                                   f.image = image
135         
136         # adds textures for materials (rendering)
137         if type == 'Ka':
138                 mat.setTexture(0, texture, Texture.TexCo.UV, Texture.MapTo.CMIR)
139         if type == 'Kd':
140                 mat.setTexture(1, texture, Texture.TexCo.UV, Texture.MapTo.COL)
141         if type == 'Ks':
142                 mat.setTexture(2, texture, Texture.TexCo.UV, Texture.MapTo.SPEC)
143
144 #==================================================================================#
145 # This function loads materials from .mtl file (have to be defined in obj file)    #
146 #==================================================================================#
147 def load_mtl(dir, mtl_file, mesh):
148         # Remove ./
149         if mtl_file[:2] == './':
150                 mtl_file= mtl_file[2:]
151         
152         mtl_fileName = dir + mtl_file
153         try:
154                 fileLines= open(mtl_fileName, 'r').readlines()
155         except:
156                 print "unable to open", mtl_fileName
157                 return
158         
159         lIdx=0
160         while lIdx < len(fileLines):
161                 l = fileLines[lIdx].split()
162         
163                 # Detect a line that will be ignored
164                 if len(l) == 0:
165                         pass
166                 elif l[0] == '#' or len(l) == 0:
167                         pass
168                 elif l[0] == 'newmtl':
169                         currentMat = getMat(' '.join(l[1:]))
170                 elif l[0] == 'Ka':
171                         currentMat.setMirCol(float(l[1]), float(l[2]), float(l[3]))
172                 elif l[0] == 'Kd':
173                         currentMat.setRGBCol(float(l[1]), float(l[2]), float(l[3]))
174                 elif l[0] == 'Ks':
175                         currentMat.setSpecCol(float(l[1]), float(l[2]), float(l[3]))
176                 elif l[0] == 'Ns':
177                         currentMat.setHardness( int((float(l[1])*0.51)) )
178                 elif l[0] == 'd':
179                         currentMat.setAlpha(float(l[1]))
180                 elif l[0] == 'Tr':
181                         currentMat.setAlpha(float(l[1]))
182                 elif l[0] == 'map_Ka':
183                         img_fileName = dir + l[1]
184                         load_mat_image(currentMat, img_fileName, 'Ka', mesh)
185                 elif l[0] == 'map_Ks':
186                         img_fileName = dir + l[1]
187                         load_mat_image(currentMat, img_fileName, 'Ks', mesh)
188                 elif l[0] == 'map_Kd':
189                         img_fileName = dir + l[1]
190                         load_mat_image(currentMat, img_fileName, 'Kd', mesh)
191                 lIdx+=1
192
193 #======================================================================#
194 # Returns unique name of object (preserve overwriting existing meshes) #
195 #======================================================================#
196 def getUniqueName(name):
197         uniqueInt = 0
198         while 1:
199                 try:
200                         ob = Object.Get(name)
201                         # Okay, this is working, so lets make a new name
202                         name += '.' + str(uniqueInt)
203                         uniqueInt +=1
204                 except:
205                         return name
206
207
208 #==================================================================================#
209 # This loads data from .obj file                                                   #
210 #==================================================================================#
211 def load_obj(file):
212         time1 = sys.time()
213         def applyMat(mesh, f, mat):
214                 # Check weather the 16 mat limit has been met.
215                 if len( meshList[objectName][0].materials ) >= MATLIMIT:
216                         print 'Warning, max material limit reached, using an existing material'
217                         return meshList[objectName][0]
218     
219                 mIdx = 0
220                 for m in meshList[objectName][0].materials:
221                         if m.getName() == mat.getName():
222                                 break
223                         mIdx+=1
224     
225                 if mIdx == len(mesh.materials):
226                         meshList[objectName][0].addMaterial(mat)
227     
228                 f.mat = mIdx
229                 return f
230
231         # Get the file name with no path or .obj
232         fileName = stripName( stripPath(file) )
233
234         mtl_fileName = ''
235
236         DIR = pathName(file, stripPath(file))
237
238         fileLines = open(file, 'r').readlines()
239
240
241
242         uvMapList = [(0,0)] # store tuple uv pairs here
243
244         # This dummy vert makes life a whole lot easier-
245         # pythons index system then aligns with objs, remove later
246         vertList = [NMesh.Vert(0, 0, 0)] # store tuple uv pairs here
247
248         nullMat = getMat(NULL_MAT)
249         
250         currentMat = nullMat # Use this mat.
251         currentImg = NULL_IMG # Null image is a string, otherwise this should be set to an image object.\
252         currentSmooth = 0
253         
254         #==================================================================================#
255         # Make split lines, ignore blenk lines or comments.                                #
256         #==================================================================================#
257         lIdx = 0 
258         while lIdx < len(fileLines):
259                 fileLines[lIdx] = fileLines[lIdx].split()
260                 lIdx+=1
261         
262         #==================================================================================#
263         # Load all verts first (texture verts too)                                         #
264         #==================================================================================#
265         lIdx = 0
266         while lIdx < len(fileLines):
267                 l = fileLines[lIdx]
268
269                 # EMPTY LINE
270                 if len(l) == 0 or l[0] == '#':
271                         pass
272                 
273                 # VERTEX
274                 elif l[0] == 'v':
275                         # This is a new vert, make a new mesh
276                         vertList.append( NMesh.Vert(float(l[1]), float(l[2]), float(l[3]) ) )
277                         fileLines.remove(fileLines[lIdx])
278                         lIdx-=1
279                 
280                 # UV COORDINATE
281                 elif l[0] == 'vt':
282                         # This is a new vert, make a new mesh
283                         uvMapList.append( (float(l[1]), float(l[2])) )
284                         fileLines.remove(fileLines[lIdx])
285                         lIdx-=1
286                 lIdx+=1
287         
288         
289         # Here we store a boolean list of which verts are used or not
290         # no we know weather to add them to the current mesh
291         # This is an issue with global vertex indicies being translated to per mesh indicies
292         # like blenders, we start with a dummy just like the vert.
293         # -1 means unused, any other value refers to the local mesh index of the vert.
294
295         # objectName has a char in front of it that determins weather its a group or object.
296         # We ignore it when naming the object.
297         objectName = 'omesh' # If we cant get one, use this
298         meshList = {}
299         meshList[objectName] = (NMesh.GetRaw(), [-1]*len(vertList)) # Mesh/meshList[objectName][1]
300         meshList[objectName][0].verts.append(vertList[0])
301
302         #==================================================================================#
303         # Load all faces into objects, main loop                                           #
304         #==================================================================================#
305         lIdx = 0
306         # Face and Object loading LOOP
307         while lIdx < len(fileLines):
308                 l = fileLines[lIdx]
309
310                 # COMMENTS AND EMPTY LINES
311                 if len(l) == 0 or l[0] == '#':
312                         pass
313                         
314                 # VERTEX
315                 elif l[0] == 'v':
316                         pass
317                         
318                 # VERTEX NORMAL
319                 elif l[0] == 'vn':
320                         pass
321                 
322                 # UV COORDINATE
323                 elif l[0] == 'vt':
324                         pass
325                 
326                 # FACE
327                 elif l[0] == 'f': 
328                         # Make a face with the correct material.
329                         f = NMesh.Face()
330                         f = applyMat(meshList[objectName][0], f, currentMat)
331                         f.smooth = currentSmooth
332                         if currentImg != NULL_IMG: f.image = currentImg
333
334                         # Set up vIdxLs : Verts
335                         # Set up vtIdxLs : UV
336                         # Start with a dummy objects so python accepts OBJs 1 is the first index.
337                         vIdxLs = []
338                         vtIdxLs = []
339                         fHasUV = len(uvMapList)-1 # Assume the face has a UV until it sho it dosent, if there are no UV coords then this will start as 0.
340                         for v in l[1:]:
341                                 # OBJ files can have // or / to seperate vert/texVert/normal
342                                 # this is a bit of a pain but we must deal with it.
343                                 objVert = v.split('/', -1)
344                                 
345                                 # Vert Index - OBJ supports negative index assignment (like python)
346                                 
347                                 vIdxLs.append(int(objVert[0]))
348                                 if fHasUV:
349                                         # UV
350                                         if len(objVert) == 1:
351                                                 vtIdxLs.append(int(objVert[0])) # Sticky UV coords
352                                         elif objVert[1] != '': # Its possible that theres no texture vert just he vert and normal eg 1//2
353                                                 vtIdxLs.append(int(objVert[1])) # Seperate UV coords
354                                         else:
355                                                 fHasUV = 0
356
357                                         # Dont add a UV to the face if its larger then the UV coord list
358                                         # The OBJ file would have to be corrupt or badly written for thi to happen
359                                         # but account for it anyway.
360                                         if len(vtIdxLs) > 0:
361                                                 if vtIdxLs[-1] > len(uvMapList):
362                                                         fHasUV = 0
363                                                         print 'badly written OBJ file, invalid references to UV Texture coordinates.'
364                         
365                         # Quads only, we could import quads using the method below but it polite to import a quad as a quad.
366                         if len(vIdxLs) == 4:
367                                 for i in [0,1,2,3]:
368                                         if meshList[objectName][1][vIdxLs[i]] == -1:
369                                                 meshList[objectName][0].verts.append(vertList[vIdxLs[i]])
370                                                 f.v.append(meshList[objectName][0].verts[-1])
371                                                 meshList[objectName][1][vIdxLs[i]] = len(meshList[objectName][0].verts)-1
372                                         else:
373                                                 f.v.append(meshList[objectName][0].verts[meshList[objectName][1][vIdxLs[i]]])
374                                 
375                                 # UV MAPPING
376                                 if fHasUV:
377                                         for i in [0,1,2,3]:
378                                                 f.uv.append( uvMapList[ vtIdxLs[i] ] )
379
380                                 if f.v > 0:
381                                         f = applyMat(meshList[objectName][0], f, currentMat)
382                                         if currentImg != NULL_IMG:
383                                                 f.image = currentImg        
384                                         meshList[objectName][0].faces.append(f) # move the face onto the mesh
385                                         if len(meshList[objectName][0].faces[-1]) > 0:
386                                                 meshList[objectName][0].faces[-1].smooth = currentSmooth
387
388                         elif len(vIdxLs) >= 3: # This handles tri's and fans
389                                 for i in range(len(vIdxLs)-2):
390                                         f = NMesh.Face()
391                                         f = applyMat(meshList[objectName][0], f, currentMat)
392                                         for ii in [0, i+1, i+2]:
393                                                 
394                                                 if meshList[objectName][1][vIdxLs[ii]] == -1:
395                                                         meshList[objectName][0].verts.append(vertList[vIdxLs[ii]])
396                                                         f.v.append(meshList[objectName][0].verts[-1])
397                                                         meshList[objectName][1][vIdxLs[ii]] = len(meshList[objectName][0].verts)-1
398                                                 else:
399                                                         f.v.append(meshList[objectName][0].verts[meshList[objectName][1][vIdxLs[ii]]])
400
401                                         # UV MAPPING
402                                         if fHasUV:
403                                                 f.uv.append( uvMapList[ vtIdxLs[0] ] )
404                                                 f.uv.append( uvMapList[ vtIdxLs[i+1] ] )
405                                                 f.uv.append( uvMapList[ vtIdxLs[i+2] ] )
406
407                                         if f.v > 0:
408                                                 f = applyMat(meshList[objectName][0], f, currentMat)
409                                                 if currentImg != NULL_IMG:
410                                                         f.image = currentImg        
411                                                 meshList[objectName][0].faces.append(f) # move the face onto the mesh
412                                                 if len(meshList[objectName][0].faces[-1]) > 0:
413                                                         meshList[objectName][0].faces[-1].smooth = currentSmooth
414                 
415                 
416                 # FACE SMOOTHING
417                 elif l[0] == 's':
418                         if l[1] == 'off': currentSmooth = 0
419                         else: currentSmooth = 1
420                         # print "smoothing", currentSmooth
421
422                 # OBJECT / GROUP
423                 elif l[0] == 'o' or l[0] == 'g':
424                         # This makes sure that if an object and a group have the same name then
425                         # they are not put into the same object.
426                         
427                         # Only make a new group.object name if the verts in the existing object have been used, this is obscure
428                         # but some files face groups seperating verts and faces which results in silly things. (no groups have names.)
429                         if len(l) == 1 and len( meshList[objectName][0].faces ) == 0:
430                                 pass
431                         
432                         else:
433                                 newObjectName = l[0] + '_'                              
434                                 
435                                 # if there is no groups name then make gp_1, gp_2, gp_100 etc
436                                 
437                                 if len(l) == 1: # No name given, make a unique name up.
438                                         
439                                         unique_count = 0
440                                         while newObjectName in meshList.keys():
441                                                 newObjectName = l[0] + '_' + str(unique_count)
442                                                 unique_count +=1
443                                 else: # The the object/group name given
444                                         newObjectName += '_'.join(l[1:])
445                                 
446                                 # Assign the new name
447                                 objectName = newObjectName
448                                         
449                                 # If we havnt written to this mesh before then do so.
450                                 # if we have then we'll just keep appending to it, this is required for soem files.
451                                 if objectName not in meshList.keys():
452                                         meshList[objectName] = (NMesh.GetRaw(), [-1]*len(vertList))
453                                         meshList[objectName][0].verts.append( vertList[0] )
454                                 
455
456                 # MATERIAL
457                 elif l[0] == 'usemtl':
458                         if l[1] == '(null)':
459                                 currentMat = getMat(NULL_MAT)
460                         else:
461                                 currentMat = getMat(' '.join(l[1:])) # Use join in case of spaces
462                 
463                 # MATERIAL
464                 elif l[0] == 'usemat':
465                         if l[1] == '(null)':
466                                 currentImg = NULL_IMG
467                         else:
468                                 currentImg = getImg(DIR + ' '.join(l[1:])) # Use join in case of spaces 
469
470                 # MATERIAL FILE
471                 elif l[0] == 'mtllib':
472                         mtl_fileName = ' '.join(l[1:])
473                 
474                 lIdx+=1
475
476         
477         #==============================================#
478         # Write all meshs in the dictionary            #
479         #==============================================#  
480         for mk in meshList.keys():
481                 # Applies material properties to materials alredy on the mesh as well as Textures.
482                 if mtl_fileName != '':
483                         load_mtl(DIR, mtl_fileName, meshList[mk][0])
484                 if len(meshList[mk][0].verts) >1:
485                         meshList[mk][0].verts.remove(meshList[mk][0].verts[0])
486                         
487                         name = getUniqueName(mk)
488                         ob = NMesh.PutRaw(meshList[mk][0], mk)
489                         ob.name = mk
490
491         print "obj import time: ", sys.time() - time1
492
493 Window.FileSelector(load_obj, 'Import Wavefront OBJ')