style cleanup: comment format
[blender.git] / source / gameengine / Converter / BL_ModifierDeformer.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_ModifierDeformer.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_ModifierDeformer.h"
38 #include "CTR_Map.h"
39 #include "STR_HashedString.h"
40 #include "RAS_IPolygonMaterial.h"
41 #include "RAS_MeshObject.h"
42 #include "PHY_IGraphicController.h"
43
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 "DNA_ipo_types.h"
50 #include "DNA_curve_types.h"
51 #include "DNA_modifier_types.h"
52 #include "DNA_scene_types.h"
53 #include "BLI_utildefines.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_customdata.h"
62         #include "BKE_DerivedMesh.h"
63         #include "BKE_lattice.h"
64         #include "BKE_modifier.h"
65 }
66
67 #include "BLI_blenlib.h"
68 #include "BLI_math.h"
69
70 #define __NLA_DEFNORMALS
71 //#undef __NLA_DEFNORMALS
72
73
74 BL_ModifierDeformer::~BL_ModifierDeformer()
75 {
76         if (m_dm) {
77                 // deformedOnly is used as a user counter
78                 if (--m_dm->deformedOnly == 0) {
79                         m_dm->needsFree = 1;
80                         m_dm->release(m_dm);
81                 }
82         }
83 };
84
85 RAS_Deformer *BL_ModifierDeformer::GetReplica()
86 {
87         BL_ModifierDeformer *result;
88
89         result = new BL_ModifierDeformer(*this);
90         result->ProcessReplica();
91         return result;
92 }
93
94 void BL_ModifierDeformer::ProcessReplica()
95 {
96         /* Note! - This is not inherited from PyObjectPlus */
97         BL_ShapeDeformer::ProcessReplica();
98         if (m_dm)
99                 // by default try to reuse mesh, deformedOnly is used as a user count
100                 m_dm->deformedOnly++;
101         // this will force an update and if the mesh cannot be reused, a new one will be created
102         m_lastModifierUpdate = -1;
103 }
104
105 bool BL_ModifierDeformer::HasCompatibleDeformer(Object *ob)
106 {
107         if (!ob->modifiers.first)
108                 return false;
109         // soft body cannot use mesh modifiers
110         if ((ob->gameflag & OB_SOFT_BODY) != 0)
111                 return false;
112         ModifierData* md;
113         for (md = (ModifierData *)ob->modifiers.first; md; md = md->next) {
114                 if (modifier_dependsOnTime(md))
115                         continue;
116                 if (!(md->mode & eModifierMode_Realtime))
117                         continue;
118                 /* armature modifier are handled by SkinDeformer, not ModifierDeformer */
119                 if (md->type == eModifierType_Armature )
120                         continue;
121                 return true;
122         }
123         return false;
124 }
125
126 bool BL_ModifierDeformer::HasArmatureDeformer(Object *ob)
127 {
128         if (!ob->modifiers.first)
129                 return false;
130
131         ModifierData* md = (ModifierData*)ob->modifiers.first;
132         if (md->type == eModifierType_Armature )
133                 return true;
134
135         return false;
136 }
137
138 // return a deformed mesh that supports mapping (with a valid CD_ORIGINDEX layer)
139 struct DerivedMesh* BL_ModifierDeformer::GetPhysicsMesh()
140 {
141         /* we need to compute the deformed mesh taking into account the current
142          * shape and skin deformers, we cannot just call mesh_create_derived_physics()
143          * because that would use the m_transvers already deformed previously by BL_ModifierDeformer::Update(),
144          * so restart from scratch by forcing a full update the shape/skin deformers 
145          * (will do nothing if there is no such deformer) */
146         BL_ShapeDeformer::ForceUpdate();
147         BL_ShapeDeformer::Update();
148         // now apply the modifiers but without those that don't support mapping
149         Object* blendobj = m_gameobj->GetBlendObject();
150         /* hack: the modifiers require that the mesh is attached to the object
151          * It may not be the case here because of replace mesh actuator */
152         Mesh *oldmesh = (Mesh*)blendobj->data;
153         blendobj->data = m_bmesh;
154         DerivedMesh *dm = mesh_create_derived_physics(m_scene, blendobj, m_transverts, CD_MASK_MESH);
155         /* restore object data */
156         blendobj->data = oldmesh;
157         /* m_transverts is correct here (takes into account deform only modifiers) */
158         /* the derived mesh returned by this function must be released by the caller !!! */
159         return dm;
160 }
161
162 bool BL_ModifierDeformer::Update(void)
163 {
164         bool bShapeUpdate = BL_ShapeDeformer::Update();
165
166         if (bShapeUpdate || m_lastModifierUpdate != m_gameobj->GetLastFrame()) {
167                 // static derived mesh are not updated
168                 if (m_dm == NULL || m_bDynamic) {
169                         /* execute the modifiers */
170                         Object* blendobj = m_gameobj->GetBlendObject();
171                         /* hack: the modifiers require that the mesh is attached to the object
172                          * It may not be the case here because of replace mesh actuator */
173                         Mesh *oldmesh = (Mesh*)blendobj->data;
174                         blendobj->data = m_bmesh;
175                         /* execute the modifiers */
176                         DerivedMesh *dm = mesh_create_derived_no_virtual(m_scene, blendobj, m_transverts, CD_MASK_MESH);
177                         /* restore object data */
178                         blendobj->data = oldmesh;
179                         /* free the current derived mesh and replace, (dm should never be NULL) */
180                         if (m_dm != NULL) {
181                                 // HACK! use deformedOnly as a user counter
182                                 if (--m_dm->deformedOnly == 0) {
183                                         m_dm->needsFree = 1;
184                                         m_dm->release(m_dm);
185                                 }
186                         }
187                         m_dm = dm;
188                         // get rid of temporary data
189                         m_dm->needsFree = 0;
190                         m_dm->release(m_dm);
191                         // HACK! use deformedOnly as a user counter
192                         m_dm->deformedOnly = 1;
193                         /* update the graphic controller */
194                         PHY_IGraphicController *ctrl = m_gameobj->GetGraphicController();
195                         if (ctrl) {
196                                 float min_r[3], max_r[3];
197                                 INIT_MINMAX(min_r, max_r);
198                                 m_dm->getMinMax(m_dm, min_r, max_r);
199                                 ctrl->setLocalAabb(min_r, max_r);
200                         }
201                 }
202                 m_lastModifierUpdate=m_gameobj->GetLastFrame();
203                 bShapeUpdate = true;
204         }
205         return bShapeUpdate;
206 }
207
208 bool BL_ModifierDeformer::Apply(RAS_IPolyMaterial *mat)
209 {
210         if (!Update())
211                 return false;
212
213         // drawing is based on derived mesh, must set it in the mesh slots
214         int nmat = m_pMeshObject->NumMaterials();
215         for (int imat=0; imat<nmat; imat++) {
216                 RAS_MeshMaterial *mmat = m_pMeshObject->GetMeshMaterial(imat);
217                 RAS_MeshSlot **slot = mmat->m_slots[(void*)m_gameobj];
218                 if (!slot || !*slot)
219                         continue;
220                 (*slot)->m_pDerivedMesh = m_dm;
221         }
222         return true;
223 }