Initial revision
[blender.git] / source / gameengine / Rasterizer / RAS_IPolygonMaterial.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_IPOLYGONMATERIAL
33 #define __RAS_IPOLYGONMATERIAL
34
35 #include "STR_HashedString.h"
36
37
38 /**
39  * Polygon Material on which the material buckets are sorted
40  *
41  */
42 #include "MT_Vector3.h"
43 #include "STR_HashedString.h"
44
45 class RAS_IRasterizer;
46
47 class RAS_IPolyMaterial
48 {
49         //todo: remove these variables from this interface/protocol class
50 protected:
51         STR_HashedString    m_texturename;
52         STR_String          m_materialname; //also needed for touchsensor  
53         int                                     m_tile;
54         int                                     m_tilexrep,m_tileyrep;
55         int                                     m_drawingmode;  // tface->mode
56         int                                     m_transparant;
57         int                                     m_lightlayer;
58         bool                            m_bIsTriangle;
59         
60 public:
61
62         MT_Vector3                      m_diffuse;
63         float                           m_shininess;
64         MT_Vector3                      m_specular;
65         float                           m_specularity;
66         
67         /** Used to store caching information for materials. */
68         typedef void* TCachingInfo;
69
70         // care! these are taken from blender polygonflags, see file DNA_mesh_types.h for #define TF_BILLBOARD etc.
71         enum MaterialFlags
72         {
73                 BILLBOARD_SCREENALIGNED = 256,
74                 BILLBOARD_AXISALIGNED = 4096,
75                 SHADOW                            =8192
76         };
77
78         RAS_IPolyMaterial(const STR_String& texname,
79                                           bool ba,
80                                           const STR_String& matname,
81                                           int tile,
82                                           int tilexrep,
83                                           int tileyrep,
84                                           int mode,
85                                           int transparant,
86                                           int lightlayer,
87                                           bool bIsTriangle,
88                                           void* clientobject);
89         virtual ~RAS_IPolyMaterial() {};
90  
91         /**
92          * Returns the caching information for this material,
93          * This can be used to speed up the rasterizing process.
94          * @return The caching information.
95          */
96         virtual TCachingInfo GetCachingInfo(void) const { return 0; }
97
98         /**
99          * Activates the material in the rasterizer.
100          * On entry, the cachingInfo contains info about the last activated material.
101          * On exit, the cachingInfo should contain updated info about this material.
102          * @param rasty                 The rasterizer in which the material should be active.
103          * @param cachingInfo   The information about the material used to speed up rasterizing.
104          */
105         virtual void Activate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const {}
106
107         bool                            Equals(const RAS_IPolyMaterial& lhs) const;
108         int                                     GetLightLayer();
109         bool                            IsTransparant();
110         bool                            UsesTriangles();
111         unsigned int            hash() const;
112         int                                     GetDrawingMode();
113         const STR_String&       GetMaterialName() const;
114         const STR_String&       GetTextureName() const;
115 };
116
117 inline  bool operator ==( const RAS_IPolyMaterial & rhs,const RAS_IPolyMaterial & lhs)
118 {
119         return ( rhs.Equals(lhs));
120 }
121
122
123 #endif //__RAS_IPOLYGONMATERIAL