BaseGameActivity.java :  » Graphics-3D-2D-OpenGL » andengine » org » anddev » andengine » ui » activity » Android Open Source

package org.anddev.andengine.ui.activity;

import static android.view.ViewGroup.LayoutParams.FILL_PARENT;

import org.anddev.andengine.audio.music.MusicManager;
import org.anddev.andengine.audio.sound.SoundManager;
import org.anddev.andengine.engine.Engine;
import org.anddev.andengine.engine.options.EngineOptions;
import org.anddev.andengine.engine.options.WakeLockOptions;
import org.anddev.andengine.entity.scene.Scene;
import org.anddev.andengine.opengl.view.RenderSurfaceView;
import org.anddev.andengine.sensor.accelerometer.AccelerometerSensorOptions;
import org.anddev.andengine.sensor.accelerometer.IAccelerometerListener;
import org.anddev.andengine.sensor.location.ILocationListener;
import org.anddev.andengine.sensor.location.LocationSensorOptions;
import org.anddev.andengine.sensor.orientation.IOrientationListener;
import org.anddev.andengine.sensor.orientation.OrientationSensorOptions;
import org.anddev.andengine.ui.IGameInterface;
import org.anddev.andengine.util.Debug;

import android.content.Context;
import android.content.pm.ActivityInfo;
import android.media.AudioManager;
import android.os.Bundle;
import android.os.PowerManager;
import android.os.PowerManager.WakeLock;
import android.view.Gravity;
import android.view.Window;
import android.view.WindowManager;
import android.widget.FrameLayout.LayoutParams;

/**
 * @author Nicolas Gramlich
 * @since 11:27:06 - 08.03.2010
 */
public abstract class BaseGameActivity extends BaseActivity implements IGameInterface {
  // ===========================================================
  // Constants
  // ===========================================================

  // ===========================================================
  // Fields
  // ===========================================================

  protected Engine mEngine;
  private WakeLock mWakeLock;
  protected RenderSurfaceView mRenderSurfaceView;
  protected boolean mHasWindowFocused;
  private boolean mPaused;
  private boolean mGameLoaded;

  // ===========================================================
  // Constructors
  // ===========================================================

  @Override
  protected void onCreate(final Bundle pSavedInstanceState) {
    super.onCreate(pSavedInstanceState);
    this.mPaused = true;

    this.mEngine = this.onLoadEngine();

    this.applyEngineOptions(this.mEngine.getEngineOptions());

    this.onSetContentView();
  }

  @Override
  protected void onResume() {
    super.onResume();

    if(this.mPaused && this.mHasWindowFocused) {
      this.doResume();
    }
  }

  @Override
  public void onWindowFocusChanged(final boolean pHasWindowFocus) {
    super.onWindowFocusChanged(pHasWindowFocus);

    if(pHasWindowFocus) {
      if(this.mPaused) {
        this.doResume();
      }
      this.mHasWindowFocused = true;
    } else {
      if(!this.mPaused) {
        this.doPause();
      }
      this.mHasWindowFocused = false;
    }
  }

  @Override
  protected void onPause() {
    super.onPause();

    if(!this.mPaused) {
      this.doPause();
    }
  }

  @Override
  protected void onDestroy() {
    super.onDestroy();

    this.mEngine.interruptUpdateThread();

    this.onUnloadResources();
  }

  @Override
  public void onUnloadResources() {
    if(this.mEngine.getEngineOptions().needsMusic()) {
      this.getMusicManager().releaseAll();
    }
    if(this.mEngine.getEngineOptions().needsSound()) {
      this.getSoundManager().releaseAll();
    }
  }

  // ===========================================================
  // Getter & Setter
  // ===========================================================

  public Engine getEngine() {
    return this.mEngine;
  }

  public SoundManager getSoundManager() {
    return this.mEngine.getSoundManager();
  }

  public MusicManager getMusicManager() {
    return this.mEngine.getMusicManager();
  }

  // ===========================================================
  // Methods for/from SuperClass/Interfaces
  // ===========================================================

  @Override
  public void onGameResumed() {

  }

  @Override
  public void onGamePaused() {

  }

  // ===========================================================
  // Methods
  // ===========================================================

  private void doResume() {
    if(!this.mGameLoaded) {
      this.onLoadResources();
      final Scene scene = this.onLoadScene();
      this.mEngine.onLoadComplete(scene);
      this.onLoadComplete();
      this.mGameLoaded = true;
    }

    this.mPaused = false;
    this.acquireWakeLock(this.mEngine.getEngineOptions().getWakeLockOptions());
    this.mEngine.onResume();

    this.mRenderSurfaceView.onResume();
    this.mEngine.start();
    this.onGameResumed();
  }

  private void doPause() {
    this.mPaused = true;
    this.releaseWakeLock();

    this.mEngine.onPause();
    this.mEngine.stop();
    this.mRenderSurfaceView.onPause();
    this.onGamePaused();
  }

  public void runOnUpdateThread(final Runnable pRunnable) {
    this.mEngine.runOnUpdateThread(pRunnable);
  }

  protected void onSetContentView() {
    this.mRenderSurfaceView = new RenderSurfaceView(this);
    this.mRenderSurfaceView.setEGLConfigChooser(false);
    this.mRenderSurfaceView.setRenderer(this.mEngine);

    this.setContentView(this.mRenderSurfaceView, this.createSurfaceViewLayoutParams());
  }

  private void acquireWakeLock(final WakeLockOptions pWakeLockOptions) {
    if(pWakeLockOptions == WakeLockOptions.SCREEN_ON) {
      this.getWindow().addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON);
    } else {
      final PowerManager pm = (PowerManager) this.getSystemService(Context.POWER_SERVICE);
      this.mWakeLock = pm.newWakeLock(pWakeLockOptions.getFlag() | PowerManager.ON_AFTER_RELEASE, "AndEngine");
      try {
        this.mWakeLock.acquire();
      } catch (final SecurityException e) {
        Debug.e("You have to add\n\t<uses-permission android:name=\"android.permission.WAKE_LOCK\"/>\nto your AndroidManifest.xml !", e);
      }
    }
  }

  private void releaseWakeLock() {
    if(this.mWakeLock != null && this.mWakeLock.isHeld()) {
      this.mWakeLock.release();
    }
  }

  private void applyEngineOptions(final EngineOptions pEngineOptions) {
    if(pEngineOptions.isFullscreen()) {
      this.requestFullscreen();
    }

    if(pEngineOptions.needsMusic() || pEngineOptions.needsSound()) {
      this.setVolumeControlStream(AudioManager.STREAM_MUSIC);
    }

    switch(pEngineOptions.getScreenOrientation()) {
      case LANDSCAPE:
        this.setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE);
        break;
      case PORTRAIT:
        this.setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_PORTRAIT);
        break;
    }
  }

  protected LayoutParams createSurfaceViewLayoutParams() {
    final LayoutParams layoutParams = new LayoutParams(FILL_PARENT, FILL_PARENT);
    layoutParams.gravity = Gravity.CENTER;
    return layoutParams;
  }

  private void requestFullscreen() {
    final Window window = this.getWindow();
    window.addFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN);
    window.clearFlags(WindowManager.LayoutParams.FLAG_FORCE_NOT_FULLSCREEN);
    window.requestFeature(Window.FEATURE_NO_TITLE);
  }

  protected void enableVibrator() {
    this.mEngine.enableVibrator(this);
  }

  /**
   * @see {@link Engine#enableLocationSensor(Context, ILocationListener, LocationSensorOptions)}
   */
  protected void enableLocationSensor(final ILocationListener pLocationListener, final LocationSensorOptions pLocationSensorOptions) {
    this.mEngine.enableLocationSensor(this, pLocationListener, pLocationSensorOptions);
  }

  /**
   * @see {@link Engine#disableLocationSensor(Context)}
   */
  protected void disableLocationSensor() {
    this.mEngine.disableLocationSensor(this);
  }

  /**
   * @see {@link Engine#enableAccelerometerSensor(Context, IAccelerometerListener)}
   */
  protected boolean enableAccelerometerSensor(final IAccelerometerListener pAccelerometerListener) {
    return this.mEngine.enableAccelerometerSensor(this, pAccelerometerListener);
  }

  /**
   * @see {@link Engine#enableAccelerometerSensor(Context, IAccelerometerListener, AccelerometerSensorOptions)}
   */
  protected boolean enableAccelerometerSensor(final IAccelerometerListener pAccelerometerListener, final AccelerometerSensorOptions pAccelerometerSensorOptions) {
    return this.mEngine.enableAccelerometerSensor(this, pAccelerometerListener, pAccelerometerSensorOptions);
  }

  /**
   * @see {@link Engine#disableAccelerometerSensor(Context)}
   */
  protected boolean disableAccelerometerSensor() {
    return this.mEngine.disableAccelerometerSensor(this);
  }

  /**
   * @see {@link Engine#enableOrientationSensor(Context, IOrientationListener)}
   */
  protected boolean enableOrientationSensor(final IOrientationListener pOrientationListener) {
    return this.mEngine.enableOrientationSensor(this, pOrientationListener);
  }

  /**
   * @see {@link Engine#enableOrientationSensor(Context, IOrientationListener, OrientationSensorOptions)}
   */
  protected boolean enableOrientationSensor(final IOrientationListener pOrientationListener, final OrientationSensorOptions pLocationSensorOptions) {
    return this.mEngine.enableOrientationSensor(this, pOrientationListener, pLocationSensorOptions);
  }

  /**
   * @see {@link Engine#disableOrientationSensor(Context)}
   */
  protected boolean disableOrientationSensor() {
    return this.mEngine.disableOrientationSensor(this);
  }

  // ===========================================================
  // Inner and Anonymous Classes
  // ===========================================================
}