Android游戏框架AndEngine使用入门.doc

Android游戏框架AndEngine使用入门
一、如何使用AndEngine：
1.1 AndEngine的基本运行原理:
解读AndEngine源码后我们可以发现，AndEngine除了采取低耦合、高内聚的框架策略细分引擎模块，使用OpenGLES进行游戏渲染之外；该引擎还以双线程方式分别驱动绘图与事务更新，事实上，它将游戏画面和游戏业务分为两组逻辑，并行跑在同级的互斥线程当中。
具体地说，其绘图线程位于AndEngine提供的GLSurfaceView内部类GLThread（在AndEngine的org.anddev.andengine.opengl.view包下，非Android默认的GLSurfaceView），并通过GLSurfaceView子类，即AndEngine提供的RenderSurfaceView类调用重载的onDrawFrame函数加以渲染控制；而业务线程在Engine类的内部类UpdateThread中，AndEngine将始终以while(true)这样的死循环方式快速执行其中的onTickUpdate函数，所有AndEngine提供的游戏业务最终都会由此函数调用及执行，比如AndEngine常用的registerUpdateHandler方法就是向它提交数据。
当AndEngine进行游戏绘图时，游戏业务线程会通过wait方式锁定，而当游戏业务处理时，也会以同样的手段锁定绘图线程，二者间具体交互关系由Engine类中的State子类控制，以此保证游戏画面与游戏业务同步。
另外，或许是考虑到持续双线程运行电量消耗较大的缘故，AndEngine默认情况下要求用户启动PowerManager进行电源管理，故此需要权限支持，否则初始化时Log会提示缺少相关配置，并建议你在AndroidManifest.xml中添加权限。PS:无此权限不影响运行，只会在Log有警告信息，并且耗电较快。
1.2 AndEngine的基本运行流程：
由于AndEngine是专供Android使用的2D游戏引擎，所以作为启动类的Activity肯定必不可少，而AndEngine也理所应当的提供给我们这样一个Activity，那就是BaseGameActivity。
一个标准的AndEngine应用，至少应该对BaseGameActivity做如下继承：
view plaincopy to clipboardprint?
1. public class Main extends BaseGameActivity {  
2.     public void onLoadComplete() {  
3.          
4.     }  
5.     public Engine onLoadEngine() {  
6.         return null;  
7.     }  
8.     public void onLoadResources() {  
9.          
10.     }  
11.     public Scene onLoadScene() {  
12.         return null;  
13.     }    
14. }  

其中四个必须被重载函数的启动顺序如下：

onLoadEngine->onLoadResources->onLoadScene->onLoadComplete

具体的讲，AndEngine会首先加载Engine类实例通知系统游戏引擎的基本运行方式，而后加载游戏资源，其次加载游戏场景实例，最后通过onLoadComplete通知用户加载完毕并于此进行善后工作。
此外，由于BaseGameActivity类重载了父类Activity的onResume与onPause函数以保证其自身的正常运行，所以不建议在继承BaseGameActivity时再次重载上述函数（重载的话不要忘记super调用）推荐直接重载AndEngine提供的onGamePaused和onGameResumed实现同等功能（最近把LGame也加上了这样的两个函数，并且禁止了LGameAndroid2DActivity子类重载onResume与onPause，务求减少用户错误重载导致的程序异常）。

1.3 AndEngine的基本运行方式：
上文介绍了AndEngine的基本运行机制与运行流程，然而仅仅这样AndEngine还是无法实际运行，因为Engine与Scene都没有获得具体实现。假如我们想要在屏幕上显示出当前应用FPS数，至少需要做如下改动，才能满足一个最为基本的AndEngine应用
view plaincopy to clipboardprint?
1. public class Main extends BaseGameActivity {  
2.     private static final int CAMERA_WIDTH = 320;  
3.     private static final int CAMERA_HEIGHT = 480;  
4.     private Camera andCamera;  
5.     private Texture myFontTexture;  
6.     private Font myFont;  
7.     public void onLoadComplete() {  
8.     }  
9.     public Engine onLoadEngine() {  
10.         // 构建摄像机   
11.         this.andCamera = new Camera(0, 0, CAMERA_WIDTH, CAMERA_HEIGHT);  
12.         // 构建Engine，全屏显示，手机方向为竖屏，按比例拉伸   
13.         return new Engine(new EngineOptionstrue, ScreenOrientation.PORTRAIT,  
14.                 new RatioResolutionPolicy(CAMERA_WIDTH, CAMERA_HEIGHT),  
15.                 this.andCamera));  
16.     }  
17.     public void onLoadResources() {  
18.         // 构建一个纹理用以显示文字   
19.         this.myFontTexture = new Texture(256, 256, TextureOptions.DEFAULT);  
20.         // 构建字体   
21.         this.myFont = new Font(this.myFontTexture, Typeface.create(  
22.                 Typeface.DEFAULT, Typeface.BOLD), 32, true, Color.WHITE);  
23.         // 注入相关纹理及字体   
24.         this.mEngine.getTextureManager().loadTexture(this.myFontTexture);  
25.         this.mEngine.getFontManager().loadFont(this.myFont);  
26.     }  
27.     public Scene onLoadScene() {  
28.         // 构建场景，允许的最大Layer数量为1   
29.         final Scene scene = new Scene(1);  
30.         // 使用可以变更内容的ChangeableText显示FPS(它的父类Text不允许改变显示内容)，位置在15,5,   
31.         // 字体为myFont中所规定的，最多允许显示5个字符(设置能显示几个字符，实际就能显示几个，   
32.         // AndEngine不能自动扩充，不填以初始化时输入的字符数计算……)   
33.         final ChangeableText text = new ChangeableText(5, 5, this.myFont,  
34.                 "0.0", 5);  
35.         // 注册FPS监听   
36.         this.mEngine.registerUpdateHandler(new FPSLogger() {  
37.             protected void onHandleAverageDurationElapsed(final float pFPS) {  
38.                 super.onHandleAverageDurationElapsed(pFPS);  
39.                 // 传递内容到ChangeableText   
40.                 text.setText("" + pFPS);  
41.             }  

42.         });  
43.         // 将ChangeableText注入场景   
44.         scene.attachChild(text);  
45.         // 构建场景，可容纳图层数为1   
46.         return scene;  
47.     }  
48. }  
运行效果如下图所示：

另外，事实上BaseGameActivity并非AndEngine提供的唯一Activity，其UI包下尚有以SplashScene场景作为特效启动的BaseSplashActivity类，以及通过重载getLayoutID与getRenderSurfaceViewID这两个抽象函数，调用指定布局与视图的LayoutGameActivity类。不过除了上述特点，它们与BaseGameActivity就再无区别了。

二、如何使用AndEngine中的常用功能：
事实上，AndEngine中组件颗粒都非常细小，几乎每个由AndEngine提供的功能都会有一个对应的类存在；个人认为，AndEngine将许多很小很小的功能，做成了太多太多的模块，似乎有些封装过度。
  比如仅Engine就衍生出DoubleSceneSplitScreenEngine（可以同时显示并缓存两个Scene的Engine，通过setFirstScene以及setSecondScene进行双屏切换，即分屏用Engine）、SingleSceneSplitScreenEngine（与DoubleSceneSplitScreenEngine类似，但一次只能显示一个画面）、LimitedFPSEngine（可限制FPS速度的Engine，重载了标准Engine的onUpdate函数，减速方式为常见的线程延迟）、FixedStepEngine（与LimitedFPSEngine近似，重载了标准Engine的onUpdate函数，但是它通过反复while方式最大限度矫正AndEngine内部计时器的累加数值，以求每次线程主循环的帧数都与预想帧数相等）等许多子类（目前细分还在不断增加）。
  其实，这些功能完全可以进行统一实现，而不必占据那么的应用空间与用户记忆细胞（PS:有日本人（疑似，服务器在东京）做过一个叫e3roid的同类项目，虽然结构异常近似AndEngine，个人认为具体实现却比AndEngine更合理，项目在：，有时间小弟会单独介绍一下）。
当然，这篇文章是对AndEngine的使用入门，而并非对AndEngine的“抱怨入门”，所以下面开始，小弟将对AndEngine的主要功能进行初步讲解。

2.1 AndEngine的IUpdateHandler接口：
IUpdateHandler类是AndEngine引擎中使用频率非常之高的组件之一，其本身是一个接口，内部有onUpdate以及reset两个函数等待实现，几乎所有AndEngine应用中都必然会看到它的身影，它也是AndEngine添加具体业务到游戏业务线程中的主要方法之一。
具体的讲，所有通过AndEngine中registerUpdateHandler函数注册的IUpdateHandler，都会被保存到一个叫做UpdateHandlerList的IUpdateHandler接口集合当中。虽然UpdateHandlerList本身也是一个IUpdateHandler接口的实现，然而它的地位却比较特殊，基本只存在于Engine及Scene类中，并只供Engine类中的onTickUpdate函数调用（PS：Scene类中虽有独立的UpdateHandlerList，但事实上它依旧只被Engine中的onTickUpdate执行）。每当AndEngine业务线程循环onTickUpdate这个Engine内部方法时，都会调用UpdateHandlerList中存在的所有IUpdateHandler，直到注销相关的IUpdateHandler实例为止。
另外，与UpdateHandlerList集合类作用类似的还有RunnableHandler类，该类同样是IUpdateHandler的具体实现，它的作用在于保存并执行一次标准Runnable（每次业务循环后都会清空RunnableHandler的内部数据）。该类在AndEngine业务线程中的执行时机略早于UpdateHandlerList，我们可以通过RunnableHandler类中的postRunnable函数，或Engine类中的runOnUpdateThread函数添加Runnable到该集合（runOnUpdateThread函数为postRunnable函数的调用封装，Engine类及相关子类，BaseGameActivity类及相关子类中可见）。

2.2 AndEngine的Async方法：
默认情况下，AndEngine的资源加载会在构建Engine之后，调用onLoadResources函数时进行同步加载。但如果一次性加载资源太多时，便可能会面临一个问题，那就是Android系统将自动关闭长期无响应的UI。所以一旦采取同步执行的加载策略，数据量过大时就有可能将我们的APK卡死。因此，这就需要异步加载策略来解决问题，而AndEngine也确实提供了我们这样的异步加载方式。
具体的讲，AndEngine对Android系统自带的AsyncTask类进行了适当封装（具体封装在BaseActivity类中，该类为BaseGameActivity的父类，AndEngine由此类开始实际继承Activity，但BaseGameActivity的主要功能并不在此类），只要通过doAsync或者doProgressAsync函数就可以调用，实现代码如下所示：
view plaincopy to clipboardprint?
1. public class Main extends BaseGameActivity {  
2.     private static final int CAMERA_WIDTH = 320;  
3.     private static final int CAMERA_HEIGHT = 480;  
4.     private Camera andCamera;  
5.     public void onLoadComplete() {  
6.     }  
7.     public Engine onLoadEngine() {  
8.         // 构建摄像机   
9.         this.andCamera = new Camera(0, 0, CAMERA_WIDTH, CAMERA_HEIGHT);  
10.         // 构建Engine，全屏显示，手机方向为竖屏，按比例拉伸   
11.         return new Engine(new EngineOptions(true, ScreenOrientation.PORTRAIT,  
12.                 new RatioResolutionPolicy(CAMERA_WIDTH, CAMERA_HEIGHT),  
13.                 this.andCamera));  
14.     }  
15.     public void onLoadResources() {  
16.         // 运行一个异步加载，设定内部ProgressDialog标题为资源索引test1对应的字符，内容为test2对应的资源   
17.         this.doAsync(R.string.test1, R.string.test2, new Callable() {  
18.             // 希望AndEngine异步加载的数据   
19.             public Void call() throws Exception {  
20.                 for (int i = 0; i < Integer.MAX_VALUE; i++) {  
21.                 }  
22.                 return null;  
23.             }  
24.             // 当加载完成后回调，可在此进行一些加载完毕的事后处理   
25.         }, new org.anddev.andengine.util.Callback() {  
26.             public void onCallback(final Void pCallbackValue) {  
27.                 Log.d("Callback", "over")  
28.             }  
29.         });  
30.     }  
31.     public Scene onLoadScene() {  
32.         // 构建场景，允许的最大Layer数量为1   
33.         final Scene scene = new Scene(1);  
34.         return scene;  
35.     }  
36. }  

 效果图如下所示：

2.3 AndEngine中的精灵调用：
精灵类，是一个大家耳熟能详，并且任何游戏引擎无法回避的关键性组件之一，它常常被用来表示一个游戏中角色或者特定画面要素。如此重要的存在，AndEngine当然也不能缺少，其精灵类的基本使用方法如下所示：
view plaincopy to clipboardprint?
1. public class Main extends BaseGameActivity {  
2.     private static final int CAMERA_WIDTH = 320;  
3.     private static final int CAMERA_HEIGHT = 480;  
4.     private Camera andCamera;  
5.     private TextureRegion myTextureRegion;  
6.     public void onLoadComplete() {  
7.     }  
8.     public Engine onLoadEngine() {  
9.         // 构建摄像机   
10.         this.andCamera = new Camera(0, 0, CAMERA_WIDTH, CAMERA_HEIGHT);  
11.         // 构建Engine，全屏显示，手机方向为竖屏，按比例拉伸   
12.         return new Engine(new EngineOptions(true, ScreenOrientation.PORTRAIT,  
13.                 new RatioResolutionPolicy(CAMERA_WIDTH, CAMERA_HEIGHT),  
14.                 this.andCamera));  
15.     }  
16.     public void onLoadResources() {  
17.         //构建纹理   
18.         Texture myTexture = new Texture(64, 64, TextureOptions.DEFAULT);  
19.         //加载指定路径纹理到myTextureRegion   
20.         this.myTextureRegion = TextureRegionFactory.createFromAsset(myTexture,  
21.                 this, "Ball.png", 0, 0);  
22.         //载入纹理到TextureManager   
23.         this.getEngine().getTextureManager().loadTextures(myTexture);  
24.     }  
25.     public Scene onLoadScene() {  
26.         // 构建场景，允许的最大Layer数量为1   
27.         final Scene scene = new Scene(1);  
28.         // 以myTextureRegion构建Sprite(TextureRegion内部有Texture的引用，AndEngine在构建Sprite时一起加载了)，到坐标55,55   
29.         Sprite sprite = new Sprite(55, 55, myTextureRegion);  
30.         // 添加精灵   
31.         scene.attachChild(sprite);  
32.         return scene;  
33.     }  
34. }  
2.3 AndEngine的精灵动画：
绝大多数的游戏开发中，仅仅有精灵类存在是并不足够的，我们往往还需要让精灵作出绚丽的效果以吸引用户眼球，而这些效果在AndEngine中，统一通过它所提供的各个Modifier类进行实现。具体调用代码如下所示：
view plaincopy to clipboardprint?
1. public class Main extends BaseGameActivity {  
2.     private static final int CAMERA_WIDTH = 320;  
3.     private static final int CAMERA_HEIGHT = 480;  
4.     private Camera andCamera;  
5.     private TextureRegion myTextureRegion;  
6.     public void onLoadComplete() {  
7.     }  
8.     public Engine onLoadEngine() {  
9.         // 构建摄像机   
10.         this.andCamera = new Camera(0, 0, CAMERA_WIDTH, CAMERA_HEIGHT);  
11.         // 构建Engine，全屏显示，手机方向为竖屏，按比例拉伸   
12.         return new Engine(new EngineOptions(true, ScreenOrientation.PORTRAIT,  
13.                 new RatioResolutionPolicy(CAMERA_WIDTH, CAMERA_HEIGHT),  
14.                 this.andCamera));  
15.     }  
16.     public void onLoadResources() {  
17.         // 构建纹理   
18.         Texture myTexture = new Texture(64, 64, TextureOptions.DEFAULT);  
19.         // 加载指定路径纹理到myTextureRegion   
20.         this.myTextureRegion = TextureRegionFactory.createFromAsset(myTexture,  
21.                 this, "Ball.png", 0, 0);  
22.         // 载入纹理到TextureManager   
23.         this.getEngine().getTextureManager().loadTextures(myTexture);  
24.     }  
25.     public Scene onLoadScene() {  
26.         // 在Log中显示FPS数   
27.         getEngine().registerUpdateHandler(new FPSLogger());  
28.         // 构建场景，允许的最大Layer数量为1   
29.         final Scene scene = new Scene(1);  
30.         // 获得相对中心坐标   
31.         final int centerX = (CAMERA_WIDTH - this.myTextureRegion.getWidth()) / 2;  
32.         final int centerY = (CAMERA_HEIGHT - this.myTextureRegion.getHeight()) / 2;  
33.         // 以myTextureRegion构建Sprite(TextureRegion内部有Texture的引用，AndEngine在构建Sprite时一起加载了)，到屏幕中心   
34.         final Sprite sprite = new Sprite(centerX, centerY, this.myTextureRegion);  
35.         // 添加精灵   
36.         scene.attachChild(sprite);  
37.         // 制作一组动作序列，首先10秒内不断顺时针旋转360度，而后10秒内不断逆时针旋转360度   
38.         SequenceEntityModifier ballAction = new SequenceEntityModifier(  
39.                 new RotationModifier(10, 0, 360), new RotationModifier(10, 360,  
40.                         0));  
41.         // 注册动作序列到精灵   
42.         sprite.registerEntityModifier(ballAction);  
43.         return scene;  
44.     }  
45. }  
效果如下图所示：

三、AndEngine的常用模块介绍：
由于AndEngine包的下属类较多，并且细分也较为庞杂，在一篇文章中一次性介绍完毕几乎不可能实现。所以下面开始，小弟会就AndEngine的一些核心模块进行简明扼要的说明，但如果前文做过说明的下文会一笔带过。
PS：事实上，就连AndEngine作者也不可能做到详细介绍，毕竟到目前为止AndEngine压根没有出过文档。（连andengineexamples下的示例代码都已经和最新的AndEngine源码脱离了……）

1、关于Engine:
Engine是AndEngine的核心所在，它对AndEngine引擎中Camera、Scene等重要组件进行了统一管理，但必须和BaseGameActivity合作使用，利用EngineOptions类可以对其进行必要的参数配置。
2、关于BaseGameActivity:
如果您想正常使用AndEngine，那么当前Activity就必须继承自BaseGameActivity或其子类，否则你连初始化Engine也做不到。虽然它还有父类BaseActivity，但BaseActivity只提供了一些异步加载方法而无关AndEngine的主体实现。因此，BaseGameActivity就是实际上的AndEngine最基础用类无疑。
3、关于IResolutionPolicy:
IResolutionPolicy是一个接口类，其中只规定了onMeasure函数的实现格式。事实上，AndEngine中所有该类具体实现的作用与标准View中的onMeasure函数几乎一致，也会被标准View中的onMeasure函数重载调用（具体调用在AndEngine的RenderSurfaceView类当中）。而且除BaseResolutionPolicy外，所有AndEngine的IResolutionPolicy实现也都调用了View的setMeasuredDimensionProxy函数。
在AndEngine的org.anddev.andengine.engine.options.resolutionpolicy包下有一组IResolutionPolicy接口的具体实现，分别为BaseResolutionPolicy（除了会校验一下屏幕大小外，什么也不做）、FillResolutionPolicy（拉伸游戏画面为全屏填充，视摄像机大小不同，会有不同程度变形）、FixedResolutionPolicy（强行规定游戏画面为固定大小，此设置不会自动适应屏幕大小），RatioResolutionPolicy（按比例修正画面大小，以适应屏幕大小），RelativeResolutionPolicy（根据构建RelativeResolutionPolicy时的缩放参数，缩放游戏屏幕为指定比例）。
最后，所有IResolutionPolicy的实现类，都要随着EngineOptions于初试化时传递给Engine实例才起作用。
4、关于Camera:
该类即我们常说的游戏摄像机，在AndEngine的Camera有两种作用，一是用以调节屏幕的显示区域，二是利用HUD类实际绘制游戏屏幕于手机之上。
5、关于Scene:
场景容器，作用类似于LGame中的Screen，能够将某一特定场景作为游戏模块进行调用，我们可以利用它来切换当前游戏的画面与触摸屏监听，切换方法是利用Engine.setScene。
6、关于Entity:
Entity是IEntity接口的具体实现，也是AndEngine中无论Scene、Layer、Sprite(这个继承关系比较远，中间隔了BaseRectangle、RectangularShape、GLShape、Shape等上级类，不过追溯源头始终继承自Entity)的统一父类，通过Entity我们可以让AndEngine中场景，或场景中某精灵实现统一效果的缩放、旋转、变色等操作。
7、关于Texture:
Texture是AndEngine所提供的纹理用类，但Texture本身（在AndEngine中）并没有提供加载图片的方法，必须通过TextureRegionFactory类（更准确的说，依赖它内部封装的TextureRegion、BuildableTexture等类）与之合作才可以加载纹理。除此之外，AndEngine要求所加载纹理（图片）大小必须为2的整数次幂。
8、关于TextureRegion:
TextureRegion的父类是抽象类BaseTextureRegion，主要功能也被封装在BaseTextureRegion类当中，AndEngine提供了TextureRegionFactory这个工厂类用以简化构建TextureRegion的流程。单就TextureRegion来讲，它的作用似乎就是让系统知道如何剪切一个纹理，并返回一个这样的纹理给你。
然而，事实上AndEngine中只有TextureRegion才更接近于通常意义上的Texture。或者说，只有TextureRegion + Texture时，我们才能较为完整的使用AndEngine纹理功能。严肃的讲，AndEngine中的Texture有很多功能必须靠TextureRegion最终完成，比如AndEngine中的Sprite必须加载TextureRegion才能使用Texture，而不是直接调用Texture，TMXTiledMap中读取指定瓦片返回的也是TextureRegion，而非直接的Texture（进行画面渲染时AndEngine内部会调用TextureRegion中的Te