migrated NDOF code from soc-2010-merwin, SpaceNavigator now works on Mac blender
[blender.git] / source / gameengine / Rasterizer / RAS_Deformer.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 RAS_Deformer.h
31  *  \ingroup bgerast
32  */
33
34 #ifndef RAS_DEFORMER
35 #define RAS_DEFORMER
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 <stdlib.h>
42 #include "CTR_Map.h"
43
44 #ifdef WITH_CXX_GUARDEDALLOC
45 #include "MEM_guardedalloc.h"
46 #endif
47
48 struct DerivedMesh;
49 class RAS_MeshObject;
50
51 class RAS_Deformer
52 {
53 public:
54         RAS_Deformer() : m_pMesh(NULL), m_bDynamic(false) {};
55         virtual ~RAS_Deformer(){};
56         virtual void Relink(CTR_Map<class CTR_HashedPtr, void*>*map)=0;
57         virtual bool Apply(class RAS_IPolyMaterial *polymat)=0;
58         virtual bool Update(void)=0;
59         virtual bool UpdateBuckets(void)=0;
60         virtual RAS_Deformer *GetReplica()=0;
61         virtual void ProcessReplica()=0;
62         virtual bool SkipVertexTransform()
63         {
64                 return false;
65         }
66         virtual bool ShareVertexArray()
67         {
68                 return true;
69         }
70         virtual bool UseVertexArray()
71         {
72                 return true;
73         }
74         // true when deformer produces varying vertex (shape or armature)
75         bool IsDynamic()
76         {
77                 return m_bDynamic;
78         }
79         virtual struct DerivedMesh* GetFinalMesh()
80         {
81                 return NULL;
82         }
83         virtual struct DerivedMesh* GetPhysicsMesh()
84         {
85                 return NULL;
86         }
87         virtual class RAS_MeshObject* GetRasMesh()
88         {
89                 /* m_pMesh does not seem to be being used?? */
90                 return NULL;
91         }
92         virtual float (* GetTransVerts(int *tot))[3]    {       *tot= 0; return NULL; }
93
94 protected:
95         class RAS_MeshObject    *m_pMesh;
96         bool  m_bDynamic;       
97
98 #ifdef WITH_CXX_GUARDEDALLOC
99 public:
100         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:RAS_Deformer"); }
101         void operator delete( void *mem ) { MEM_freeN(mem); }
102 #endif
103 };
104
105 #endif
106