Python BGE API
[blender.git] / source / gameengine / Ketsji / KX_PolyProxy.cpp
1 /**
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifdef HAVE_CONFIG_H
30 #include <config.h>
31 #endif
32
33 #include "KX_PolyProxy.h"
34 #include "KX_MeshProxy.h"
35 #include "RAS_MeshObject.h"
36 #include "KX_BlenderMaterial.h"
37 #include "KX_PolygonMaterial.h"
38
39 #include "KX_PyMath.h"
40
41 PyTypeObject KX_PolyProxy::Type = {
42         PyObject_HEAD_INIT(NULL)
43         0,
44         "KX_PolyProxy",
45         sizeof(KX_PolyProxy),
46         0,
47         PyDestructor,
48         0,
49         0,
50         0,
51         0,
52         py_base_repr,
53         0,0,0,0,0,0,
54         py_base_getattro,
55         py_base_setattro,
56         0,0,0,0,0,0,0,0,0,
57         Methods
58 };
59
60 PyParentObject KX_PolyProxy::Parents[] = {
61         &KX_PolyProxy::Type,
62         &SCA_IObject::Type,
63         &CValue::Type,
64         NULL
65 };
66
67 PyMethodDef KX_PolyProxy::Methods[] = {
68         KX_PYMETHODTABLE_NOARGS(KX_PolyProxy,getMaterialIndex),
69         KX_PYMETHODTABLE_NOARGS(KX_PolyProxy,getNumVertex),
70         KX_PYMETHODTABLE_NOARGS(KX_PolyProxy,isVisible),
71         KX_PYMETHODTABLE_NOARGS(KX_PolyProxy,isCollider),
72         KX_PYMETHODTABLE_NOARGS(KX_PolyProxy,getMaterialName),
73         KX_PYMETHODTABLE_NOARGS(KX_PolyProxy,getTextureName),
74         KX_PYMETHODTABLE(KX_PolyProxy,getVertexIndex),
75         KX_PYMETHODTABLE_NOARGS(KX_PolyProxy,getMesh),
76         KX_PYMETHODTABLE_NOARGS(KX_PolyProxy,getMaterial),
77         {NULL,NULL} //Sentinel
78 };
79
80 PyAttributeDef KX_PolyProxy::Attributes[] = {
81         { NULL }        //Sentinel
82 };
83
84 PyObject* KX_PolyProxy::py_getattro(PyObject *attr)
85 {
86         char *attr_str= PyString_AsString(attr);
87         if (!strcmp(attr_str, "matname"))
88         {
89                 return PyString_FromString(m_polygon->GetMaterial()->GetPolyMaterial()->GetMaterialName());
90         }
91         if (!strcmp(attr_str, "texture"))
92         {
93                 return PyString_FromString(m_polygon->GetMaterial()->GetPolyMaterial()->GetTextureName());
94         }
95         if (!strcmp(attr_str, "material"))
96         {
97                 RAS_IPolyMaterial *polymat = m_polygon->GetMaterial()->GetPolyMaterial();
98                 if(polymat->GetFlag() & RAS_BLENDERMAT)
99                 {
100                         KX_BlenderMaterial* mat = static_cast<KX_BlenderMaterial*>(polymat);
101                         Py_INCREF(mat);
102                         return mat;
103                 }
104                 else
105                 {
106                         KX_PolygonMaterial* mat = static_cast<KX_PolygonMaterial*>(polymat);
107                         Py_INCREF(mat);
108                         return mat;
109                 }
110         }
111         if (!strcmp(attr_str, "matid"))
112         {
113                 // we'll have to scan through the material bucket of the mes and compare with 
114                 // the one of the polygon
115                 RAS_MaterialBucket* polyBucket = m_polygon->GetMaterial();
116                 unsigned int matid;
117                 for (matid=0; matid<m_mesh->NumMaterials(); matid++)
118                 {
119                         RAS_MeshMaterial* meshMat = m_mesh->GetMeshMaterial(matid);
120                         if (meshMat->m_bucket == polyBucket)
121                                 // found it
122                                 break;
123                 }
124                 return PyInt_FromLong(matid);
125         }
126         if (!strcmp(attr_str, "v1"))
127         {
128                 return PyInt_FromLong(m_polygon->GetVertexOffset(0));
129         }
130         if (!strcmp(attr_str, "v2"))
131         {
132                 return PyInt_FromLong(m_polygon->GetVertexOffset(1));
133         }
134         if (!strcmp(attr_str, "v3"))
135         {
136                 return PyInt_FromLong(m_polygon->GetVertexOffset(2));
137         }
138         if (!strcmp(attr_str, "v4"))
139         {
140                 return PyInt_FromLong(((m_polygon->VertexCount()>3)?m_polygon->GetVertexOffset(3):0));
141         }
142         if (!strcmp(attr_str, "visible"))
143         {
144                 return PyInt_FromLong(m_polygon->IsVisible());
145         }
146         if (!strcmp(attr_str, "collide"))
147         {
148                 return PyInt_FromLong(m_polygon->IsCollider());
149         }
150         py_getattro_up(SCA_IObject);
151 }
152
153 KX_PolyProxy::KX_PolyProxy(const RAS_MeshObject*mesh, RAS_Polygon* polygon)
154 :       m_polygon(polygon),
155         m_mesh((RAS_MeshObject*)mesh)
156 {
157 }
158
159 KX_PolyProxy::~KX_PolyProxy()
160 {
161 }
162
163
164 // stuff for cvalue related things
165 CValue*         KX_PolyProxy::Calc(VALUE_OPERATOR, CValue *) { return NULL;}
166 CValue*         KX_PolyProxy::CalcFinal(VALUE_DATA_TYPE, VALUE_OPERATOR, CValue *) { return NULL;}      
167 STR_String      sPolyName="polygone";
168 const STR_String &      KX_PolyProxy::GetText() {return sPolyName;};
169 float           KX_PolyProxy::GetNumber() { return -1;}
170 STR_String      KX_PolyProxy::GetName() { return sPolyName;}
171 void            KX_PolyProxy::SetName(STR_String) { };
172 CValue*         KX_PolyProxy::GetReplica() { return NULL;}
173 void            KX_PolyProxy::ReplicaSetName(STR_String) {};
174
175
176 // stuff for python integration
177
178 KX_PYMETHODDEF_DOC_NOARGS(KX_PolyProxy, getMaterialIndex, 
179 "getMaterialIndex() : return the material index of the polygon in the mesh\n")
180 {
181         RAS_MaterialBucket* polyBucket = m_polygon->GetMaterial();
182         unsigned int matid;
183         for (matid=0; matid<m_mesh->NumMaterials(); matid++)
184         {
185                 RAS_MeshMaterial* meshMat = m_mesh->GetMeshMaterial(matid);
186                 if (meshMat->m_bucket == polyBucket)
187                         // found it
188                         break;
189         }
190         return PyInt_FromLong(matid);
191 }
192
193 KX_PYMETHODDEF_DOC_NOARGS(KX_PolyProxy, getNumVertex,
194 "getNumVertex() : returns the number of vertex of the polygon, 3 or 4\n")
195 {
196         return PyInt_FromLong(m_polygon->VertexCount());
197 }
198
199 KX_PYMETHODDEF_DOC_NOARGS(KX_PolyProxy, isVisible,
200 "isVisible() : returns whether the polygon is visible or not\n")
201 {
202         return PyInt_FromLong(m_polygon->IsVisible());
203 }
204
205 KX_PYMETHODDEF_DOC_NOARGS(KX_PolyProxy, isCollider,
206 "isCollider() : returns whether the polygon is receives collision or not\n")
207 {
208         return PyInt_FromLong(m_polygon->IsCollider());
209 }
210
211 KX_PYMETHODDEF_DOC_NOARGS(KX_PolyProxy, getMaterialName,
212 "getMaterialName() : returns the polygon material name, \"NoMaterial\" if no material\n")
213 {
214         return PyString_FromString(m_polygon->GetMaterial()->GetPolyMaterial()->GetMaterialName());
215 }
216
217 KX_PYMETHODDEF_DOC_NOARGS(KX_PolyProxy, getTextureName,
218 "getTexturelName() : returns the polygon texture name, \"NULL\" if no texture\n")
219 {
220         return PyString_FromString(m_polygon->GetMaterial()->GetPolyMaterial()->GetTextureName());
221 }
222
223 KX_PYMETHODDEF_DOC(KX_PolyProxy, getVertexIndex,
224 "getVertexIndex(vertex) : returns the mesh vertex index of a polygon vertex\n"
225 "vertex: index of the vertex in the polygon: 0->3\n"
226 "return value can be used to retrieve the vertex details through mesh proxy\n"
227 "Note: getVertexIndex(3) on a triangle polygon returns 0\n")
228 {
229         int index;
230         if (!PyArg_ParseTuple(args,"i",&index))
231         {
232                 return NULL;
233         }
234         if (index < 0 || index > 3)
235         {
236                 PyErr_SetString(PyExc_AttributeError, "Valid range for index is 0-3");
237                 return NULL;
238         }
239         if (index < m_polygon->VertexCount())
240         {
241                 return PyInt_FromLong(m_polygon->GetVertexOffset(index));
242         }
243         return PyInt_FromLong(0);
244 }
245
246 KX_PYMETHODDEF_DOC_NOARGS(KX_PolyProxy, getMesh,
247 "getMesh() : returns a mesh proxy\n")
248 {
249         KX_MeshProxy* meshproxy = new KX_MeshProxy((RAS_MeshObject*)m_mesh);
250         return meshproxy;
251 }
252
253 KX_PYMETHODDEF_DOC_NOARGS(KX_PolyProxy, getMaterial,
254 "getMaterial() : returns a material\n")
255 {
256         RAS_IPolyMaterial *polymat = m_polygon->GetMaterial()->GetPolyMaterial();
257         if(polymat->GetFlag() & RAS_BLENDERMAT)
258         {
259                 KX_BlenderMaterial* mat = static_cast<KX_BlenderMaterial*>(polymat);
260                 Py_INCREF(mat);
261                 return mat;
262         }
263         else
264         {
265                 KX_PolygonMaterial* mat = static_cast<KX_PolygonMaterial*>(polymat);
266                 Py_INCREF(mat);
267                 return mat;
268         }
269 }