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