* Merging trunk up to r38981.
[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_anim_types.h"
48 #include "DNA_armature_types.h"
49 #include "DNA_action_types.h"
50 #include "DNA_key_types.h"
51 #include "DNA_mesh_types.h"
52 #include "DNA_meshdata_types.h"
53 #include "BKE_armature.h"
54 #include "BKE_action.h"
55 #include "BKE_key.h"
56 #include "BKE_ipo.h"
57 #include "MT_Point3.h"
58
59 extern "C"{
60         #include "BKE_lattice.h"
61         #include "BKE_animsys.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                                         m_useShapeDrivers(false)
78 {
79         m_key = m_bmesh->key;
80         m_bmesh->key = copy_key(m_key);
81 };
82
83 /* this second constructor is needed for making a mesh deformable on the fly. */
84 BL_ShapeDeformer::BL_ShapeDeformer(BL_DeformableGameObject *gameobj,
85                                 Object *bmeshobj_old,
86                                 Object *bmeshobj_new,
87                                 RAS_MeshObject *mesh,
88                                 bool release_object,
89                                 bool recalc_normal,
90                                 BL_ArmatureObject* arma)
91                                 :
92                                         BL_SkinDeformer(gameobj, bmeshobj_old, bmeshobj_new, mesh, release_object, recalc_normal, arma),
93                                         m_lastShapeUpdate(-1),
94                                         m_useShapeDrivers(false)
95 {
96         m_key = m_bmesh->key;
97         m_bmesh->key = copy_key(m_key);
98 };
99
100 BL_ShapeDeformer::~BL_ShapeDeformer()
101 {
102         if (m_key && m_bmesh->key)
103         {
104                 free_key(m_bmesh->key);
105                 m_bmesh->key = m_key;
106         }
107 };
108
109 RAS_Deformer *BL_ShapeDeformer::GetReplica()
110 {
111         BL_ShapeDeformer *result;
112
113         result = new BL_ShapeDeformer(*this);
114         result->ProcessReplica();
115         return result;
116 }
117
118 void BL_ShapeDeformer::ProcessReplica()
119 {
120         BL_SkinDeformer::ProcessReplica();
121         m_lastShapeUpdate = -1;
122 }
123
124 bool BL_ShapeDeformer::LoadShapeDrivers(Object* arma)
125 {
126         // This used to check if we had drivers from this armature,
127         // now we just assume we want to use shape drivers
128         // and let the animsys handle things.
129         m_useShapeDrivers = true;
130
131         return true;
132 }
133
134 bool BL_ShapeDeformer::ExecuteShapeDrivers(void)
135 {
136         if (m_useShapeDrivers && PoseUpdated()) {
137                 // the shape drivers use the bone matrix as input. Must 
138                 // update the matrix now
139                 m_armobj->ApplyPose();
140
141                 // We don't need an actual time, just use 0
142                 BKE_animsys_evaluate_animdata(NULL, &GetKey()->id, GetKey()->adt, 0.f, ADT_RECALC_DRIVERS);
143
144                 ForceUpdate();
145                 m_armobj->RestorePose();
146                 m_bDynamic = true;
147                 return true;
148         }
149         return false;
150 }
151
152 bool BL_ShapeDeformer::Update(void)
153 {
154         bool bShapeUpdate = false;
155         bool bSkinUpdate = false;
156
157         ExecuteShapeDrivers();
158
159         /* See if the object shape has changed */
160         if (m_lastShapeUpdate != m_gameobj->GetLastFrame()) {
161                 /* the key coefficient have been set already, we just need to blend the keys */
162                 Object* blendobj = m_gameobj->GetBlendObject();
163                 
164                 // make sure the vertex weight cache is in line with this object
165                 m_pMeshObject->CheckWeightCache(blendobj);
166
167                 /* we will blend the key directly in m_transverts array: it is used by armature as the start position */
168                 /* m_bmesh->key can be NULL in case of Modifier deformer */
169                 if (m_bmesh->key) {
170                         /* store verts locally */
171                         VerifyStorage();
172
173                         do_rel_key(0, m_bmesh->totvert, m_bmesh->totvert, (char *)(float *)m_transverts, m_bmesh->key, NULL, 0); /* last arg is ignored */
174                         m_bDynamic = true;
175                 }
176
177                 // Don't release the weight array as in Blender, it will most likely be reusable on next frame 
178                 // The weight array are ultimately deleted when the skin mesh is destroyed
179                    
180                 /* Update the current frame */
181                 m_lastShapeUpdate=m_gameobj->GetLastFrame();
182
183                 // As we have changed, the mesh, the skin deformer must update as well.
184                 // This will force the update
185                 BL_SkinDeformer::ForceUpdate();
186                 bShapeUpdate = true;
187         }
188         // check for armature deform
189         bSkinUpdate = BL_SkinDeformer::UpdateInternal(bShapeUpdate && m_bDynamic);
190
191         // non dynamic deformer = Modifer without armature and shape keys, no need to create storage
192         if (!bSkinUpdate && bShapeUpdate && m_bDynamic) {
193                 // this means that there is no armature, we still need to 
194                 // update the normal (was not done after shape key calculation)
195
196 #ifdef __NLA_DEFNORMALS
197                 if (m_recalcNormal)
198                         RecalcNormals();
199 #endif
200                 bSkinUpdate = true;
201         }
202         return bSkinUpdate;
203 }
204
205 Key *BL_ShapeDeformer::GetKey()
206 {
207         return m_bmesh->key;
208 }
209
210 void BL_ShapeDeformer::SetKey(Key *key)
211 {
212         m_bmesh->key = key;
213 }