/Users/craigcornelius/Projects/SPRING Mac Release 0.2/gameBase.cpp

Go to the documentation of this file.

// $Id: gameBase.cpp,v 1.6 2006/05/24 16:52:39 sean Exp $ 
// $Copyright: (c)2001 National Biocomputation Center, Stanford University $

// 
// gameBase.cpp
//
// A base class for defining SPRING games, including common actions
// and interfaces with SPRING to define, initialize, operate, and give
// feedback from a game / scenario.

// The base class has general functions, but does not explicitly include
// the concept of a game "state"
// ?? Should I make basic states: {created, initialized, running, complete}

// History:
// 24-Aug-05    cwc             Started this base class.


// Informational:
// A game is implemented by having its functions called from the appropriate
// portions of SPRING:
//              instantiate object
//              Set up GUI
//              Initialization
//              

// Note that non-object based individual functions may be included in a games file
// where the interfaces won't accept a C++ member function, e.g. callbacks for some
// GUI toolkits such as GLUT, GLOW, etc.

// The game can be created with knowledge of the global universe object

#include <stdlib.h>
#include <string.h>

#include "gameBase.h"

gameBase::gameBase(springCore* main_app, char* param)
{
        myappObject = main_app;

        debug = 0;
}


// Desctructor - nothing local in the base class needs to be cleaned up.
gameBase::~gameBase()
{

}


// Set up all the local variables.  This may, for instance, read a file of
// data object descriptions.
void gameBase::Initialize()
{
}
        
// Initialize graphical interfaces elements needed, e.g. popups, menu items, etc.
void gameBase::setupGUI()
{
}

// Called, when keyboard events occur. If 0 is returned, the main SPRING 
// application will handle the key event. If 1 is returned, SPRING itself will
// NOT handle the key event. x and y donate the current mouse coordinates when
// the key was pressed.
bool gameBase::handleKeyboard(unsigned char key, int x, int y)
{
        // indicates, that the key event was not processed and SPRING itself should handle
        // it.
        return 0;
}

// Update implements the logic and rules of the game by observing 
// changes in the universe, then checks if the state of the game
// has been changed.
// This is called after the sensors and universe have been updated
void gameBase::Update()
{
}


// Draws 2D information over the displayed image.
// Normally used for user feedback and metrics, time information, etc.
// This is called in the springCore's Draw2D function.
void gameBase::Draw2D()
{
}


// Draws 3D information over the image, if desired.
// 3-D graphical enhancements may be desirable in some game scenarios.
// This is called in DisplayOnce, *after* all the other items have been drawn.
// This allows it to appear in whatever views Display needs, including stereo.
void gameBase::Draw3D()
{
}

---