svn merge ^/trunk/blender -r43124:43160
[blender.git] / source / gameengine / Rasterizer / RAS_MeshObject.cpp
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file gameengine/Rasterizer/RAS_MeshObject.cpp
29  *  \ingroup bgerast
30  */
31
32 #include "MEM_guardedalloc.h"
33
34 #include "DNA_object_types.h"
35 #include "DNA_key_types.h"
36 #include "DNA_mesh_types.h"
37 #include "DNA_meshdata_types.h"
38
39 #include "RAS_MeshObject.h"
40 #include "RAS_IRasterizer.h"
41 #include "MT_MinMax.h"
42 #include "MT_Point3.h"
43
44 #include <algorithm>
45
46 extern "C" {
47 #       include "BKE_deform.h"
48 }
49
50 /* polygon sorting */
51
52 struct RAS_MeshObject::polygonSlot
53 {
54         float m_z;
55         int m_index[4];
56         
57         polygonSlot() {}
58
59         /* pnorm is the normal from the plane equation that the distance from is
60          * used to sort again. */
61         void get(const RAS_TexVert *vertexarray, const unsigned short *indexarray,
62                 int offset, int nvert, const MT_Vector3& pnorm)
63         {
64                 MT_Vector3 center(0, 0, 0);
65                 int i;
66
67                 for(i=0; i<nvert; i++) {
68                         m_index[i] = indexarray[offset+i];
69                         center += vertexarray[m_index[i]].getXYZ();
70                 }
71
72                 /* note we don't divide center by the number of vertices, since all
73                  * polygons have the same number of vertices, and that we leave out
74                  * the 4-th component of the plane equation since it is constant. */
75                 m_z = MT_dot(pnorm, center);
76         }
77
78         void set(unsigned short *indexarray, int offset, int nvert)
79         {
80                 int i;
81
82                 for(i=0; i<nvert; i++)
83                         indexarray[offset+i] = m_index[i];
84         }
85 };
86         
87 struct RAS_MeshObject::backtofront
88 {
89         bool operator()(const polygonSlot &a, const polygonSlot &b) const
90         {
91                 return a.m_z < b.m_z;
92         }
93 };
94
95 struct RAS_MeshObject::fronttoback
96 {
97         bool operator()(const polygonSlot &a, const polygonSlot &b) const
98         {
99                 return a.m_z > b.m_z;
100         }
101 };
102
103 /* mesh object */
104
105 STR_String RAS_MeshObject::s_emptyname = "";
106
107 RAS_MeshObject::RAS_MeshObject(Mesh* mesh)
108         : m_bModified(true),
109         m_bMeshModified(true),
110         m_mesh(mesh)
111 {
112         if (m_mesh && m_mesh->key)
113         {
114                 KeyBlock *kb;
115                 int count=0;
116                 // initialize weight cache for shape objects
117                 // count how many keys in this mesh
118                 for(kb= (KeyBlock*)m_mesh->key->block.first; kb; kb= (KeyBlock*)kb->next)
119                         count++;
120                 m_cacheWeightIndex.resize(count,-1);
121         }
122 }
123
124 RAS_MeshObject::~RAS_MeshObject()
125 {
126         vector<RAS_Polygon*>::iterator it;
127
128         if (m_mesh && m_mesh->key) 
129         {
130                 KeyBlock *kb;
131                 // remove the weight cache to avoid memory leak 
132                 for(kb= (KeyBlock*)m_mesh->key->block.first; kb; kb= (KeyBlock*)kb->next) {
133                         if(kb->weights) 
134                                 MEM_freeN(kb->weights);
135                         kb->weights= NULL;
136                 }
137         }
138
139         for(it=m_Polygons.begin(); it!=m_Polygons.end(); it++)
140                 delete (*it);
141
142         m_sharedvertex_map.clear();
143         m_Polygons.clear();
144         m_materials.clear();
145 }
146
147 bool RAS_MeshObject::MeshModified()
148 {
149         return m_bMeshModified;
150 }
151
152 //unsigned int RAS_MeshObject::GetLightLayer()
153 //{
154 //      return m_lightlayer;
155 //}
156
157
158
159 int RAS_MeshObject::NumMaterials()
160 {
161         return m_materials.size();
162 }
163
164 const STR_String& RAS_MeshObject::GetMaterialName(unsigned int matid)
165
166         RAS_MeshMaterial* mmat = GetMeshMaterial(matid);
167
168         if(mmat)
169                 return mmat->m_bucket->GetPolyMaterial()->GetMaterialName();
170         
171         return s_emptyname;
172 }
173
174 RAS_MeshMaterial* RAS_MeshObject::GetMeshMaterial(unsigned int matid)
175 {
176         if (m_materials.size() > 0 && (matid < m_materials.size()))
177         {
178                 list<RAS_MeshMaterial>::iterator it = m_materials.begin();
179                 while (matid--) ++it;
180                 return &*it;
181         }
182
183         return NULL;
184 }
185
186
187
188 int RAS_MeshObject::NumPolygons()
189 {
190         return m_Polygons.size();
191 }
192
193
194
195 RAS_Polygon* RAS_MeshObject::GetPolygon(int num) const
196 {
197         return m_Polygons[num];
198 }
199
200         
201         
202
203         list<RAS_MeshMaterial>::iterator GetFirstMaterial();
204         list<RAS_MeshMaterial>::iterator GetLastMaterial();
205 list<RAS_MeshMaterial>::iterator RAS_MeshObject::GetFirstMaterial()
206 {
207         return m_materials.begin();
208 }
209
210
211
212 list<RAS_MeshMaterial>::iterator RAS_MeshObject::GetLastMaterial()
213 {
214         return m_materials.end();
215 }
216
217
218
219 void RAS_MeshObject::SetName(const char *name)
220 {
221         m_name = name;
222 }
223
224
225
226 STR_String& RAS_MeshObject::GetName()
227 {
228         return m_name;
229 }
230
231
232
233 const STR_String& RAS_MeshObject::GetTextureName(unsigned int matid)
234
235         RAS_MeshMaterial* mmat = GetMeshMaterial(matid);
236         
237         if(mmat)
238                 return mmat->m_bucket->GetPolyMaterial()->GetTextureName();
239
240         return s_emptyname;
241 }
242
243 RAS_MeshMaterial *RAS_MeshObject::GetMeshMaterial(RAS_IPolyMaterial *mat)
244 {
245         list<RAS_MeshMaterial>::iterator mit;
246
247         /* find a mesh material */
248         for(mit = m_materials.begin(); mit != m_materials.end(); mit++)
249                 if(mit->m_bucket->GetPolyMaterial() == mat)
250                         return &*mit;
251
252         return NULL;
253 }
254
255 int RAS_MeshObject::GetMaterialId(RAS_IPolyMaterial *mat)
256 {
257         list<RAS_MeshMaterial>::iterator mit;
258         int imat;
259
260         /* find a mesh material */
261         for(imat=0, mit = m_materials.begin(); mit != m_materials.end(); mit++, imat++)
262                 if(mit->m_bucket->GetPolyMaterial() == mat)
263                         return imat;
264
265         return -1;
266 }
267
268 RAS_Polygon* RAS_MeshObject::AddPolygon(RAS_MaterialBucket *bucket, int numverts)
269 {
270         RAS_MeshMaterial *mmat;
271         RAS_Polygon *poly;
272         RAS_MeshSlot *slot;
273
274         /* find a mesh material */
275         mmat = GetMeshMaterial(bucket->GetPolyMaterial());
276
277         /* none found, create a new one */
278         if(!mmat) {
279                 RAS_MeshMaterial meshmat;
280                 meshmat.m_bucket = bucket;
281                 meshmat.m_baseslot = meshmat.m_bucket->AddMesh(numverts);
282                 meshmat.m_baseslot->m_mesh = this;
283                 m_materials.push_back(meshmat);
284                 mmat = &m_materials.back();
285         }
286
287         /* add it to the bucket, this also adds new display arrays */
288         slot = mmat->m_baseslot;
289         slot->AddPolygon(numverts);
290
291         /* create a new polygon */
292         RAS_DisplayArray *darray = slot->CurrentDisplayArray();
293         poly = new RAS_Polygon(bucket, darray, numverts);
294         m_Polygons.push_back(poly);
295
296         return poly;
297 }
298
299 void RAS_MeshObject::DebugColor(unsigned int abgr)
300 {
301         /*int numpolys = NumPolygons();
302
303         for (int i=0;i<numpolys;i++) {
304                 RAS_Polygon* poly = m_polygons[i];
305                 for (int v=0;v<poly->VertexCount();v++)
306                         RAS_TexVert* vtx = poly->GetVertex(v)->setDebugRGBA(abgr);
307         }
308         */
309
310         /* m_debugcolor = abgr; */
311 }
312
313 void RAS_MeshObject::SetVertexColor(RAS_IPolyMaterial* mat,MT_Vector4 rgba)
314 {
315         RAS_MeshMaterial *mmat = GetMeshMaterial(mat);
316         RAS_MeshSlot *slot = mmat->m_baseslot;
317         RAS_MeshSlot::iterator it;
318         size_t i;
319
320         for(slot->begin(it); !slot->end(it); slot->next(it))
321                 for(i=it.startvertex; i<it.endvertex; i++)
322                         it.vertex[i].SetRGBA(rgba);
323 }
324
325 void RAS_MeshObject::AddVertex(RAS_Polygon *poly, int i,
326                                                                 const MT_Point3& xyz,
327                                                                 const MT_Point2& uv,
328                                                                 const MT_Point2& uv2,
329                                                                 const MT_Vector4& tangent,
330                                                                 const unsigned int rgba,
331                                                                 const MT_Vector3& normal,
332                                                                 bool flat,
333                                                                 int origindex)
334 {
335         RAS_TexVert texvert(xyz, uv, uv2, tangent, rgba, normal, flat, origindex);
336         RAS_MeshMaterial *mmat;
337         RAS_DisplayArray *darray;
338         RAS_MeshSlot *slot;
339         int offset;
340         
341         mmat = GetMeshMaterial(poly->GetMaterial()->GetPolyMaterial());
342         slot = mmat->m_baseslot;
343         darray = slot->CurrentDisplayArray();
344
345         { /* Shared Vertex! */
346                 /* find vertices shared between faces, with the restriction
347                  * that they exist in the same display array, and have the
348                  * same uv coordinate etc */
349                 vector<SharedVertex>& sharedmap = m_sharedvertex_map[origindex];
350                 vector<SharedVertex>::iterator it;
351
352                 for(it = sharedmap.begin(); it != sharedmap.end(); it++)
353                 {
354                         if(it->m_darray != darray)
355                                 continue;
356                         if(!it->m_darray->m_vertex[it->m_offset].closeTo(&texvert))
357                                 continue;
358
359                         /* found one, add it and we're done */
360                         if(poly->IsVisible())
361                                 slot->AddPolygonVertex(it->m_offset);
362                         poly->SetVertexOffset(i, it->m_offset);
363                         return;
364                 }
365         }
366
367         /* no shared vertex found, add a new one */
368         offset = slot->AddVertex(texvert);
369         if(poly->IsVisible())
370                 slot->AddPolygonVertex(offset);
371         poly->SetVertexOffset(i, offset);
372
373         { /* Shared Vertex! */
374                 SharedVertex shared;
375                 shared.m_darray = darray;
376                 shared.m_offset = offset;
377                 m_sharedvertex_map[origindex].push_back(shared);
378         }
379 }
380
381 int RAS_MeshObject::NumVertices(RAS_IPolyMaterial* mat)
382 {
383         RAS_MeshMaterial *mmat;
384         RAS_MeshSlot *slot;
385         RAS_MeshSlot::iterator it;
386         size_t len = 0;
387
388         mmat = GetMeshMaterial(mat);
389         slot = mmat->m_baseslot;
390         for(slot->begin(it); !slot->end(it); slot->next(it))
391                 len += it.endvertex - it.startvertex;
392         
393         return len;
394 }
395
396
397 RAS_TexVert* RAS_MeshObject::GetVertex(unsigned int matid,
398                                                                            unsigned int index)
399 {
400         RAS_MeshMaterial *mmat;
401         RAS_MeshSlot *slot;
402         RAS_MeshSlot::iterator it;
403         size_t len;
404
405         mmat = GetMeshMaterial(matid);
406
407         if(!mmat)
408                 return NULL;
409         
410         slot = mmat->m_baseslot;
411         len = 0;
412         for(slot->begin(it); !slot->end(it); slot->next(it)) {
413                 if(index >= len + it.endvertex - it.startvertex)
414                         len += it.endvertex - it.startvertex;
415                 else
416                         return &it.vertex[index - len];
417         }
418         
419         return NULL;
420 }
421
422 const float* RAS_MeshObject::GetVertexLocation(unsigned int orig_index)
423 {
424         vector<SharedVertex>& sharedmap = m_sharedvertex_map[orig_index];
425         vector<SharedVertex>::iterator it= sharedmap.begin();
426         return it->m_darray->m_vertex[it->m_offset].getXYZ();
427 }
428
429 void RAS_MeshObject::AddMeshUser(void *clientobj, SG_QList *head, RAS_Deformer* deformer)
430 {
431         list<RAS_MeshMaterial>::iterator it;
432         list<RAS_MeshMaterial>::iterator mit;
433
434         for(it = m_materials.begin();it!=m_materials.end();++it) {
435                 /* always copy from the base slot, which is never removed 
436                  * since new objects can be created with the same mesh data */
437                 if (deformer && !deformer->UseVertexArray())
438                 {
439                         // HACK! 
440                         // this deformer doesn't use vertex array => derive mesh
441                         // we must keep only the mesh slots that have unique material id
442                         // this is to match the derived mesh drawing function
443                         // Need a better solution in the future: scan the derive mesh and create vertex array
444                         RAS_IPolyMaterial* curmat = it->m_bucket->GetPolyMaterial();
445                         if (curmat->GetFlag() & RAS_BLENDERGLSL) 
446                         {
447                                 for(mit = m_materials.begin(); mit != it; ++mit)
448                                 {
449                                         RAS_IPolyMaterial* mat = mit->m_bucket->GetPolyMaterial();
450                                         if ((mat->GetFlag() & RAS_BLENDERGLSL) && 
451                                                 mat->GetMaterialIndex() == curmat->GetMaterialIndex())
452                                                 // no need to convert current mesh slot
453                                                 break;
454                                 }
455                                 if (mit != it)
456                                         continue;
457                         }
458                 }
459                 RAS_MeshSlot *ms = it->m_bucket->CopyMesh(it->m_baseslot);
460                 ms->m_clientObj = clientobj;
461                 ms->SetDeformer(deformer);
462                 it->m_slots.insert(clientobj, ms);
463                 head->QAddBack(ms);
464         }
465 }
466
467 void RAS_MeshObject::RemoveFromBuckets(void *clientobj)
468 {
469         list<RAS_MeshMaterial>::iterator it;
470         
471         for(it = m_materials.begin();it!=m_materials.end();++it) {
472                 RAS_MeshSlot **msp = it->m_slots[clientobj];
473
474                 if(!msp)
475                         continue;
476
477                 RAS_MeshSlot *ms = *msp;
478
479                 it->m_bucket->RemoveMesh(ms);
480                 it->m_slots.remove(clientobj);
481         }
482 }
483
484 //void RAS_MeshObject::Transform(const MT_Transform& trans)
485 //{
486         //m_trans.translate(MT_Vector3(0,0,1));//.operator *=(trans);
487         
488 //      for (int i=0;i<m_Polygons.size();i++)
489 //      {
490 //              m_Polygons[i]->Transform(trans);
491 //      }
492 //}
493
494
495 /*
496 void RAS_MeshObject::RelativeTransform(const MT_Vector3& vec)
497 {
498         for (int i=0;i<m_Polygons.size();i++)
499         {
500                 m_Polygons[i]->RelativeTransform(vec);
501         }
502 }
503 */
504
505 void RAS_MeshObject::SortPolygons(RAS_MeshSlot& ms, const MT_Transform &transform)
506 {
507         // Limitations: sorting is quite simple, and handles many
508         // cases wrong, partially due to polygons being sorted per
509         // bucket.
510         // 
511         // a) mixed triangles/quads are sorted wrong
512         // b) mixed materials are sorted wrong
513         // c) more than 65k faces are sorted wrong
514         // d) intersecting objects are sorted wrong
515         // e) intersecting polygons are sorted wrong
516         //
517         // a) can be solved by making all faces either triangles or quads
518         // if they need to be z-sorted. c) could be solved by allowing
519         // larger buckets, b) and d) cannot be solved easily if we want
520         // to avoid excessive state changes while drawing. e) would
521         // require splitting polygons.
522
523         RAS_MeshSlot::iterator it;
524         size_t j;
525
526         for(ms.begin(it); !ms.end(it); ms.next(it)) {
527                 unsigned int nvert = (int)it.array->m_type;
528                 unsigned int totpoly = it.totindex/nvert;
529
530                 if(totpoly <= 1)
531                         continue;
532                 if(it.array->m_type == RAS_DisplayArray::LINE)
533                         continue;
534
535                 // Extract camera Z plane...
536                 const MT_Vector3 pnorm(transform.getBasis()[2]);
537                 // unneeded: const MT_Scalar pval = transform.getOrigin()[2];
538
539                 vector<polygonSlot> slots(totpoly);
540
541                 /* get indices and z into temporary array */
542                 for(j=0; j<totpoly; j++)
543                         slots[j].get(it.vertex, it.index, j*nvert, nvert, pnorm);
544
545                 /* sort (stable_sort might be better, if flickering happens?) */
546                 std::sort(slots.begin(), slots.end(), backtofront());
547
548                 /* get indices from temporary array again */
549                 for(j=0; j<totpoly; j++)
550                         slots[j].set(it.index, j*nvert, nvert);
551         }
552 }
553
554
555 void RAS_MeshObject::SchedulePolygons(int drawingmode)
556 {
557         if (m_bModified)
558         {
559                 m_bModified = false;
560                 m_bMeshModified = true;
561         } 
562 }
563
564 static int get_def_index(Object* ob, const char* vgroup)
565 {
566         bDeformGroup *curdef;
567         int index = 0;
568
569         for (curdef = (bDeformGroup*)ob->defbase.first; curdef; curdef=(bDeformGroup*)curdef->next, index++)
570                 if (!strcmp(curdef->name, vgroup))
571                         return index;
572
573         return -1;
574 }
575
576 void RAS_MeshObject::CheckWeightCache(Object* obj)
577 {
578         KeyBlock *kb;
579         int kbindex, defindex;
580         MDeformVert *dv= NULL;
581         int totvert, i;
582         float *weights;
583
584         if (!m_mesh->key)
585                 return;
586
587         for(kbindex=0, kb= (KeyBlock*)m_mesh->key->block.first; kb; kb= (KeyBlock*)kb->next, kbindex++)
588         {
589                 // first check the cases where the weight must be cleared
590                 if (kb->vgroup[0] == 0 ||
591                         m_mesh->dvert == NULL ||
592                         (defindex = get_def_index(obj, kb->vgroup)) == -1) {
593                         if (kb->weights) {
594                                 MEM_freeN(kb->weights);
595                                 kb->weights = NULL;
596                         }
597                         m_cacheWeightIndex[kbindex] = -1;
598                 } else if (m_cacheWeightIndex[kbindex] != defindex) {
599                         // a weight array is required but the cache is not matching
600                         if (kb->weights) {
601                                 MEM_freeN(kb->weights);
602                                 kb->weights = NULL;
603                         }
604
605                         dv= m_mesh->dvert;
606                         totvert= m_mesh->totvert;
607                 
608                         weights= (float*)MEM_mallocN(totvert*sizeof(float), "weights");
609                 
610                         for (i=0; i < totvert; i++, dv++) {
611                                 weights[i]= defvert_find_weight(dv, defindex);
612                         }
613
614                         kb->weights = weights;
615                         m_cacheWeightIndex[kbindex] = defindex;
616                 }
617         }
618 }
619
620