svn merge -r 21041:21301 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[blender.git] / source / gameengine / Ketsji / KX_PolygonMaterial.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 __KX_POLYGONMATERIAL_H__
30 #define __KX_POLYGONMATERIAL_H__
31
32 #include "PyObjectPlus.h"
33
34 #include "RAS_MaterialBucket.h"
35 #include "RAS_IRasterizer.h"
36 #include "DNA_ID.h"
37
38 struct MTFace;
39 struct Material;
40 struct MTex;
41
42 /**
43  *  Material class.
44  *
45  *  This holds the shader, textures and python methods for setting the render state before
46  *  rendering.
47  */
48 class KX_PolygonMaterial : public PyObjectPlus, public RAS_IPolyMaterial
49 {
50         Py_Header;
51 private:
52         /** Blender texture face structure. */
53         MTFace*                 m_tface;
54         unsigned int*   m_mcol;
55         Material*               m_material;
56         PyObject*               m_pymaterial;
57
58         mutable int             m_pass;
59 public:
60         KX_PolygonMaterial();
61         void Initialize(const STR_String &texname,
62                 Material* ma,
63                 int materialindex,
64                 int tile,
65                 int tilexrep,
66                 int tileyrep,
67                 int mode,
68                 int transp,
69                 bool alpha,
70                 bool zsort,
71                 int lightlayer,
72                 struct MTFace* tface,
73                 unsigned int* mcol);
74
75         virtual ~KX_PolygonMaterial();
76         
77         /**
78          * Returns the caching information for this material,
79          * This can be used to speed up the rasterizing process.
80          * @return The caching information.
81          */
82         virtual TCachingInfo GetCachingInfo(void) const
83         {
84                 return (void*) this;
85         }
86
87         /**
88          * Activates the material in the (OpenGL) rasterizer.
89          * On entry, the cachingInfo contains info about the last activated material.
90          * On exit, the cachingInfo should contain updated info about this material.
91          * @param rasty                 The rasterizer in which the material should be active.
92          * @param cachingInfo   The information about the material used to speed up rasterizing.
93          */
94         void DefaultActivate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const;
95         virtual bool Activate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const;
96
97         /**
98          * Returns the Blender texture face structure that is used for this material.
99          * @return The material's texture face.
100          */
101         MTFace* GetMTFace(void) const
102         {
103                 return m_tface;
104         }
105
106         unsigned int* GetMCol(void) const
107         {
108                 return m_mcol;
109         }
110         virtual void GetMaterialRGBAColor(unsigned char *rgba) const;
111
112         KX_PYMETHOD_DOC(KX_PolygonMaterial, updateTexture);
113         KX_PYMETHOD_DOC(KX_PolygonMaterial, setTexture);
114         KX_PYMETHOD_DOC(KX_PolygonMaterial, activate);
115         
116         KX_PYMETHOD_DOC(KX_PolygonMaterial, setCustomMaterial);
117         KX_PYMETHOD_DOC(KX_PolygonMaterial, loadProgram);
118
119         virtual PyObject* py_repr(void) { return PyUnicode_FromString(m_material ? ((ID *)m_material)->name+2 : ""); }
120         
121         static PyObject*        pyattr_get_texture(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
122         static PyObject*        pyattr_get_material(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
123         
124         static PyObject*        pyattr_get_tface(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
125         static PyObject*        pyattr_get_gl_texture(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
126         
127         static PyObject*        pyattr_get_diffuse(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);    
128         static int                      pyattr_set_diffuse(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
129         static PyObject*        pyattr_get_specular(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);   
130         static int                      pyattr_set_specular(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
131 };
132
133 #endif // __KX_POLYGONMATERIAL_H__
134