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

Go to the documentation of this file.

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

#ifndef GAMEBASE_H
#define GAMEBASE_H

// Abstract definition of a game in Spring. Used to guide
// users and collect data during testing. Extend Game to
// define your own experiments.
//
// Based on game.h, created by Chris (caschwan@gmx.net)
//
// Author: Craig Cornelius (cwcornelius@stanford.edu)
// 
// History:
//      09-aug-2005     cwc             Created this file
//      30-aug-2005     cwc             Updated based on Chris's suggestions.
//
// 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.


// Refers to these classes below, but shouldn't include the .h files.
class springCore;

class gameBase {
protected:
        springCore* myappObject;

public: 
    int debug;    static const char* rcsid;

public:
        // The game can be created with knowledge of the application object.    
        // NULL is allowed, but doesn't make much sense.
    gameBase(springCore* main_app, char* params = 0);
    virtual ~gameBase();        

        // Returns pointer to the name assigned to this game.
        // This function must be provided by any derived class.
        virtual char* getName() = 0;

        // Set up all the local variables.  This may, for instance, read a file of      
        // data object descriptions.
        virtual void Initialize();      
        // Initialize graphical interfaces elements needed, e.g. popups, menu items, etc.       
        virtual void 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.
        virtual bool handleKeyboard(unsigned char key, int x, int y);

        // 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
        //  Inherited from Game class
        virtual void 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.
        virtual void Draw2D();          
        // called when in 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 stereo.
        virtual void Draw3D();
};

#endif   // GAMEBASE_H

---