File: export_obj.py

package info (click to toggle)
darkradiant 3.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 41,080 kB
  • sloc: cpp: 264,743; ansic: 10,659; python: 1,852; xml: 1,650; sh: 92; makefile: 21
file content (271 lines) | stat: -rw-r--r-- 11,559 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# ***** BEGIN GPL LICENSE BLOCK *****
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
# ***** END GPL LICENCE BLOCK *****

# Set the command name so that DarkRadiant recognises this file
__commandName__ = 'objExport'
__commandDisplayName__ = 'Export OBJ...'

# The actual algorithm called by DarkRadiant is contained in the execute() function
def execute():
    script = "DarkRadiant Wavefront OBJ Export (*.obj)"
    author = "Python port by greebo, based on original exporter C++ code in DarkRadiant and the ASE exporter scripts"
    version = "0.2"

    import darkradiant as dr

    # Check if we have a valid selection

    selectionInfo = GlobalSelectionSystem.getSelectionInfo()

    # Don't allow empty selections or selected components only
    if selectionInfo.totalCount == 0 or selectionInfo.totalCount == selectionInfo.componentCount:
        errMsg = GlobalDialogManager.createMessageBox('No selection', 'Nothing selected, cannot run exporter.', dr.Dialog.ERROR)
        errMsg.run()
        return

    # An exportable object found in the map
    class Geometry(object):
        name = ''           # Name of the object to be exported
        vertices = []       # Vertices
        texcoords = []      # Texture coordinates
        faces = []          # Each face in turn is an array of indices referencing the vertices and texcoords
                            # For simplicity, we assume that the referenced vertices and texcoords always
                            # have the same global index number.
        def __init__(self, name):
            self.name = name
            self.vertices = []
            self.texcoords = []
            self.faces = []

    # An exportable object found in the map
    class Geometries(object):
        vertexCount = 0     # Global Vertex Index (every vertex in an OBJ file has a unique number)
        objects = []        # List of Geometry objects

    # We put all of the objects we collect in the map into this array
    # Before we write it to the output stream the vertices can be processed (e.g. centered)
    geomlist = Geometries()
    
    def processBrush(brushnode):
        # Create a new exportable object 
        geometry = Geometry('Brush{0}'.format(len(geomlist.objects)))
        
        numfaces = brushnode.getNumFaces()
        for index in range(numfaces):
            facenode = brushnode.getFace(index)
            shader = facenode.getShader()

            # Tels: skip if caulk and no caulk should be exported
            if (shader == 'textures/common/caulk') and (int(GlobalRegistry.get('user/scripts/objExport/exportcaulk'))) == 0:
                continue

            winding = facenode.getWinding()
            
            # Remember the index of the first vertex
            firstVertex = geomlist.vertexCount

            for point in winding:
                # Write coordinates into the export buffers
                geometry.vertices.append(point.vertex)
                geometry.texcoords.append(point.texcoord)
                
                # Keep track of the exported vertices
                geomlist.vertexCount += 1
                
            # Append the face to the list, referencing vertices from firstVertex to the current count
            # Face indices are 1-based, so increase by 1 each time
			# Reverse the list to produce the correct face normal direction
            geometry.faces.append([i for i in reversed(range(firstVertex+1, geomlist.vertexCount+1))])

        print('Processed brush geometry: {0} verts and {1} faces'.format(len(geometry.vertices), len(geometry.faces)))
        geomlist.objects.append(geometry)
            
        return

    def processPatch(patchnode):
        shader = patchnode.getShader()

        # Tels: skip if caulk and no caulk should be exported
        if shader == 'textures/common/caulk' and int(GlobalRegistry.get('user/scripts/objExport/exportcaulk')) == 0:
            return

        # Create a new exportable object 
        geometry = Geometry('Patch{0}'.format(len(geomlist.objects)))

        mesh = patchnode.getTesselatedPatchMesh()
        
        # Remember the index of the first vertex
        firstVertex = geomlist.vertexCount
        
        for h in range(0, mesh.height):
            for w in range(0, mesh.width):
                point = mesh.vertices[mesh.width*h + w]

                # Write coordinates into the lists
                geometry.vertices.append(point.vertex)
                geometry.texcoords.append(point.texcoord)
                
                # Keep track of the exported vertices
                geomlist.vertexCount += 1

                # Starting from the second row, we're gathering the faces
                if h > 0 and w > 0:
                    # Gather the indices forming a quad
                    v1 = 1 + firstVertex + h*mesh.width + w;
                    v2 = 1 + firstVertex + (h-1)*mesh.width + w;
                    v3 = 1 + firstVertex + (h-1)*mesh.width + (w-1);
                    v4 = 1 + firstVertex + h*mesh.width + (w-1);

                    # Construct the quad
                    geometry.faces.append([v1, v4, v3, v2])
        
        print('Processed patch geometry: {0} verts and {1} faces'.format(len(geometry.vertices), len(geometry.faces)))
        geomlist.objects.append(geometry)
        
        return

    # Traversor class to visit child primitives of entities
    class nodeVisitor(dr.SceneNodeVisitor):
        def pre(self, scenenode):
            if scenenode.isBrush():
                processBrush(scenenode.getBrush())
            elif scenenode.isPatch():
                processPatch(scenenode.getPatch())

            # Traverse all child nodes, regardless of type
            return 1

    class SelectionWalker(dr.SelectionVisitor):
        def visit(self, scenenode):
            if scenenode.isBrush():
                processBrush(scenenode.getBrush())
            elif scenenode.isPatch():
                processPatch(scenenode.getPatch())
            elif scenenode.isEntity():
                # greebo: Found an entity, this could be a func_static or similar
                # Traverse children of this entity using a new walker
                nodewalker = nodeVisitor()
                scenenode.traverse(nodewalker)
            else:
                print('WARNING: unsupported node type selected. Skipping: ' + scenenode.getNodeType())

    # Dialog
    dialog = GlobalDialogManager.createDialog(script + ' v' + version)

    # Add an entry box and remember the handle
    fileHandle = dialog.addEntryBox("Filename:")
    dialog.setElementValue(fileHandle, GlobalRegistry.get('user/scripts/objExport/recentFilename'))

    # Add an entry box and remember the handle
    pathHandle = dialog.addPathEntry("Save path:", True)
    dialog.setElementValue(pathHandle, GlobalRegistry.get('user/scripts/objExport/recentPath'))

    # Add a checkbox
    centerObjectsHandle = dialog.addCheckbox("Center objects at 0,0,0 origin")
    dialog.setElementValue(centerObjectsHandle, GlobalRegistry.get('user/scripts/objExport/centerObjects'))

    # Add another checkbox
    exportCaulkHandle = dialog.addCheckbox("Export caulked faces")
    dialog.setElementValue(exportCaulkHandle, GlobalRegistry.get('user/scripts/objExport/exportcaulk'))

    if dialog.run() == dr.Dialog.OK:
        fullpath = dialog.getElementValue(pathHandle) + '/' + dialog.getElementValue(fileHandle)
        if not fullpath.endswith('.obj'):
            fullpath = fullpath + '.obj'

        # Save the path for later use
        GlobalRegistry.set('user/scripts/objExport/recentFilename', dialog.getElementValue(fileHandle))
        GlobalRegistry.set('user/scripts/objExport/recentPath', dialog.getElementValue(pathHandle))
        GlobalRegistry.set('user/scripts/objExport/centerObjects', dialog.getElementValue(centerObjectsHandle))
        GlobalRegistry.set('user/scripts/objExport/exportcaulk', dialog.getElementValue(exportCaulkHandle))

        try:
            file = open(fullpath, 'r')
            file.close()
            prompt = GlobalDialogManager.createMessageBox('Warning', 'The file ' + fullpath + ' already exists. Do you wish to overwrite it?', dr.Dialog.ASK)
            if prompt.run() == dr.Dialog.YES:
                overwrite = True
            else:
                overwrite = False
        except IOError:
            overwrite = True

        if overwrite:
            walker = SelectionWalker()
            GlobalSelectionSystem.foreachSelected(walker)

            # greebo: Check if we should center objects at the 0,0,0 origin
            if int(dialog.getElementValue(centerObjectsHandle)) == 1:
                # center objects at 0,0,0
                xlist = []
                ylist = []
                zlist = []
                for item in geomlist.objects:
                    for vert in item.vertices:
                        xlist.append(vert.x())
                        ylist.append(vert.y())
                        zlist.append(vert.z())
                xcenter=(max(xlist)+min(xlist))/2
                ycenter=(max(ylist)+min(ylist))/2
                zcenter=(max(zlist)+min(zlist))/2
                for item in geomlist.objects:
                    for vert in item.vertices:
                        vert -= dr.Vector3(xcenter, ycenter, zcenter)

            # This string will hold our export data
            data = str()

            for x in geomlist.objects:
                objstr = str()
            
                # Group name (g) 
                objstr = objstr + "g {0}\n\n".format(x.name)
                
                # Vertex list (v)
                for vert in x.vertices:
                    objstr = objstr + "v {0} {1} {2}\n".format(vert.x(), vert.y(), vert.z())
                
                objstr = objstr + "\n"
                    
                # Texture coord list (vt)
                for texcoord in x.texcoords:
                    objstr = objstr + "vt {0} {1}\n".format(texcoord.x(), 1-texcoord.y()) # reverse V coord
                    
                objstr = objstr + "\n"
                    
                # Face list (f)
                for faceIndices in x.faces:
                    objstr = objstr + "f"
                    for faceIndex in faceIndices:
                        objstr = objstr + " {0}/{1}".format(faceIndex, faceIndex)
                    objstr = objstr + "\n"
                
                objstr = objstr + "\n"
                data = data + objstr
                        
            # Write the compiled data to the output file
            file = open(fullpath, 'w')
            file.write(data)
            file.close()
            
            print('Done writing OBJ data to {0}'.format(fullpath))

# __executeCommand__ evaluates to true after DarkRadiant has successfully initialised
if __executeCommand__:
    execute()