doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / gameengine / Converter / BL_SkinDeformer.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_SkinDeformer.h
31  *  \ingroup bgeconv
32  */
33
34 #ifndef BL_SKINDEFORMER
35 #define BL_SKINDEFORMER
36
37 #if defined(WIN32) && !defined(FREE_WINDOWS)
38 #pragma warning (disable:4786) // get rid of stupid stl-visual compiler debug warning
39 #endif //WIN32
40
41 #include "GEN_HashedPtr.h"
42 #include "BL_MeshDeformer.h"
43 #include "BL_ArmatureObject.h"
44
45 #include "DNA_mesh_types.h"
46 #include "DNA_meshdata_types.h"
47 #include "DNA_object_types.h"
48 #include "BKE_armature.h"
49
50 #include "RAS_Deformer.h"
51
52
53 class BL_SkinDeformer : public BL_MeshDeformer  
54 {
55 public:
56 //      void SetArmatureController (BL_ArmatureController *cont);
57         virtual void Relink(GEN_Map<class GEN_HashedPtr, void*>*map);
58         void SetArmature (class BL_ArmatureObject *armobj);
59
60         BL_SkinDeformer(BL_DeformableGameObject *gameobj,
61                                         struct Object *bmeshobj, 
62                                         class RAS_MeshObject *mesh,
63                                         BL_ArmatureObject* arma = NULL);
64
65         /* this second constructor is needed for making a mesh deformable on the fly. */
66         BL_SkinDeformer(BL_DeformableGameObject *gameobj,
67                                         struct Object *bmeshobj_old,
68                                         struct Object *bmeshobj_new,
69                                         class RAS_MeshObject *mesh,
70                                         bool release_object,
71                                         bool recalc_normal,
72                                         BL_ArmatureObject* arma = NULL);
73
74         virtual RAS_Deformer *GetReplica();
75         virtual void ProcessReplica();
76
77         virtual ~BL_SkinDeformer();
78         bool Update (void);
79         bool UpdateInternal (bool shape_applied);
80         bool Apply (class RAS_IPolyMaterial *polymat);
81         bool UpdateBuckets(void) 
82         {
83                 // update the deformer and all the mesh slots; Apply() does it well, so just call it.
84                 return Apply(NULL);
85         }
86         bool PoseUpdated(void)
87                 { 
88                         if (m_armobj && m_lastArmaUpdate!=m_armobj->GetLastFrame()) {
89                                 return true;
90                         }
91                         return false;
92                 }
93
94         void ForceUpdate()
95         {
96                 m_lastArmaUpdate = -1.0;
97         };
98         virtual bool ShareVertexArray()
99         {
100                 return false;
101         }
102
103 protected:
104         BL_ArmatureObject*              m_armobj;       //      Our parent object
105         float                                   m_time;
106         double                                  m_lastArmaUpdate;
107         //ListBase*                             m_defbase;
108         float                                   m_obmat[4][4];  // the reference matrix for skeleton deform
109         bool                                    m_releaseobject;
110         bool                                    m_poseApplied;
111         bool                                    m_recalcNormal;
112
113
114 #ifdef WITH_CXX_GUARDEDALLOC
115 public:
116         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:BL_SkinDeformer"); }
117         void operator delete( void *mem ) { MEM_freeN(mem); }
118 #endif
119 };
120
121 #endif
122