Bugfixing and modification to ensure functionality when called from UI. Related to...
[blender.git] / source / gameengine / Converter / BL_ShapeDeformer.cpp
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file gameengine/Converter/BL_ShapeDeformer.cpp
31  *  \ingroup bgeconv
32  */
33
34
35 #if defined(WIN32) && !defined(FREE_WINDOWS)
36 #pragma warning (disable : 4786)
37 #endif //WIN32
38
39 #include "MEM_guardedalloc.h"
40 #include "BL_ShapeDeformer.h"
41 #include "CTR_Map.h"
42 #include "STR_HashedString.h"
43 #include "RAS_IPolygonMaterial.h"
44 #include "RAS_MeshObject.h"
45
46 //#include "BL_ArmatureController.h"
47 #include "DNA_armature_types.h"
48 #include "DNA_action_types.h"
49 #include "DNA_key_types.h"
50 #include "DNA_mesh_types.h"
51 #include "DNA_meshdata_types.h"
52 #include "DNA_ipo_types.h"
53 #include "DNA_curve_types.h"
54 #include "BKE_armature.h"
55 #include "BKE_action.h"
56 #include "BKE_key.h"
57 #include "BKE_ipo.h"
58 #include "MT_Point3.h"
59
60 extern "C"{
61         #include "BKE_lattice.h"
62 }
63  
64
65 #include "BLI_blenlib.h"
66 #include "BLI_math.h"
67
68 #define __NLA_DEFNORMALS
69 //#undef __NLA_DEFNORMALS
70
71 BL_ShapeDeformer::BL_ShapeDeformer(BL_DeformableGameObject *gameobj,
72                     Object *bmeshobj,
73                     RAS_MeshObject *mesh)
74                                 :       
75                                         BL_SkinDeformer(gameobj,bmeshobj, mesh),
76                                         m_lastShapeUpdate(-1)
77 {
78         m_key = m_bmesh->key;
79         m_bmesh->key = copy_key(m_key);
80 };
81
82 /* this second constructor is needed for making a mesh deformable on the fly. */
83 BL_ShapeDeformer::BL_ShapeDeformer(BL_DeformableGameObject *gameobj,
84                                 Object *bmeshobj_old,
85                                 Object *bmeshobj_new,
86                                 RAS_MeshObject *mesh,
87                                 bool release_object,
88                                 bool recalc_normal,
89                                 BL_ArmatureObject* arma)
90                                 :
91                                         BL_SkinDeformer(gameobj, bmeshobj_old, bmeshobj_new, mesh, release_object, recalc_normal, arma),
92                                         m_lastShapeUpdate(-1)
93 {
94         m_key = m_bmesh->key;
95         m_bmesh->key = copy_key(m_key);
96 };
97
98 BL_ShapeDeformer::~BL_ShapeDeformer()
99 {
100         if (m_key && m_bmesh->key)
101         {
102                 free_key(m_bmesh->key);
103                 m_bmesh->key = m_key;
104         }
105 };
106
107 RAS_Deformer *BL_ShapeDeformer::GetReplica()
108 {
109         BL_ShapeDeformer *result;
110
111         result = new BL_ShapeDeformer(*this);
112         result->ProcessReplica();
113         return result;
114 }
115
116 void BL_ShapeDeformer::ProcessReplica()
117 {
118         BL_SkinDeformer::ProcessReplica();
119         m_lastShapeUpdate = -1;
120 }
121
122 bool BL_ShapeDeformer::LoadShapeDrivers(Object* arma)
123 {
124         IpoCurve *icu;
125
126         m_shapeDrivers.clear();
127         // check if this mesh has armature driven shape keys
128         if (m_bmesh->key && m_bmesh->key->ipo) {
129                 for(icu= (IpoCurve*)m_bmesh->key->ipo->curve.first; icu; icu= (IpoCurve*)icu->next) {
130                         if(icu->driver && 
131                                 (icu->flag & IPO_MUTE) == 0 &&
132                                 icu->driver->type == IPO_DRIVER_TYPE_NORMAL &&
133                                 icu->driver->ob == arma &&
134                                 icu->driver->blocktype == ID_AR) {
135                                 // this shape key ipo curve has a driver on the parent armature
136                                 // record this curve in the shape deformer so that the corresponding
137                                 m_shapeDrivers.push_back(icu);
138                         }
139                 }
140         }
141         return !m_shapeDrivers.empty();
142 }
143
144 bool BL_ShapeDeformer::ExecuteShapeDrivers(void)
145 {
146         if (!m_shapeDrivers.empty() && PoseUpdated()) {
147                 vector<IpoCurve*>::iterator it;
148 //              void *poin;
149 //              int type;
150
151                 // the shape drivers use the bone matrix as input. Must 
152                 // update the matrix now
153                 m_armobj->ApplyPose();
154
155                 for (it=m_shapeDrivers.begin(); it!=m_shapeDrivers.end(); it++) {
156                         // no need to set a specific time: this curve has a driver
157                         // XXX IpoCurve *icu = *it;
158                         //calc_icu(icu, 1.0f);
159                         //poin = get_ipo_poin((ID*)m_bmesh->key, icu, &type);
160                         //if (poin) 
161                         //      write_ipo_poin(poin, type, icu->curval);
162                 }
163
164                 ForceUpdate();
165                 m_armobj->RestorePose();
166                 m_bDynamic = true;
167                 return true;
168         }
169         return false;
170 }
171
172 bool BL_ShapeDeformer::Update(void)
173 {
174         bool bShapeUpdate = false;
175         bool bSkinUpdate = false;
176
177         ExecuteShapeDrivers();
178
179         /* See if the object shape has changed */
180         if (m_lastShapeUpdate != m_gameobj->GetLastFrame()) {
181                 /* the key coefficient have been set already, we just need to blend the keys */
182                 Object* blendobj = m_gameobj->GetBlendObject();
183                 
184                 // make sure the vertex weight cache is in line with this object
185                 m_pMeshObject->CheckWeightCache(blendobj);
186
187                 /* we will blend the key directly in m_transverts array: it is used by armature as the start position */
188                 /* m_bmesh->key can be NULL in case of Modifier deformer */
189                 if (m_bmesh->key) {
190                         /* store verts locally */
191                         VerifyStorage();
192
193                         do_rel_key(0, m_bmesh->totvert, m_bmesh->totvert, (char *)(float *)m_transverts, m_bmesh->key, NULL, 0); /* last arg is ignored */
194                         m_bDynamic = true;
195                 }
196
197                 // Don't release the weight array as in Blender, it will most likely be reusable on next frame 
198                 // The weight array are ultimately deleted when the skin mesh is destroyed
199                    
200                 /* Update the current frame */
201                 m_lastShapeUpdate=m_gameobj->GetLastFrame();
202
203                 // As we have changed, the mesh, the skin deformer must update as well.
204                 // This will force the update
205                 BL_SkinDeformer::ForceUpdate();
206                 bShapeUpdate = true;
207         }
208         // check for armature deform
209         bSkinUpdate = BL_SkinDeformer::UpdateInternal(bShapeUpdate && m_bDynamic);
210
211         // non dynamic deformer = Modifer without armature and shape keys, no need to create storage
212         if (!bSkinUpdate && bShapeUpdate && m_bDynamic) {
213                 // this means that there is no armature, we still need to 
214                 // update the normal (was not done after shape key calculation)
215
216 #ifdef __NLA_DEFNORMALS
217                 if (m_recalcNormal)
218                         RecalcNormals();
219 #endif
220                 bSkinUpdate = true;
221         }
222         return bSkinUpdate;
223 }
224
225 Key *BL_ShapeDeformer::GetKey()
226 {
227         return m_bmesh->key;
228 }
229
230 void BL_ShapeDeformer::SetKey(Key *key)
231 {
232         m_bmesh->key = key;
233 }