svn merge ^/trunk/blender -r41226:41227 .
[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
33 #if defined(WIN32) && !defined(FREE_WINDOWS)
34 #pragma warning (disable : 4786)
35 #endif //WIN32
36
37 #include "MEM_guardedalloc.h"
38 #include "BL_ShapeDeformer.h"
39 #include "CTR_Map.h"
40 #include "STR_HashedString.h"
41 #include "RAS_IPolygonMaterial.h"
42 #include "RAS_MeshObject.h"
43
44 //#include "BL_ArmatureController.h"
45 #include "DNA_anim_types.h"
46 #include "DNA_armature_types.h"
47 #include "DNA_action_types.h"
48 #include "DNA_key_types.h"
49 #include "DNA_mesh_types.h"
50 #include "DNA_meshdata_types.h"
51 #include "BKE_armature.h"
52 #include "BKE_action.h"
53 #include "BKE_key.h"
54 #include "BKE_ipo.h"
55 #include "MT_Point3.h"
56
57 extern "C"{
58         #include "BKE_lattice.h"
59         #include "BKE_animsys.h"
60 }
61  
62
63 #include "BLI_blenlib.h"
64 #include "BLI_math.h"
65
66 #define __NLA_DEFNORMALS
67 //#undef __NLA_DEFNORMALS
68
69 BL_ShapeDeformer::BL_ShapeDeformer(BL_DeformableGameObject *gameobj,
70                                    Object *bmeshobj,
71                                    RAS_MeshObject *mesh)
72     :
73       BL_SkinDeformer(gameobj,bmeshobj, mesh),
74       m_useShapeDrivers(false),
75       m_lastShapeUpdate(-1)
76 {
77         m_key = m_bmesh->key;
78         m_bmesh->key = copy_key(m_key);
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;
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         // This used to check if we had drivers from this armature,
125         // now we just assume we want to use shape drivers
126         // and let the animsys handle things.
127         m_useShapeDrivers = true;
128
129         return true;
130 }
131
132 bool BL_ShapeDeformer::ExecuteShapeDrivers(void)
133 {
134         if (m_useShapeDrivers && PoseUpdated()) {
135                 // the shape drivers use the bone matrix as input. Must 
136                 // update the matrix now
137                 m_armobj->ApplyPose();
138
139                 // We don't need an actual time, just use 0
140                 BKE_animsys_evaluate_animdata(NULL, &GetKey()->id, GetKey()->adt, 0.f, ADT_RECALC_DRIVERS);
141
142                 ForceUpdate();
143                 m_armobj->RestorePose();
144                 m_bDynamic = true;
145                 return true;
146         }
147         return false;
148 }
149
150 bool BL_ShapeDeformer::Update(void)
151 {
152         bool bShapeUpdate = false;
153         bool bSkinUpdate = false;
154
155         ExecuteShapeDrivers();
156
157         /* See if the object shape has changed */
158         if (m_lastShapeUpdate != m_gameobj->GetLastFrame()) {
159                 /* the key coefficient have been set already, we just need to blend the keys */
160                 Object* blendobj = m_gameobj->GetBlendObject();
161                 
162                 // make sure the vertex weight cache is in line with this object
163                 m_pMeshObject->CheckWeightCache(blendobj);
164
165                 /* we will blend the key directly in m_transverts array: it is used by armature as the start position */
166                 /* m_bmesh->key can be NULL in case of Modifier deformer */
167                 if (m_bmesh->key) {
168                         /* store verts locally */
169                         VerifyStorage();
170
171                         do_rel_key(0, m_bmesh->totvert, m_bmesh->totvert, (char *)(float *)m_transverts, m_bmesh->key, NULL, 0); /* last arg is ignored */
172                         m_bDynamic = true;
173                 }
174
175                 // Don't release the weight array as in Blender, it will most likely be reusable on next frame 
176                 // The weight array are ultimately deleted when the skin mesh is destroyed
177                    
178                 /* Update the current frame */
179                 m_lastShapeUpdate=m_gameobj->GetLastFrame();
180
181                 // As we have changed, the mesh, the skin deformer must update as well.
182                 // This will force the update
183                 BL_SkinDeformer::ForceUpdate();
184                 bShapeUpdate = true;
185         }
186         // check for armature deform
187         bSkinUpdate = BL_SkinDeformer::UpdateInternal(bShapeUpdate && m_bDynamic);
188
189         // non dynamic deformer = Modifer without armature and shape keys, no need to create storage
190         if (!bSkinUpdate && bShapeUpdate && m_bDynamic) {
191                 // this means that there is no armature, we still need to 
192                 // update the normal (was not done after shape key calculation)
193
194 #ifdef __NLA_DEFNORMALS
195                 if (m_recalcNormal)
196                         RecalcNormals();
197 #endif
198                 bSkinUpdate = true;
199         }
200         return bSkinUpdate;
201 }
202
203 Key *BL_ShapeDeformer::GetKey()
204 {
205         return m_bmesh->key;
206 }
207
208 void BL_ShapeDeformer::SetKey(Key *key)
209 {
210         m_bmesh->key = key;
211 }