TexFace to Material Settings big patch

Summary:
========
The idea here is to move the texface options into the material panel.
For images with the change please visit:
http://code.blender.org/index.php/2011/09/bge-material-texface-changes

1 - Some of the legacy problems 2.49 and 2.5x has with the texface system:
==========================================================================
1.1) Shadow, Bilboard and Halo are mutual exclusive (in the code), yet you can
select a face to be more than one mode.
1.2) Sort only works for blend Alpha yet it's an option regardless of the
Transparency Blend you pick.
1.3) Shared doesn't affect anything in BGE.
1.4) ObColor only works for Text objects (old bitmap texts) when using Texture
Face Materials. (not address yet, I so far ignored obcolor)

2 - Notes:
============
2.1) Now "Use Face Textures" in material Option panel will work in Multitexture
even if there is no texture channel.

2.2) In FaceTexture mode it will use TexFace all the time, even if you don't
check the "Use Texture Face" option in the UI. It's a matter of decision, since
the code for either way is there. I decided by the solution that makes the
creation of a material fast - in this mode the user doesn't need to mess with
textures or this "Use Texture Face" option at all. I'm not strong in my opinion
here. But I think if we don't have this then what is the point of the Texture
Face mode?

2.3) I kept references for tface only when we need the image, UV or the tiling
setting. It should help later when/if we split the Image and UV layers from the
tface struct  (Campbell and Brecht proposal).

3 - Changes in a Nutshell:
==========================
3.1) "Texture Face" panel (in the Mesh/Object Data panel) no longer exists. Those settings are all part of the material properties, visible when Game Render is set.

3.2) "Texture Face" Shading mode (in the Render panel) is now called “Single Texture”, it needs a material for special settings (e.g. Billboard, Alpha Sort, …).

3.3) New options in the Material Panel
* Shadeless option in the Material panel is now supported for all three Shading modes.
* Physics is now toggleable, this is the old Collision option.
* Two Side (on) is now called Back Culling (off).
* Alpha Sort is one of the Alpha options, together (and mutually exclusive) to Alpha Blend, Alpha Clip, Add and Opaque (i.e. solid).
* Shadow, Billboard and Halo are grouped in the “Face Orientation” property.
* "Face Textures" and "Face Textures Alpha" (under Options) can be used for all but GLSL shading mode (to be supported in GLSL eventually).
* The backend in the game engine is still the same as before. The only changes are in the interface and in the way you need to think your materials. The bottomline is: It’s no longer possible to share materials between faces that do not share the same game properties.

4 - Acknowledgment:
==================
Mike Pan for the design discussions, and testing along the whole development process.
Vitor Balbio for the first hands-on code with the interface changes. That helped me a lot to push me into work on that.
Benoit Bolsee and Brecht van Lommel for patch review (* no one reviewed the whole patch, or the latest iteractions, so I still hold liability for any problems).
Blender artists that gave feedback and helped testing the patch.

Patch review and original documentation can be found here:
http://wiki.blender.org/index.php/User:Dfelinto/TexFace
http://codereview.appspot.com/4289041/

5 files changed, 76 insertions, 52 deletions

diff --git a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.cpp b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.cpp
index 5a1b52489b4..9948f48d7f3 100644
--- a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.cpp
+++ b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.cpp
@@ -36,6 +36,7 @@
 
 #include "DNA_image_types.h"
 #include "DNA_meshdata_types.h"
+#include "DNA_material_types.h"
 
 void  RAS_IPolyMaterial::Initialize( 
 				const STR_String& texname,
@@ -44,10 +45,12 @@ void  RAS_IPolyMaterial::Initialize(
 				int tile,
 				int tilexrep,
 				int tileyrep,
-				int mode,
-				int transp,
+				int alphablend,
 				bool alpha,
-				bool zsort)
+				bool zsort,
+				bool light,
+				bool image,
+				struct GameSettings* game)
 {
 	m_texturename = texname;
 	m_materialname = matname;
@@ -55,10 +58,10 @@ void  RAS_IPolyMaterial::Initialize(
 	m_tile = tile;
 	m_tilexrep = tilexrep;
 	m_tileyrep = tileyrep;
-	m_drawingmode = mode;
-	m_transp = transp;
+	m_alphablend = alphablend;
 	m_alpha = alpha;
 	m_zsort = zsort;
+	m_light = light;
 	m_polymatid = m_newpolymatid++;
 	m_flag = 0;
 	m_multimode = 0;
@@ -66,6 +69,7 @@ void  RAS_IPolyMaterial::Initialize(
 	m_specular.setValue(0.5,0.5,0.5);
 	m_specularity = 1.0;
 	m_diffuse.setValue(0.5,0.5,0.5);
+	m_drawingmode = ConvertFaceMode(game, image);
 }
 
 RAS_IPolyMaterial::RAS_IPolyMaterial() 
@@ -75,9 +79,10 @@ RAS_IPolyMaterial::RAS_IPolyMaterial()
 		m_tilexrep(0),
 		m_tileyrep(0),
 		m_drawingmode (0),
-		m_transp(0),
+		m_alphablend(0),
 		m_alpha(false),
 		m_zsort(false),
+		m_light(false),
 		m_materialindex(0),
 		m_polymatid(0),
 		m_flag(0),
@@ -95,8 +100,7 @@ RAS_IPolyMaterial::RAS_IPolyMaterial(const STR_String& texname,
 									 int tile,
 									 int tilexrep,
 									 int tileyrep,
-									 int mode,
-									 int transp,
+									 int alphablend,
 									 bool alpha,
 									 bool zsort)
 		: m_texturename(texname),
@@ -104,8 +108,7 @@ RAS_IPolyMaterial::RAS_IPolyMaterial(const STR_String& texname,
 		m_tile(tile),
 		m_tilexrep(tilexrep),
 		m_tileyrep(tileyrep),
-		m_drawingmode (mode),
-		m_transp(transp),
+		m_alphablend(alphablend),
 		m_alpha(alpha),
 		m_zsort(zsort),
 		m_materialindex(materialindex),
@@ -128,9 +131,9 @@ bool RAS_IPolyMaterial::Equals(const RAS_IPolyMaterial& lhs) const
 			this->m_multimode			==		lhs.m_multimode &&
 			this->m_flag				==		lhs.m_flag		&&
 			this->m_drawingmode			==		lhs.m_drawingmode &&
-			this->m_transp				==		lhs.m_transp &&
-			this->m_texturename.hash()	==		lhs.m_texturename.hash() &&
-			this->m_materialname.hash() ==		lhs.m_materialname.hash()
+			this->m_alphablend			==		lhs.m_alphablend &&
+			this->m_texturename.hash()		==		lhs.m_texturename.hash() &&
+			this->m_materialname.hash() 		==		lhs.m_materialname.hash()
 		);
 
 		return test;
@@ -141,9 +144,10 @@ bool RAS_IPolyMaterial::Equals(const RAS_IPolyMaterial& lhs) const
 				this->m_tile		==		lhs.m_tile &&
 				this->m_tilexrep	==		lhs.m_tilexrep &&
 				this->m_tileyrep	==		lhs.m_tileyrep &&
-				this->m_transp		==		lhs.m_transp &&
+				this->m_alphablend	==		lhs.m_alphablend &&
 				this->m_alpha		==		lhs.m_alpha &&
 				this->m_zsort		==		lhs.m_zsort &&
+				this->m_light		==		lhs.m_light &&
 				this->m_drawingmode	==		lhs.m_drawingmode &&
 				this->m_texturename.hash()	==		lhs.m_texturename.hash() &&
 				this->m_materialname.hash() ==		lhs.m_materialname.hash()
@@ -151,6 +155,21 @@ bool RAS_IPolyMaterial::Equals(const RAS_IPolyMaterial& lhs) const
 	}
 }
 
+int RAS_IPolyMaterial::ConvertFaceMode(struct GameSettings *game, bool image) const
+{
+	if (!game) return (image?GEMAT_TEX:0);
+
+	int modefinal = 0;
+
+	int orimode   = game->face_orientation;
+	int alpha_blend = game->alpha_blend;
+	int flags = game->flag & (GEMAT_TEXT | GEMAT_BACKCULL);
+
+	modefinal = orimode | alpha_blend | flags;
+	modefinal |= (image ? GEMAT_TEX : 0);
+
+	return modefinal;
+}
 
 void RAS_IPolyMaterial::GetMaterialRGBAColor(unsigned char *rgba) const
 {
@@ -241,7 +260,7 @@ bool RAS_IPolyMaterial::UsesLighting(RAS_IRasterizer *rasty) const
 	else if(rasty->GetDrawingMode() < RAS_IRasterizer::KX_SOLID);
 	else if(rasty->GetDrawingMode() == RAS_IRasterizer::KX_SHADOW);
 	else
-		dolights = (m_drawingmode & RAS_IRasterizer::KX_LIGHT)!=0;
+		dolights = m_light;
 	
 	return dolights;
 }
diff --git a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h
index 2a5c6a179b6..69d07713c49 100644
--- a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h
+++ b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h
@@ -49,6 +49,7 @@ struct Material;
 struct Image;
 struct Scene;
 class SCA_IScene;
+struct GameSettings;
 
 enum MaterialProps
 {
@@ -78,10 +79,11 @@ protected:
 	STR_HashedString		m_materialname; //also needed for touchsensor  
 	int						m_tile;
 	int						m_tilexrep,m_tileyrep;
-	int						m_drawingmode;	// tface->mode
-	int						m_transp;
+	int						m_drawingmode;
+	int						m_alphablend;
 	bool					m_alpha;
 	bool					m_zsort;
+	bool					m_light;
 	int						m_materialindex;
 	
 	unsigned int			m_polymatid;
@@ -102,9 +104,9 @@ public:
 	// care! these are taken from blender polygonflags, see file DNA_mesh_types.h for #define TF_BILLBOARD etc.
 	enum MaterialFlags
 	{
-		BILLBOARD_SCREENALIGNED = 256,
-		BILLBOARD_AXISALIGNED = 4096,
-		SHADOW				  =8192
+		BILLBOARD_SCREENALIGNED	= 512,  /* GEMAT_HALO */
+		BILLBOARD_AXISALIGNED	= 1024, /* GEMAT_BILLBOARD */
+		SHADOW			=2048   /* GEMAT_SHADOW */
 	};
 
 	RAS_IPolyMaterial();
@@ -114,7 +116,6 @@ public:
 					  int tile,
 					  int tilexrep,
 					  int tileyrep,
-					  int mode,
 					  int transp,
 					  bool alpha,
 					  bool zsort);
@@ -124,10 +125,13 @@ public:
 					int tile,
 					int tilexrep,
 					int tileyrep,
-					int mode,
 					int transp,
 					bool alpha,
-					bool zsort);
+					bool zsort,
+					bool light,
+					bool image,
+					struct GameSettings* game);
+
 	virtual ~RAS_IPolyMaterial() {};
  
 	/**
@@ -174,6 +178,11 @@ public:
 
 	virtual void		Replace_IScene(SCA_IScene *val) {}; /* overridden by KX_BlenderMaterial */
 
+	/**
+	* @return the equivalent drawing mode for the material settings (equivalent to old TexFace tface->mode).
+	*/
+	int					ConvertFaceMode(struct GameSettings *game, bool image) const;
+
 	/*
 	 * PreCalculate texture gen
 	 */
diff --git a/source/gameengine/Rasterizer/RAS_IRasterizer.h b/source/gameengine/Rasterizer/RAS_IRasterizer.h
index 877a7219a1c..2988aa4effb 100644
--- a/source/gameengine/Rasterizer/RAS_IRasterizer.h
+++ b/source/gameengine/Rasterizer/RAS_IRasterizer.h
@@ -68,11 +68,7 @@ class RAS_IRasterizer
 public:
 	RAS_IRasterizer(RAS_ICanvas* canv){};
 	virtual ~RAS_IRasterizer(){};
-	/**
-	 */
-	enum	{
-			RAS_RENDER_3DPOLYGON_TEXT = 16384	/* TF_BMFONT */
-	};
+
 	/**
 	 * Drawing types
 	 */
@@ -106,9 +102,9 @@ public:
 	/**
 	 */
 	enum    { 	 
-			KX_TEX = 4,			/* TF_TEX */
-			KX_LIGHT = 16,		/* TF_LIGHT */
-			KX_TWOSIDE = 512,	/* TF_TWOSIDE */
+			RAS_RENDER_3DPOLYGON_TEXT = 64,	/* GEMAT_TEXT */
+			KX_BACKCULL = 16,		/* GEMAT_BACKCULL */
+			KX_TEX = 4096,			/* GEMAT_TEX */
 			KX_LINES = 32768 	 
 	};
 
@@ -417,7 +413,7 @@ public:
 	virtual int		GetMotionBlurState()=0;
 	virtual void	SetMotionBlurState(int newstate)=0;
 
-	virtual void	SetBlendingMode(int blendmode)=0;
+	virtual void	SetAlphaBlend(int alphablend)=0;
 	virtual void	SetFrontFace(bool ccw)=0;
 
 	virtual void	SetAnisotropicFiltering(short level)=0;
diff --git a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.cpp b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.cpp
index 6ad9e591474..d9039a2a68d 100644
--- a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.cpp
+++ b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.cpp
@@ -89,7 +89,7 @@ RAS_OpenGLRasterizer::RAS_OpenGLRasterizer(RAS_ICanvas* canvas)
 	m_motionblurvalue(-1.0),
 	m_texco_num(0),
 	m_attrib_num(0),
-	//m_last_blendmode(GPU_BLEND_SOLID),
+	//m_last_alphablend(GPU_BLEND_SOLID),
 	m_last_frontface(true),
 	m_materialCachingInfo(0)
 {
@@ -126,8 +126,8 @@ bool RAS_OpenGLRasterizer::Init()
 
 	glDisable(GL_BLEND);
 	glDisable(GL_ALPHA_TEST);
-	//m_last_blendmode = GPU_BLEND_SOLID;
-	GPU_set_material_blend_mode(GPU_BLEND_SOLID);
+	//m_last_alphablend = GPU_BLEND_SOLID;
+	GPU_set_material_alpha_blend(GPU_BLEND_SOLID);
 
 	glFrontFace(GL_CCW);
 	m_last_frontface = true;
@@ -303,8 +303,8 @@ bool RAS_OpenGLRasterizer::BeginFrame(int drawingmode, double time)
 
 	glDisable(GL_BLEND);
 	glDisable(GL_ALPHA_TEST);
-	//m_last_blendmode = GPU_BLEND_SOLID;
-	GPU_set_material_blend_mode(GPU_BLEND_SOLID);
+	//m_last_alphablend = GPU_BLEND_SOLID;
+	GPU_set_material_alpha_blend(GPU_BLEND_SOLID);
 
 	glFrontFace(GL_CCW);
 	m_last_frontface = true;
@@ -873,10 +873,10 @@ void RAS_OpenGLRasterizer::IndexPrimitivesInternal(RAS_MeshSlot& ms, bool multi)
 		// MCol *mcol = (MCol*)ms.m_pDerivedMesh->getFaceDataArray(ms.m_pDerivedMesh, CD_MCOL); /* UNUSED */
 
 		// handle two-side
-		if (current_polymat->GetDrawingMode() & RAS_IRasterizer::KX_TWOSIDE)
-			this->SetCullFace(false);
-		else
+		if (current_polymat->GetDrawingMode() & RAS_IRasterizer::KX_BACKCULL)
 			this->SetCullFace(true);
+		else
+			this->SetCullFace(false);
 
 		if (current_polymat->GetFlag() & RAS_BLENDERGLSL) {
 			// GetMaterialIndex return the original mface material index, 
@@ -890,9 +890,9 @@ void RAS_OpenGLRasterizer::IndexPrimitivesInternal(RAS_MeshSlot& ms, bool multi)
 			else
 				memset(&current_gpu_attribs, 0, sizeof(current_gpu_attribs));
 			// DM draw can mess up blending mode, restore at the end
-			int current_blend_mode = GPU_get_material_blend_mode();
+			int current_blend_mode = GPU_get_material_alpha_blend();
 			ms.m_pDerivedMesh->drawFacesGLSL(ms.m_pDerivedMesh, CheckMaterialDM);
-			GPU_set_material_blend_mode(current_blend_mode);
+			GPU_set_material_alpha_blend(current_blend_mode);
 		} else {
 			//ms.m_pDerivedMesh->drawMappedFacesTex(ms.m_pDerivedMesh, CheckTexfaceDM, mcol);
 			current_blmat_nr = current_polymat->GetMaterialIndex();
@@ -1204,36 +1204,36 @@ void RAS_OpenGLRasterizer::DisableMotionBlur()
 	m_motionblurvalue = -1.0;
 }
 
-void RAS_OpenGLRasterizer::SetBlendingMode(int blendmode)
+void RAS_OpenGLRasterizer::SetAlphaBlend(int alphablend)
 {
-	GPU_set_material_blend_mode(blendmode);
+	GPU_set_material_alpha_blend(alphablend);
 /*
-	if(blendmode == m_last_blendmode)
+	if(alphablend == m_last_alphablend)
 		return;
 
-	if(blendmode == GPU_BLEND_SOLID) {
+	if(alphablend == GPU_BLEND_SOLID) {
 		glDisable(GL_BLEND);
 		glDisable(GL_ALPHA_TEST);
 		glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 	}
-	else if(blendmode == GPU_BLEND_ADD) {
+	else if(alphablend == GPU_BLEND_ADD) {
 		glBlendFunc(GL_ONE, GL_ONE);
 		glEnable(GL_BLEND);
 		glDisable(GL_ALPHA_TEST);
 	}
-	else if(blendmode == GPU_BLEND_ALPHA) {
+	else if(alphablend == GPU_BLEND_ALPHA) {
 		glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 		glEnable(GL_BLEND);
 		glEnable(GL_ALPHA_TEST);
 		glAlphaFunc(GL_GREATER, 0.0f);
 	}
-	else if(blendmode == GPU_BLEND_CLIP) {
+	else if(alphablend == GPU_BLEND_CLIP) {
 		glDisable(GL_BLEND); 
 		glEnable(GL_ALPHA_TEST);
 		glAlphaFunc(GL_GREATER, 0.5f);
 	}
 
-	m_last_blendmode = blendmode;
+	m_last_alphablend = alphablend;
 */
 }
 
diff --git a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h
index c0e02f6df77..cbfa49510a5 100644
--- a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h
+++ b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h
@@ -111,7 +111,7 @@ protected:
 	TexCoGen		m_attrib[RAS_MAX_ATTRIB];
 	int				m_texco_num;
 	int				m_attrib_num;
-	//int				m_last_blendmode;
+	//int				m_last_alphablend;
 	bool			m_last_frontface;
 
 	/** Stores the caching information for the last material activated. */
@@ -312,7 +312,7 @@ public:
 			m_motionblur = newstate;
 	};
 
-	virtual void	SetBlendingMode(int blendmode);
+	virtual void	SetAlphaBlend(int alphablend);
 	virtual void	SetFrontFace(bool ccw);
 	
 	virtual void	SetAnisotropicFiltering(short level);