Public Member Functions | Protected Member Functions

psastras::engine::EngineActivity Class Reference

Inheritance diagram for psastras::engine::EngineActivity:
Inheritance graph
[legend]
Collaboration diagram for psastras::engine::EngineActivity:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void onCreate (Bundle savedInstanceState)
abstract EngineSettings onStartup ()
void onEngineFinalized ()
void onEngineStarted ()

Protected Member Functions

void onPause ()
void onResume ()

Detailed Description

The EngineActivity is an instance of the Android.app.Activity, and is the main Activity of the Application. It is responsible for setting up the Engine and calling the appropriate initialization methods. When writing an application, it should subclass the EngineActivity as its main Activity. At certain points during Engine initialization, the EngineActivity will call certain methods, which can be reimplemented if desired. However, any subclass must reimplement onStartup() which should return the EngineSettings which will be used to instantiate the Engine.

Author:
psastras

Member Function Documentation

void psastras::engine::EngineActivity::onCreate ( Bundle  savedInstanceState  )  [inline]

This method is reimplemented from the Activity base class. This is where the Engine is instantiated and initialized the the EngineSettings returned by onStartup().

void psastras::engine::EngineActivity::onEngineFinalized (  )  [inline]

Called after the engine has been initialized. Resources and engine logical handlers should be initialized here. Handlers can be added to the Engine by using the addHandler() method.

void psastras::engine::EngineActivity::onEngineStarted (  )  [inline]

This method is called after the Engine has been started and is running. This method does nothing, but can be reimplemented to do something useful once the Engine has started running.

abstract EngineSettings psastras::engine::EngineActivity::onStartup (  )  [pure virtual]

Called before the engine has been created. Should return the Engine settings you wish to initialize the engine with.

Returns:
EngineSettings to initilize the Engine with.

The documentation for this class was generated from the following file:
 All Classes Functions Variables