UPBGE: Implement implicit cast in CListValue::iterator.

Previously CListValue::iterator was simply std::vector<CValue *>::iterator,
it requested to cast the CValue pointer to an other type in the loop code.
Generally an extra line was dedicated to this operation.

To avoid this line or at least avoir explicit cast, the iterator is now a
cast owning a std::vector::iterator. This class is declared with a template
argulment which is the class name to cast to when deferencing the iterator
for example:

CListValue::iterator<KX_GameObject> it = list->GetBegin()

The class redefines the ++ operator, the * operator for deferencing and the
!= operator, to be used in a loop.

By this way the developer doesn't have to bother of the cast if he set properly
the iterator. Also this class gives less control to the original iterator,
it's safer.

Author: panzergame

source/gameengine/Converter/BL_BlenderDataConversion.cpp

@@ -1745,8 +1745,8 @@ void BL_ConvertBlenderObjects(struct Main* maggie,
 	}
 
 	// Look at every material texture and ask to create realtime cube map.
-	for (CListValue::iterator it = sumolist->GetBegin(), end = sumolist->GetEnd(); it != end; ++it) {
-		KX_GameObject *gameobj = (KX_GameObject*)*it;
+	for (CListValue::iterator<KX_GameObject> it = sumolist->GetBegin(), end = sumolist->GetEnd(); it != end; ++it) {
+		KX_GameObject *gameobj = *it;
 
 		for (unsigned short i = 0, meshcount = gameobj->GetMeshCount(); i < meshcount; ++i) {
 			RAS_MeshObject *mesh = gameobj->GetMesh(i);

source/gameengine/Expressions/EXP_ListValue.h

@@ -39,7 +39,33 @@ class CListValue : public CPropValue
 	virtual CValue* GetReplica();
 
 public:
-	typedef std::vector<CValue *>::iterator iterator;
+	typedef std::vector<CValue *>::iterator baseIterator;
+
+	template <class T>
+	class iterator
+	{
+	private:
+		baseIterator m_it;
+
+	public:
+		iterator(baseIterator it)
+			:m_it(it)
+		{
+		}
+
+		inline void operator++()
+		{
+			++m_it;
+		}
+
+		inline T *operator*()
+		{
+			return (T *)*m_it;
+		}
+
+		template <class U>
+		friend bool operator!=(const iterator<U>& it1, const iterator<U>& it2);
+	};
 
 	void MergeList(CListValue* otherlist);
 	bool RemoveValue(CValue* val);
@@ -59,8 +85,8 @@ class CListValue : public CPropValue
 	CValue *GetFront();
 	CValue *GetBack();
 	int GetCount() { return m_pValueArray.size(); }
-	iterator GetBegin();
-	iterator GetEnd();
+	baseIterator GetBegin();
+	baseIterator GetEnd();
 	virtual const STR_String & GetText();
 
 	bool CheckEqual(CValue* first,CValue* second);
@@ -89,5 +115,11 @@ class CListValue : public CPropValue
 	bool	m_bReleaseContents;
 };
 
+template <class T>
+inline bool operator!=(const CListValue::iterator<T>& it1, const CListValue::iterator<T>& it2)
+{
+	return it1.m_it != it2.m_it;
+}
+
 #endif  /* __EXP_LISTVALUE_H__ */
 

source/gameengine/Expressions/intern/ListValue.cpp

@@ -107,12 +107,12 @@ CValue *CListValue::GetBack()
 	return m_pValueArray.back();
 }
 
-CListValue::iterator CListValue::GetBegin()
+CListValue::baseIterator CListValue::GetBegin()
 {
 	return m_pValueArray.begin();
 }
 
-CListValue::iterator CListValue::GetEnd()
+CListValue::baseIterator CListValue::GetEnd()
 {
 	return m_pValueArray.end();
 }

source/gameengine/Ketsji/KX_GameObject.cpp

@@ -1700,7 +1700,7 @@ void KX_GameObject::UpdateComponents()
 		return;
 	}
 
-	for (CListValue::iterator it = m_components->GetBegin(), end = m_components->GetEnd(); it != end; ++it) {
+	for (CListValue::baseIterator it = m_components->GetBegin(), end = m_components->GetEnd(); it != end; ++it) {
 		PyObject *pycomp = (*it)->GetProxy();
 		if (!PyObject_CallMethod(pycomp, "update", "")) {
 			PyErr_Print();

source/gameengine/Ketsji/KX_KetsjiEngine.cpp

@@ -403,8 +403,8 @@ bool KX_KetsjiEngine::NextFrame()
 #endif
 
 		// for each scene, call the proceed functions
-		for (CListValue::iterator sceit = m_scenes->GetBegin(); sceit != m_scenes->GetEnd(); ++sceit) {
-			KX_Scene *scene = (KX_Scene *)*sceit;
+		for (CListValue::iterator<KX_Scene> sceit = m_scenes->GetBegin(), sceend = m_scenes->GetEnd(); sceit != sceend; ++sceit) {
+			KX_Scene *scene = *sceit;
 
 			/* Suspension holds the physics and logic processing for an
 			 * entire scene. Objects can be suspended individually, and
@@ -499,8 +499,8 @@ bool KX_KetsjiEngine::NextFrame()
 
 void KX_KetsjiEngine::UpdateSuspendedScenes()
 {
-	for (CListValue::iterator sceneit = m_scenes->GetBegin(); sceneit != m_scenes->GetEnd(); ++sceneit) {
-		KX_Scene *scene = (KX_Scene *)*sceneit;
+	for (CListValue::iterator<KX_Scene> sceneit = m_scenes->GetBegin(), sceneend = m_scenes->GetEnd(); sceneit != sceneend; ++sceneit) {
+		KX_Scene *scene = *sceneit;
 		if (scene->IsSuspended()) {
 			if (scene->getSuspendedTime() == 0.0f) {
 				scene->setSuspendedTime(m_clockTime);
@@ -534,8 +534,8 @@ void KX_KetsjiEngine::Render()
 
 	BeginFrame();
 
-	for (CListValue::iterator sceit = m_scenes->GetBegin(), sceend = m_scenes->GetEnd(); sceit != sceend; ++sceit) {
-		KX_Scene *scene = (KX_Scene *)*sceit;
+	for (CListValue::iterator<KX_Scene> sceit = m_scenes->GetBegin(), sceend = m_scenes->GetEnd(); sceit != sceend; ++sceit) {
+		KX_Scene *scene = *sceit;
 		// shadow buffers
 		RenderShadowBuffers(scene);
 		// cubemaps
@@ -586,8 +586,8 @@ void KX_KetsjiEngine::Render()
 	unsigned short pass = 0;
 
 	// for each scene, call the proceed functions
-	for (CListValue::iterator sceit = m_scenes->GetBegin(), sceend = m_scenes->GetEnd(); sceit != sceend; ++sceit) {
-		KX_Scene *scene = (KX_Scene *)*sceit;
+	for (CListValue::iterator<KX_Scene> sceit = m_scenes->GetBegin(), sceend = m_scenes->GetEnd(); sceit != sceend; ++sceit) {
+		KX_Scene *scene = *sceit;
 		KX_Camera *activecam = scene->GetActiveCamera();
 		CListValue *cameras = scene->GetCameraList();
 
@@ -620,8 +620,8 @@ void KX_KetsjiEngine::Render()
 			}
 
 			// Draw the scene once for each camera with an enabled viewport
-			for (CListValue::iterator it = cameras->GetBegin(), end = cameras->GetEnd(); it != end; ++it) {
-				KX_Camera *cam = (KX_Camera*)(*it);
+			for (CListValue::iterator<KX_Camera> it = cameras->GetBegin(), end = cameras->GetEnd(); it != end; ++it) {
+				KX_Camera *cam = *it;
 				if (cam->GetViewport()) {
 					// do the rendering
 					RenderFrame(scene, cam, pass++);
@@ -809,8 +809,8 @@ void KX_KetsjiEngine::UpdateAnimations(KX_Scene *scene)
 			// Sanity/debug print to make sure we're actually going at the fps we want (should be close to anim_timestep)
 			// CM_Debug("Anim fps: " << 1.0/(m_frameTime - m_previousAnimTime));
 			m_previousAnimTime = m_frameTime;
-			for (CListValue::iterator sceneit = m_scenes->GetBegin(); sceneit != m_scenes->GetEnd(); ++sceneit)
-				((KX_Scene *)*sceneit)->UpdateAnimations(m_frameTime);
+			for (CListValue::iterator<KX_Scene> sceneit = m_scenes->GetBegin(), sceneend = m_scenes->GetEnd(); sceneit != sceneend; ++sceneit)
+				(*sceneit)->UpdateAnimations(m_frameTime);
 		}
 	}
 	else
@@ -1245,8 +1245,8 @@ void KX_KetsjiEngine::RenderDebugProperties()
 		unsigned propsAct = 0;
 		unsigned propsMax = (m_canvas->GetHeight() - ycoord) / const_ysize;
 
-		for (CListValue::iterator sceit = m_scenes->GetBegin(); sceit != m_scenes->GetEnd(); ++sceit) {
-			KX_Scene *scene = (KX_Scene *)*sceit;
+		for (CListValue::iterator<KX_Scene> sceit = m_scenes->GetBegin(), sceend = m_scenes->GetEnd(); sceit != sceend; ++sceit) {
+			KX_Scene *scene = *sceit;
 			/* the 'normal' debug props */
 			std::vector<SCA_DebugProp *>& debugproplist = scene->GetDebugProperties();
 
@@ -1753,8 +1753,8 @@ void KX_KetsjiEngine::Resize()
 	const RAS_FrameSettings &framesettings = firstscene->GetFramingType();
 
 	if (framesettings.FrameType() == RAS_FrameSettings::e_frame_extend) {
-		for (CListValue::iterator sceit = m_scenes->GetBegin(); sceit != m_scenes->GetEnd(); ++sceit) {
-			KX_Scene *scene = (KX_Scene *)*sceit;
+		for (CListValue::iterator<KX_Scene> sceit = m_scenes->GetBegin(), sceend = m_scenes->GetEnd(); sceit != sceend; ++sceit) {
+			KX_Scene *scene = *sceit;
 			KX_Camera *cam = scene->GetActiveCamera();
 			cam->InvalidateProjectionMatrix();
 		}

source/gameengine/Ketsji/KX_MouseFocusSensor.cpp

@@ -377,8 +377,8 @@ bool KX_MouseFocusSensor::ParentObjectHasFocus()
 
 	CListValue *cameras = m_kxscene->GetCameraList();
 
-	for (CListValue::iterator it = cameras->GetBegin(), end = cameras->GetEnd(); it != end; ++it) {
-		KX_Camera *cam = (KX_Camera*)(*it);
+	for (CListValue::iterator<KX_Camera> it = cameras->GetBegin(), end = cameras->GetEnd(); it != end; ++it) {
+		KX_Camera *cam = *it;
 		if ((cam != activecam) && cam->GetViewport())
 			if (ParentObjectHasFocusCamera(cam))
 				return true;

source/gameengine/Ketsji/KX_PythonInit.cpp

@@ -1082,8 +1082,8 @@ static PyObject *gPySetGLSLMaterialSetting(PyObject *,
 		if (KX_GetActiveEngine()) {
 			CListValue *scenes = KX_GetActiveEngine()->CurrentScenes();
 
-			for (CListValue::iterator it = scenes->GetBegin(); it != scenes->GetEnd(); ++it) {
-				KX_Scene *scene = (KX_Scene *)*it;
+			for (CListValue::iterator<KX_Scene> it = scenes->GetBegin(), end = scenes->GetEnd(); it != end; ++it) {
+				KX_Scene *scene = *it;
 				// temporarily store the glsl settings in the scene for the GLSL materials
 				scene->GetBlenderScene()->gm.flag = gs->glslflag;
 				if (scene->GetBucketManager()) {

source/gameengine/Ketsji/KX_Scene.cpp

@@ -977,8 +977,8 @@ SCA_IObject* KX_Scene::AddReplicaObject(class CValue* originalobject,
 	replica->InitComponents();
 	// Initialize components recursively.
 	CListValue *childrecursive = replica->GetChildrenRecursive();
-	for (CListValue::iterator it = childrecursive->GetBegin(), end = childrecursive->GetEnd(); it != end; ++it) {
-		KX_GameObject *gameobj = (KX_GameObject *)*it;
+	for (CListValue::iterator<KX_GameObject> it = childrecursive->GetBegin(), end = childrecursive->GetEnd(); it != end; ++it) {
+		KX_GameObject *gameobj = *it;
 		gameobj->InitComponents();
 	}
 	childrecursive->Release();
@@ -1417,8 +1417,8 @@ void KX_Scene::CalculateVisibleMeshes(RAS_IRasterizer* rasty,KX_Camera* cam, int
 	m_boundingBoxManager->Update(false);
 
 	// Update the object boudning volume box if the object had a deformer.
-	for (CListValue::iterator it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
-		KX_GameObject *gameobj = static_cast<KX_GameObject*>(*it);
+	for (CListValue::iterator<KX_GameObject> it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
+		KX_GameObject *gameobj = *it;
 		if (gameobj->GetDeformer()) {
 			/** Update all the deformer, not only per material.
 			 * One of the side effect is to clear some flags about AABB calculation.
@@ -1438,8 +1438,8 @@ void KX_Scene::CalculateVisibleMeshes(RAS_IRasterizer* rasty,KX_Camera* cam, int
 		 * since DBVT culling will only set it to false.
 		 * This is similar to what RAS_BucketManager does for RAS_MeshSlot culling.
 		 */
-		for (CListValue::iterator it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
-			KX_GameObject *gameobj = static_cast<KX_GameObject*>(*it);
+		for (CListValue::iterator<KX_GameObject> it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
+			KX_GameObject *gameobj = *it;
 			gameobj->SetCulled(true);
 		}
 
@@ -1473,8 +1473,8 @@ void KX_Scene::DrawDebug(RAS_IRasterizer *rasty)
 {
 	const bool showBoundingBox = KX_GetActiveEngine()->GetShowBoundingBox();
 	if (showBoundingBox) {
-		for (CListValue::iterator it = m_objectlist->GetBegin(); it != m_objectlist->GetEnd(); ++it) {
-			KX_GameObject *gameobj = (KX_GameObject *)*it;
+		for (CListValue::iterator<KX_GameObject> it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
+			KX_GameObject *gameobj = *it;
 
 			if (!gameobj->GetCulled() && gameobj->GetMeshCount() != 0) {
 				const MT_Vector3& scale = gameobj->NodeGetWorldScaling();
@@ -1500,8 +1500,8 @@ void KX_Scene::DrawDebug(RAS_IRasterizer *rasty)
 		}
 	}
 	// The side effect of a armature is that it was added in the animated object list.
-	for (CListValue::iterator it = m_animatedlist->GetBegin(), end = m_animatedlist->GetEnd(); it != end; ++it) {
-		KX_GameObject *gameobj = (KX_GameObject *)*it;
+	for (CListValue::iterator<KX_GameObject> it = m_animatedlist->GetBegin(), end = m_animatedlist->GetEnd(); it != end; ++it) {
+		KX_GameObject *gameobj = *it;
 		if (gameobj->GetGameObjectType() == SCA_IObject::OBJ_ARMATURE) {
 			BL_ArmatureObject *armature = (BL_ArmatureObject *)gameobj;
 			if (armature->GetDrawDebug() || KX_GetActiveEngine()->GetShowArmatures()) {
@@ -1704,10 +1704,10 @@ RAS_MaterialBucket* KX_Scene::FindBucket(class RAS_IPolyMaterial* polymat, bool
 void KX_Scene::RenderBuckets(const MT_Transform & cameratransform,
                              class RAS_IRasterizer* rasty)
 {
-	for (CListValue::iterator it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
+	for (CListValue::iterator<KX_GameObject> it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
 		/* This function update all mesh slot info (e.g culling, color, matrix) from the game object.
 		 * It's done just before the render to be sure of the object color and visibility. */
-		((KX_GameObject *)*it)->UpdateBuckets();
+		(*it)->UpdateBuckets();
 	}
 
 	m_bucketmanager->Renderbuckets(cameratransform,rasty);
@@ -1727,8 +1727,8 @@ void KX_Scene::UpdateObjectLods()
 	const MT_Vector3& cam_pos = m_active_camera->NodeGetWorldPosition();
 	const float lodfactor = m_active_camera->GetLodDistanceFactor();
 
-	for (CListValue::iterator it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
-		KX_GameObject *gameobj = (KX_GameObject *)*it;
+	for (CListValue::iterator<KX_GameObject> it = m_objectlist->GetBegin(), end = m_objectlist->GetEnd(); it != end; ++it) {
+		KX_GameObject *gameobj = *it;
 		if (!gameobj->GetCulled()) {
 			gameobj->UpdateLod(cam_pos, lodfactor);
 		}