Filling in branch from trunk
[blender.git] / source / gameengine / Rasterizer / RAS_MaterialBucket.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32 #ifndef __RAS_MATERIALBUCKET
33 #define __RAS_MATERIALBUCKET
34
35 #include "RAS_TexVert.h"
36 #include "GEN_Map.h"
37 #include "STR_HashedString.h"
38
39 #include "MT_Transform.h"
40 #include "RAS_IPolygonMaterial.h"
41 #include "RAS_Deformer.h"       // __NLA
42 #include <vector>
43 #include <map>
44 #include <set>
45 using namespace std;
46
47 typedef vector<unsigned short> KX_IndexArray;
48 typedef vector<RAS_TexVert> KX_VertexArray;
49 typedef vector< KX_VertexArray* >  vecVertexArray;
50 typedef vector< KX_IndexArray* > vecIndexArrays;
51
52 /**
53  * KX_VertexIndex
54  */
55 struct KX_VertexIndex {
56 public:
57         KX_VertexIndex(int size);
58         void    SetIndex(short loc,unsigned int index);
59         
60         // The vertex array
61         short   m_vtxarray;
62         // An index into the vertex array for up to 4 verticies
63         unsigned short  m_indexarray[4];
64         short   m_size;
65 };
66
67 /**
68  * KX_ListSlot.
69  */
70 class KX_ListSlot
71 {
72 public:
73         KX_ListSlot(){}
74         virtual ~KX_ListSlot(){}
75
76         virtual void SetModified(bool mod)=0;
77 };
78
79 /**
80  * KX_MeshSlot.
81  */
82 class KX_MeshSlot
83 {
84 public:
85         void*                                           m_clientObj;
86         RAS_Deformer*                           m_pDeformer;    //      __NLA
87         double*                                         m_OpenGLMatrix;
88         class RAS_MeshObject*           m_mesh;
89         mutable bool                            m_bVisible; // for visibility
90         mutable bool                            m_bObjectColor;
91         mutable MT_Vector4                      m_RGBAcolor;
92         mutable KX_ListSlot*            m_DisplayList; // for lists
93         KX_MeshSlot() :
94                 m_pDeformer(NULL), 
95                 m_bVisible(true),
96                 m_DisplayList(0)
97         {
98         }
99         ~KX_MeshSlot(){}
100         bool                                    Less(const KX_MeshSlot& lhs) const;
101 };
102
103
104 inline bool operator <( const KX_MeshSlot& rhs,const KX_MeshSlot& lhs)
105 {
106         return ( rhs.Less(lhs));
107 }
108
109 /**
110  * Contains a list of meshs with the same material properties.
111  */
112 class RAS_MaterialBucket
113 {
114 public:
115         typedef std::set<KX_MeshSlot> T_MeshSlotList;
116         
117         RAS_MaterialBucket(RAS_IPolyMaterial* mat);
118         virtual ~RAS_MaterialBucket() {}
119         
120         void    Render(const MT_Transform& cameratrans,
121                                            class RAS_IRasterizer* rasty,
122                                            class RAS_IRenderTools* rendertools);
123         
124         void    SchedulePolygons(int drawingmode);
125         void    ClearScheduledPolygons();
126         
127         RAS_IPolyMaterial*              GetPolyMaterial() const;
128         bool    IsTransparant() const;
129                 
130         static void     StartFrame();
131         static void EndFrame();
132
133         void    SetMeshSlot(KX_MeshSlot& ms);
134         void    RemoveMeshSlot(KX_MeshSlot& ms);
135         void    MarkVisibleMeshSlot(KX_MeshSlot& ms,
136                                                                 bool visible,
137                                                                 bool color,
138                                                                 const MT_Vector4& rgbavec);
139
140         void RenderMeshSlot(const MT_Transform& cameratrans, RAS_IRasterizer* rasty,
141                 RAS_IRenderTools* rendertools, const KX_MeshSlot &ms, int drawmode);
142         bool ActivateMaterial(const MT_Transform& cameratrans, RAS_IRasterizer* rasty,
143                 RAS_IRenderTools *rendertools, int &drawmode);
144         
145         unsigned int NumMeshSlots();
146         T_MeshSlotList::iterator msBegin();
147         T_MeshSlotList::iterator msEnd();
148
149         struct less
150         {
151                 bool operator()(const RAS_MaterialBucket* x, const RAS_MaterialBucket* y) const 
152                 { 
153                         return *x->GetPolyMaterial() < *y->GetPolyMaterial(); 
154                 }
155         };
156         
157         typedef set<RAS_MaterialBucket*, less> Set;
158 private:
159         
160         T_MeshSlotList                          m_meshSlots;
161         bool                                            m_bScheduled;
162         bool                                            m_bModified;
163         RAS_IPolyMaterial*                      m_material;
164         double*                                         m_pOGLMatrix;
165         
166 };
167
168 #endif //__KX_BUCKET
169