doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Converter / BL_MeshDeformer.h
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 BL_MeshDeformer.h
31  *  \ingroup bgeconv
32  */
33
34 #ifndef BL_MESHDEFORMER
35 #define BL_MESHDEFORMER
36
37 #include "RAS_Deformer.h"
38 #include "DNA_object_types.h"
39 #include "DNA_key_types.h"
40 #include "MT_Point3.h"
41 #include <stdlib.h>
42
43 #if defined(WIN32) && !defined(FREE_WINDOWS)
44 #pragma warning (disable:4786) // get rid of stupid stl-visual compiler debug warning
45 #endif //WIN32
46
47 class BL_DeformableGameObject;
48
49 class BL_MeshDeformer : public RAS_Deformer
50 {
51 public:
52         void VerifyStorage();
53         void RecalcNormals();
54         virtual void Relink(GEN_Map<class GEN_HashedPtr, void*>*map);
55         BL_MeshDeformer(BL_DeformableGameObject *gameobj,
56                                         struct Object* obj,
57                                         class RAS_MeshObject *meshobj ):
58                 m_pMeshObject(meshobj),
59                 m_bmesh((struct Mesh*)(obj->data)),
60                 m_transverts(0),
61                 m_transnors(0),
62                 m_objMesh(obj),
63                 m_tvtot(0),
64                 m_gameobj(gameobj),
65                 m_lastDeformUpdate(-1)
66         {};
67         virtual ~BL_MeshDeformer();
68         virtual void SetSimulatedTime(double time){};
69         virtual bool Apply(class RAS_IPolyMaterial *mat);
70         virtual bool Update(void){ return false; };
71         virtual bool UpdateBuckets(void){ return false; };
72         virtual RAS_Deformer*   GetReplica(){return NULL;};
73         virtual void ProcessReplica();
74         struct Mesh* GetMesh() { return m_bmesh; };
75         virtual class RAS_MeshObject* GetRasMesh() { return (RAS_MeshObject*)m_pMeshObject; };
76         virtual float (* GetTransVerts(int *tot))[3]    {       *tot= m_tvtot; return m_transverts; }
77         //      virtual void InitDeform(double time){};
78
79 protected:
80         class RAS_MeshObject*           m_pMeshObject;
81         struct Mesh*                            m_bmesh;
82         
83         // this is so m_transverts doesn't need to be converted
84         // before deformation
85         float                                           (*m_transverts)[3];
86         float                                           (*m_transnors)[3];
87         struct Object*                          m_objMesh; 
88         // --
89         int                                                     m_tvtot;
90         BL_DeformableGameObject*        m_gameobj;
91         double                                          m_lastDeformUpdate;
92
93
94 #ifdef WITH_CXX_GUARDEDALLOC
95 public:
96         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:BL_MeshDeformer"); }
97         void operator delete( void *mem ) { MEM_freeN(mem); }
98 #endif
99 };
100
101 #endif
102