home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / lib / site-packages / cgkit / objexport.py < prev    next >
Encoding:
Python Source  |  2007-01-11  |  12.4 KB  |  389 lines
  1. # ***** BEGIN LICENSE BLOCK *****
  2. # Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3. #
  4. # The contents of this file are subject to the Mozilla Public License Version
  5. # 1.1 (the "License"); you may not use this file except in compliance with
  6. # the License. You may obtain a copy of the License at
  7. # http://www.mozilla.org/MPL/
  8. #
  9. # Software distributed under the License is distributed on an "AS IS" basis,
  10. # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11. # for the specific language governing rights and limitations under the
  12. # License.
  13. #
  14. # The Original Code is the Python Computer Graphics Kit.
  15. #
  16. # The Initial Developer of the Original Code is Matthias Baas.
  17. # Portions created by the Initial Developer are Copyright (C) 2004
  18. # the Initial Developer. All Rights Reserved.
  19. #
  20. # Contributor(s):
  21. #
  22. # Alternatively, the contents of this file may be used under the terms of
  23. # either the GNU General Public License Version 2 or later (the "GPL"), or
  24. # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  25. # in which case the provisions of the GPL or the LGPL are applicable instead
  26. # of those above. If you wish to allow use of your version of this file only
  27. # under the terms of either the GPL or the LGPL, and not to allow others to
  28. # use your version of this file under the terms of the MPL, indicate your
  29. # decision by deleting the provisions above and replace them with the notice
  30. # and other provisions required by the GPL or the LGPL. If you do not delete
  31. # the provisions above, a recipient may use your version of this file under
  32. # the terms of any one of the MPL, the GPL or the LGPL.
  33. #
  34. # ***** END LICENSE BLOCK *****
  35. # $Id: objexport.py,v 1.4 2005/06/07 12:01:05 mbaas Exp $
  36.  
  37. import os.path, sys, re
  38. from cgtypes import *
  39. from scene import getScene
  40. from geomobject import *
  41. from trimeshgeom import TriMeshGeom
  42. from polyhedrongeom import PolyhedronGeom
  43. import pluginmanager
  44. import cmds
  45.  
  46. # OBJExporter
  47. class OBJExporter:
  48.  
  49.     _protocols = ["Export"]
  50.  
  51.     # extension
  52.     def extension():
  53.         """Return the file extensions for this format."""
  54.         return ["obj"]
  55.     extension = staticmethod(extension)
  56.  
  57.     # description
  58.     def description(self):
  59.         """Return a short description for the file dialog."""
  60.         return "Wavefront object file"
  61.     description = staticmethod(description)
  62.  
  63.     # exportFile
  64.     def exportFile(self, filename, root=None, mtlname=None, exportmtl=True):
  65.         """Export an OBJ file.
  66.  
  67.         root is the root of the subtree that should be exported.
  68.         If exportmtl is False, no MTL file is generated.
  69.         mtlname determines the name of the MTL file (default: the same base
  70.         name than filename).
  71.         If exportmtl is False and no mtlname is given, then no material
  72.         information will be written.
  73.         """
  74.  
  75.         self.fhandle = file(filename, "w")
  76.  
  77.         self.use_materials = (exportmtl or mtlname!=None)
  78.         self.root = cmds.worldObject(root)
  79.         self.v_offset = 0
  80.         self.vt_offset = 0
  81.         self.vn_offset = 0
  82.  
  83.         self.group_offset = 0
  84.  
  85.         # This dictionary is used to find name clashes and store the materials
  86.         # that have to be exported.
  87.         # Key is the name of the material, value is the material object
  88.         self.materials = {}
  89.  
  90.         # Determine the name of the MTL file (by changing the suffix)
  91.         if mtlname==None:
  92.             name, ext = os.path.splitext(filename)
  93.             mtlname = name+".mtl"
  94.  
  95.         if self.use_materials:
  96.             print >>self.fhandle, "mtllib %s"%os.path.basename(mtlname)
  97.  
  98.         # Export objects...
  99.         if root!=None:
  100.             self.group_offset = len(self.getGroups(self.root))-1
  101.             self.exportObject(self.root)
  102.         for obj in getScene().walkWorld(self.root):
  103.             self.exportObject(obj)
  104.  
  105.         self.fhandle.close()
  106.  
  107.         # Export the MTL file...
  108.         if exportmtl:
  109.             self.exportMTL(mtlname)
  110.  
  111.  
  112.     # exportMTL
  113.     def exportMTL(self, filename):
  114.         f = file(filename, "w")
  115.         for matname in self.materials:
  116.             mat = self.materials[matname]
  117.             print >>f, "newmtl %s"%matname
  118.             if hasattr(mat, "mtlDefinition"):
  119.                 f.write(mat.mtlDefinition())
  120.         f.close()
  121.         
  122.  
  123.     # exportObject
  124.     def exportObject(self, obj):
  125.         
  126.         geom = self.convertObject(obj)
  127.         if geom==None:
  128.             return
  129.  
  130.         self.vt_mode = 0
  131.         self.vn_mode = 0
  132.  
  133.         # Get the world transform to transform the vertices...
  134.         WT = obj.worldtransform
  135.         WT3 = WT.getMat3()
  136.  
  137.         # Export vertices...
  138.         for v in geom.verts:
  139.             print >>self.fhandle, "v %f %f %f"%tuple(WT*v)
  140.  
  141.         # Export normals...
  142.         N = None
  143.         info = geom.findVariable("N")
  144.         if info!=None and info[2]==NORMAL and info[3]==1:
  145.             N = geom.slot("N")
  146.             for norm in N:
  147.                 norm = WT3*norm
  148.                 try:
  149.                     norm = norm.normalize()
  150.                 except:
  151.                     pass
  152.                 print >>self.fhandle, "vn %f %f %f"%tuple(norm)
  153.  
  154.             if info[1]==VARYING:
  155.                 self.vn_mode = 1
  156.             elif info[1]==FACEVARYING:
  157.                 self.vn_mode = 2
  158.             elif info[1]==USER:
  159.                 info = geom.findVariable("Nfaces")
  160.                 if info!=None and info[1]==UNIFORM and info[2]==INT and info[3]==3:
  161.                     self.vn_mode = 3
  162.             
  163.         # Export texture coordinates...
  164.         st = None
  165.         info = geom.findVariable("st")
  166.         if info!=None and info[2]==FLOAT and info[3]==2:
  167.             st = geom.slot("st")
  168.             for vt in st:
  169.                 print >>self.fhandle, "vt %f %f"%vt
  170.  
  171.             if info[1]==VARYING:
  172.                 self.vt_mode = 1
  173.             elif info[1]==FACEVARYING:
  174.                 self.vt_mode = 2
  175.             elif info[1]==USER:
  176.                 info = geom.findVariable("stfaces")
  177.                 if info!=None and info[1]==UNIFORM and info[2]==INT and info[3]==3:
  178.                     self.vt_mode = 3
  179.  
  180.         # Export groups...
  181.         print >>self.fhandle, "g %s"%" ".join(self.getGroups(obj))
  182.  
  183.         # Export material name...
  184.         mat = obj.getMaterial()
  185.         if mat!=None and self.use_materials:
  186.             mname = self.preProcessMaterial(mat)
  187.             print >>self.fhandle, "usemtl %s"%mname
  188.         
  189.         # Export faces...
  190.         if isinstance(geom, TriMeshGeom):
  191.             self.exportTriFaces(geom)
  192.         else:
  193.             self.exportPolyFaces(geom)
  194.  
  195.         self.v_offset += geom.verts.size()
  196.         if st!=None:
  197.             self.vt_offset += st.size()
  198.         if N!=None:
  199.             self.vn_offset += N.size()
  200.  
  201.     # exportTriFaces
  202.     def exportTriFaces(self, geom):
  203.         """Export the faces of a TriMesh geom.
  204.         """
  205.         vt_mode = self.vt_mode
  206.         vn_mode = self.vn_mode
  207.         stfaces = None
  208.         if vt_mode==3:
  209.             # It has been previously checked that the variable exists...
  210.             stfaces = geom.slot("stfaces")
  211.         Nfaces = None
  212.         if vn_mode==3:
  213.             # It has been previously checked that the variable exists...
  214.             Nfaces = geom.slot("Nfaces")
  215.             
  216.         vt = ""
  217.         vn = ""
  218.         # The current index of facevarying variables (starting at 1 because
  219.         # OBJ is 1-based)
  220.         facevaridx = 1
  221.         for i in range(geom.faces.size()):
  222.             f = geom.faces[i]
  223.             if vt_mode==3:
  224.                 tf = stfaces[i]
  225.             if vn_mode==3:
  226.                 nf = Nfaces[i]
  227.                 
  228.             a = []
  229.             for j in range(3):
  230.                 v = f[j]
  231.                 # OBJ indices are 1-based
  232.                 v += 1
  233.                 
  234.                 # varying texture coordinates?
  235.                 if vt_mode==1:
  236.                     vt = str(v+self.vt_offset)
  237.                 # facevarying texture coordinates?
  238.                 elif vt_mode==2:
  239.                     vt = str(self.vt_offset+facevaridx)
  240.                 # user?
  241.                 elif vt_mode==3:
  242.                     vt = str(tf[j]+1+self.vt_offset)
  243.                     
  244.                 # varying normals?
  245.                 if vn_mode==1:
  246.                     vn = str(v+self.vn_offset)
  247.                 # facevarying normals?
  248.                 elif vn_mode==2:
  249.                     vn = str(self.vn_offset+facevaridx)
  250.                 # user?
  251.                 elif vn_mode==3:
  252.                     vn = str(nf[j]+1+self.vn_offset)
  253.  
  254.                 if vn=="":
  255.                     if vt=="":
  256.                         a.append("%d"%(v+self.v_offset))
  257.                     else:
  258.                         a.append("%d/%s"%(v+self.v_offset, vt))
  259.                 else:
  260.                     a.append("%d/%s/%s"%(v+self.v_offset, vt, vn))
  261.                 facevaridx += 1
  262.             print >>self.fhandle, "f %s"%" ".join(a)
  263.         
  264.  
  265.     # exportPolyFaces
  266.     def exportPolyFaces(self, geom):
  267.         """Export the faces of a polyhedron geom.
  268.         """
  269.         vt_mode = self.vt_mode
  270.         vn_mode = self.vn_mode
  271.         vt = ""
  272.         vn = ""
  273.         # The current index of facevarying variables (starting at 1 because
  274.         # OBJ is 1-based)
  275.         facevaridx = 1
  276.         for i in range(geom.getNumPolys()):
  277.             poly = geom.getPoly(i)
  278.             a = []
  279.             for v in poly[0]:
  280.                 # OBJ indices are 1-based
  281.                 v += 1
  282.                 
  283.                 # varying texture coordinates?
  284.                 if vt_mode==1:
  285.                     vt = str(v+self.vt_offset)
  286.                 # facevarying texture coordinates?
  287.                 elif vt_mode==2:
  288.                     vt = str(self.vt_offset+facevaridx)
  289.                     
  290.                 # varying normals?
  291.                 if vn_mode==1:
  292.                     vn = str(v+self.vn_offset)
  293.                 # facevarying normals?
  294.                 elif vn_mode==2:
  295.                     vn = str(self.vn_offset+facevaridx)
  296.                     
  297.                 if vn=="":
  298.                     if vt=="":
  299.                         a.append("%d"%(v+self.v_offset))
  300.                     else:
  301.                         a.append("%d/%s"%(v+self.v_offset, vt))
  302.                 else:
  303.                     a.append("%d/%s/%s"%(v+self.v_offset, vt, vn))
  304.                 facevaridx += 1
  305.             print >>self.fhandle, "f %s"%" ".join(a)
  306.  
  307.     # preProcessMaterial
  308.     def preProcessMaterial(self, mat):
  309.         """Check and store the material.
  310.  
  311.         The return value is the material name (which might have been
  312.         modified to make it unique).
  313.         """
  314.         # Check if the material was already exported
  315.         if mat==self.materials.get(mat.name, None):
  316.             return mat.name
  317.  
  318.         # Determine a unique name for the material
  319.         name = mat.name
  320.         m = re.search("[0-9]+$", name)
  321.         if m==None:
  322.             basename = name
  323.             num = 0
  324.         else:
  325.             basename = name[:m.start()]
  326.             num = int(name[m.start():m.end()])
  327.         while name in self.materials:
  328.             num += 1
  329.             name = basename + str(num)
  330.  
  331.         self.materials[name] = mat
  332.             
  333.         return name
  334.  
  335.     # getGroups
  336.     def getGroups(self, obj):
  337.         """Get a list of "groups".
  338.  
  339.         Return a list that contains the names from the root to the object
  340.         (excluding the world root).
  341.         """
  342.         res = []
  343.         wr = getScene().worldRoot()
  344.         while obj!=None:
  345.             res = [obj.name]+res
  346.             obj = obj.parent
  347.         return res[1+self.group_offset:]
  348.  
  349.     # convertObject
  350.     def convertObject(self, obj):
  351.         """Converts an object into a polyhedron or trimesh if necessary.
  352.  
  353.         The return value is a GeomObject (TriMeshGeom or PolyhedronGeom)
  354.         or None.
  355.         """
  356.         geom = obj.geom
  357.         if isinstance(geom, TriMeshGeom):
  358.             return geom
  359.         
  360.         if not isinstance(geom, PolyhedronGeom):
  361.             # Try to convert into a polyhedron...
  362.             pg = PolyhedronGeom()
  363.             try:
  364.                 geom.convert(pg)
  365.                 geom = pg
  366.             except:
  367.                 pass
  368.  
  369.         # Is it a PolyhedronGeom that has no polys with holes? then return
  370.         # the geom...
  371.         if isinstance(geom, PolyhedronGeom) and not geom.hasPolysWithHoles():
  372.             return geom
  373.  
  374.         # Try to convert into a triangle mesh...
  375.         tm = TriMeshGeom()
  376.         try:
  377.             geom.convert(tm)
  378.             return tm
  379.         except:
  380.             pass
  381.  
  382.         return None
  383.         
  384.  
  385. ######################################################################
  386.  
  387. # Register the exporter class as a plugin class
  388. pluginmanager.register(OBJExporter)
  389.