Cleanup: name macros w/ matching BEGIN/END
[blender.git] / source / gameengine / Converter / BL_ShapeDeformer.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/Converter/BL_ShapeDeformer.cpp
29  *  \ingroup bgeconv
30  */
31
32 #ifdef _MSC_VER
33 #  pragma warning (disable:4786)
34 #endif
35
36 #include "MEM_guardedalloc.h"
37 #include "BL_ShapeDeformer.h"
38 #include "CTR_Map.h"
39 #include "STR_HashedString.h"
40 #include "RAS_IPolygonMaterial.h"
41 #include "RAS_MeshObject.h"
42
43 #include "DNA_anim_types.h"
44 #include "DNA_armature_types.h"
45 #include "DNA_action_types.h"
46 #include "DNA_key_types.h"
47 #include "DNA_mesh_types.h"
48 #include "DNA_meshdata_types.h"
49 #include "BKE_armature.h"
50 #include "BKE_action.h"
51 #include "BKE_global.h"
52 #include "BKE_main.h"
53 #include "BKE_key.h"
54 #include "BKE_fcurve.h"
55 #include "BKE_ipo.h"
56 #include "BKE_library.h"
57 #include "MT_Point3.h"
58
59 extern "C"{
60         #include "BKE_lattice.h"
61         #include "BKE_animsys.h"
62 }
63
64 #include "BLI_blenlib.h"
65 #include "BLI_math.h"
66
67 #define __NLA_DEFNORMALS
68 //#undef __NLA_DEFNORMALS
69
70 BL_ShapeDeformer::BL_ShapeDeformer(BL_DeformableGameObject *gameobj,
71                                    Object *bmeshobj,
72                                    RAS_MeshObject *mesh)
73     :
74       BL_SkinDeformer(gameobj,bmeshobj, mesh),
75       m_useShapeDrivers(false),
76       m_lastShapeUpdate(-1)
77 {
78         m_key = m_bmesh->key ? BKE_key_copy(G.main, m_bmesh->key) : NULL;
79 };
80
81 /* this second constructor is needed for making a mesh deformable on the fly. */
82 BL_ShapeDeformer::BL_ShapeDeformer(BL_DeformableGameObject *gameobj,
83                                 Object *bmeshobj_old,
84                                 Object *bmeshobj_new,
85                                 RAS_MeshObject *mesh,
86                                 bool release_object,
87                                 bool recalc_normal,
88                                 BL_ArmatureObject* arma)
89                                 :
90                                         BL_SkinDeformer(gameobj, bmeshobj_old, bmeshobj_new, mesh, release_object, recalc_normal, arma),
91                                         m_useShapeDrivers(false),
92                                         m_lastShapeUpdate(-1)
93 {
94         m_key = m_bmesh->key ? BKE_key_copy(G.main, m_bmesh->key) : NULL;
95 };
96
97 BL_ShapeDeformer::~BL_ShapeDeformer()
98 {
99         if (m_key)
100         {
101                 BKE_libblock_free(G.main, m_key);
102                 m_key = NULL;
103         }
104 };
105
106 RAS_Deformer *BL_ShapeDeformer::GetReplica()
107 {
108         BL_ShapeDeformer *result;
109
110         result = new BL_ShapeDeformer(*this);
111         result->ProcessReplica();
112         return result;
113 }
114
115 void BL_ShapeDeformer::ProcessReplica()
116 {
117         BL_SkinDeformer::ProcessReplica();
118         m_lastShapeUpdate = -1;
119
120         m_key = m_key ? BKE_key_copy(G.main, m_key) : NULL;
121 }
122
123 bool BL_ShapeDeformer::LoadShapeDrivers(KX_GameObject* parent)
124 {
125         // Only load shape drivers if we have a key
126         if (GetKey() == NULL) {
127                 m_useShapeDrivers = false;
128                 return false;
129         }
130
131         // Fix drivers since BL_ArmatureObject makes copies
132         if (parent->GetGameObjectType() == SCA_IObject::OBJ_ARMATURE && GetKey()->adt) {
133                 BL_ArmatureObject *arma = (BL_ArmatureObject*)parent;
134                 FCurve *fcu;
135
136                 for (fcu = (FCurve*)GetKey()->adt->drivers.first; fcu; fcu = (FCurve*)fcu->next) {
137
138                         DriverVar *dvar;
139                         for (dvar = (DriverVar*)fcu->driver->variables.first; dvar; dvar = (DriverVar*)dvar->next) {
140                                 DRIVER_TARGETS_USED_LOOPER_BEGIN(dvar)
141                                 {
142                                         if (dtar->id) {
143                                                 if ((Object*)dtar->id == arma->GetOrigArmatureObject())
144                                                         dtar->id = (ID*)arma->GetArmatureObject();
145                                         }
146                                 }
147                                 DRIVER_TARGETS_LOOPER_END;
148                         }
149                 }
150         }
151
152         // This used to check if we had drivers from this armature,
153         // now we just assume we want to use shape drivers
154         // and let the animsys handle things.
155         m_useShapeDrivers = true;
156
157         return true;
158 }
159
160 bool BL_ShapeDeformer::ExecuteShapeDrivers(void)
161 {
162         if (m_useShapeDrivers && PoseUpdated()) {
163                 // We don't need an actual time, just use 0
164                 BKE_animsys_evaluate_animdata(NULL, &GetKey()->id, GetKey()->adt, 0.f, ADT_RECALC_DRIVERS);
165
166                 ForceUpdate();
167                 m_bDynamic = true;
168                 return true;
169         }
170         return false;
171 }
172
173 bool BL_ShapeDeformer::Update(void)
174 {
175         bool bShapeUpdate = false;
176         bool bSkinUpdate = false;
177
178         ExecuteShapeDrivers();
179
180         /* See if the object shape has changed */
181         if (m_lastShapeUpdate != m_gameobj->GetLastFrame()) {
182                 /* the key coefficient have been set already, we just need to blend the keys */
183                 Object* blendobj = m_gameobj->GetBlendObject();
184
185                 /* we will blend the key directly in m_transverts array: it is used by armature as the start position */
186                 /* m_key can be NULL in case of Modifier deformer */
187                 if (m_key) {
188                         WeightsArrayCache cache = {0, NULL};
189                         float **per_keyblock_weights;
190
191                         /* store verts locally */
192                         VerifyStorage();
193
194                         per_keyblock_weights = BKE_keyblock_get_per_block_weights(blendobj, m_key, &cache);
195                         BKE_key_evaluate_relative(0, m_bmesh->totvert, m_bmesh->totvert, (char *)(float *)m_transverts,
196                                                   m_key, NULL, per_keyblock_weights, 0); /* last arg is ignored */
197                         BKE_keyblock_free_per_block_weights(m_key, per_keyblock_weights, &cache);
198
199                         m_bDynamic = true;
200                 }
201
202                 // Don't release the weight array as in Blender, it will most likely be reusable on next frame
203                 // The weight array are ultimately deleted when the skin mesh is destroyed
204
205                 /* Update the current frame */
206                 m_lastShapeUpdate=m_gameobj->GetLastFrame();
207
208                 // As we have changed, the mesh, the skin deformer must update as well.
209                 // This will force the update
210                 BL_SkinDeformer::ForceUpdate();
211                 bShapeUpdate = true;
212         }
213         // check for armature deform
214         bSkinUpdate = BL_SkinDeformer::UpdateInternal(bShapeUpdate && m_bDynamic);
215
216         // non dynamic deformer = Modifer without armature and shape keys, no need to create storage
217         if (!bSkinUpdate && bShapeUpdate && m_bDynamic) {
218                 // this means that there is no armature, we still need to
219                 // update the normal (was not done after shape key calculation)
220
221 #ifdef __NLA_DEFNORMALS
222                 if (m_recalcNormal)
223                         RecalcNormals();
224 #endif
225
226                 // We also need to handle transverts now (used to be in BL_SkinDeformer::Apply())
227                 UpdateTransverts();
228                 bSkinUpdate = true;
229         }
230
231         return bSkinUpdate;
232 }
233
234 Key *BL_ShapeDeformer::GetKey()
235 {
236         return m_key;
237 }