Patch to change license to GPL only, from GSR.
[blender.git] / source / gameengine / Rasterizer / RAS_MaterialBucket.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #ifndef __RAS_MATERIALBUCKET
30 #define __RAS_MATERIALBUCKET
31
32 #include "RAS_TexVert.h"
33 #include "GEN_Map.h"
34 #include "STR_HashedString.h"
35
36 #include "MT_Transform.h"
37 #include "RAS_IPolygonMaterial.h"
38 #include "RAS_Deformer.h"       // __NLA
39 #include <vector>
40 #include <map>
41 #include <set>
42 using namespace std;
43
44 typedef vector<unsigned short> KX_IndexArray;
45 typedef vector<RAS_TexVert> KX_VertexArray;
46 typedef vector< KX_VertexArray* >  vecVertexArray;
47 typedef vector< KX_IndexArray* > vecIndexArrays;
48
49 /**
50  * KX_VertexIndex
51  */
52 struct KX_VertexIndex {
53 public:
54         KX_VertexIndex(int size);
55         void    SetIndex(short loc,unsigned int index);
56         
57         // The vertex array
58         short   m_vtxarray;
59         // An index into the vertex array for up to 4 verticies
60         unsigned short  m_indexarray[4];
61         short   m_size;
62 };
63
64 /**
65  * KX_ListSlot.
66  */
67 class KX_ListSlot
68 {
69 public:
70         KX_ListSlot(){}
71         virtual ~KX_ListSlot(){}
72
73         virtual void SetModified(bool mod)=0;
74 };
75
76 /**
77  * KX_MeshSlot.
78  */
79 class KX_MeshSlot
80 {
81 public:
82         void*                                           m_clientObj;
83         RAS_Deformer*                           m_pDeformer;    //      __NLA
84         double*                                         m_OpenGLMatrix;
85         class RAS_MeshObject*           m_mesh;
86         mutable bool                            m_bVisible; // for visibility
87         mutable bool                            m_bObjectColor;
88         mutable MT_Vector4                      m_RGBAcolor;
89         mutable KX_ListSlot*            m_DisplayList; // for lists
90         KX_MeshSlot() :
91                 m_pDeformer(NULL), 
92                 m_bVisible(true),
93                 m_DisplayList(0)
94         {
95         }
96         ~KX_MeshSlot(){}
97         bool                                    Less(const KX_MeshSlot& lhs) const;
98 };
99
100
101 inline bool operator <( const KX_MeshSlot& rhs,const KX_MeshSlot& lhs)
102 {
103         return ( rhs.Less(lhs));
104 }
105
106 /**
107  * Contains a list of meshs with the same material properties.
108  */
109 class RAS_MaterialBucket
110 {
111 public:
112         typedef std::set<KX_MeshSlot> T_MeshSlotList;
113         
114         RAS_MaterialBucket(RAS_IPolyMaterial* mat);
115         virtual ~RAS_MaterialBucket() {}
116         
117         void    Render(const MT_Transform& cameratrans,
118                                            class RAS_IRasterizer* rasty,
119                                            class RAS_IRenderTools* rendertools);
120         
121         void    SchedulePolygons(int drawingmode);
122         void    ClearScheduledPolygons();
123         
124         RAS_IPolyMaterial*              GetPolyMaterial() const;
125         bool    IsTransparant() const;
126                 
127         static void     StartFrame();
128         static void EndFrame();
129
130         void    SetMeshSlot(KX_MeshSlot& ms);
131         void    RemoveMeshSlot(KX_MeshSlot& ms);
132         void    MarkVisibleMeshSlot(KX_MeshSlot& ms,
133                                                                 bool visible,
134                                                                 bool color,
135                                                                 const MT_Vector4& rgbavec);
136
137         void RenderMeshSlot(const MT_Transform& cameratrans, RAS_IRasterizer* rasty,
138                 RAS_IRenderTools* rendertools, const KX_MeshSlot &ms, int drawmode);
139         bool ActivateMaterial(const MT_Transform& cameratrans, RAS_IRasterizer* rasty,
140                 RAS_IRenderTools *rendertools, int &drawmode);
141         
142         unsigned int NumMeshSlots();
143         T_MeshSlotList::iterator msBegin();
144         T_MeshSlotList::iterator msEnd();
145
146         struct less
147         {
148                 bool operator()(const RAS_MaterialBucket* x, const RAS_MaterialBucket* y) const 
149                 { 
150                         return *x->GetPolyMaterial() < *y->GetPolyMaterial(); 
151                 }
152         };
153         
154         typedef set<RAS_MaterialBucket*, less> Set;
155 private:
156         
157         T_MeshSlotList                          m_meshSlots;
158         bool                                            m_bScheduled;
159         bool                                            m_bModified;
160         RAS_IPolyMaterial*                      m_material;
161         double*                                         m_pOGLMatrix;
162         
163 };
164
165 #endif //__KX_BUCKET
166