2.4x - Grease Pencil: Swapping the order of args for gpencil_frame_delete_laststroke...
[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
37 struct MTFace;
38 struct Material;
39 struct MTex;
40
41 /**
42  *  Material class.
43  *
44  *  This holds the shader, textures and python methods for setting the render state before
45  *  rendering.
46  */
47 class KX_PolygonMaterial : public PyObjectPlus, public RAS_IPolyMaterial
48 {
49         Py_Header;
50 private:
51         /** Blender texture face structure. */
52         MTFace*                 m_tface;
53         unsigned int*   m_mcol;
54         Material*               m_material;
55         
56         PyObject*               m_pymaterial;
57
58         mutable int             m_pass;
59 public:
60         
61         KX_PolygonMaterial(const STR_String &texname,
62                 Material* ma,
63                 int tile,
64                 int tilexrep,
65                 int tileyrep,
66                 int mode,
67                 int transp,
68                 bool alpha,
69                 bool zsort,
70                 int lightlayer,
71                 struct MTFace* tface,
72                 unsigned int* mcol,
73                 PyTypeObject *T = &Type);
74         virtual ~KX_PolygonMaterial();
75         
76         /**
77          * Returns the caching information for this material,
78          * This can be used to speed up the rasterizing process.
79          * @return The caching information.
80          */
81         virtual TCachingInfo GetCachingInfo(void) const
82         {
83                 return (void*) this;
84         }
85
86         /**
87          * Activates the material in the (OpenGL) rasterizer.
88          * On entry, the cachingInfo contains info about the last activated material.
89          * On exit, the cachingInfo should contain updated info about this material.
90          * @param rasty                 The rasterizer in which the material should be active.
91          * @param cachingInfo   The information about the material used to speed up rasterizing.
92          */
93         void DefaultActivate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const;
94         virtual bool Activate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const;
95
96         /**
97          * Returns the Blender texture face structure that is used for this material.
98          * @return The material's texture face.
99          */
100         MTFace* GetMTFace(void) const
101         {
102                 return m_tface;
103         }
104
105         unsigned int* GetMCol(void) const
106         {
107                 return m_mcol;
108         }
109         
110         
111         KX_PYMETHOD_DOC(KX_PolygonMaterial, updateTexture);
112         KX_PYMETHOD_DOC(KX_PolygonMaterial, setTexture);
113         KX_PYMETHOD_DOC(KX_PolygonMaterial, activate);
114         
115         KX_PYMETHOD_DOC(KX_PolygonMaterial, setCustomMaterial);
116         KX_PYMETHOD_DOC(KX_PolygonMaterial, loadProgram);
117
118         virtual PyObject* py_getattro(PyObject *attr);
119         virtual int       py_setattro(PyObject *attr, PyObject *pyvalue);
120 };
121
122 #endif // __KX_POLYGONMATERIAL_H__
123