ScreenExample2DSS.h

Go to the documentation of this file.

#ifndef _SCREEN_EXAMPLE_H
#define _SCREEN_EXAMPLE_H

/********************************************************
 * ScreenExample2DSS - Very basic screen for use on the *
 * Mercury Game Engine.  This is primarily for          *
 * educational purposes.                                *
 *                                                      *
 * LICENSE NOTE: We ask that if you use this code to    *
 * make your own screen based on this one, you simply   *
 * ammend the copyright notice at the end of this file  *
 * and its repective CPP.                               *
 ********************************************************/

#include "MercuryScreen.h"  //MercuryScreen: most of what you need for a secreen 

class ScreenExample2DSS : public MercuryScreen  //Abstract from MercuryScreen
{
public:

    //Basic constructors, you should not be doing anything in your constructors.
    //Everyhing you need to do on Init should be done on your init function.
    ScreenExample2DSS( ) { }
    ScreenExample2DSS( const MString & name ):MercuryScreen( name ) { m_name = name; }

    //Destructor, if you don't know what this is or why they can be useful,
    //you probally should not be using this example.
    virtual ~ScreenExample2DSS();

    //Init:     This is called once Mercury tries to display your screen. You
    //          should load any of your objects here, or intilize any of your
    //          data members.
    virtual void Init();

    //Update:   This is called once every game cycle, before the draw portion.
    //          You should include any thing game-related in this.  Moving
    //          objects around, sending information to other parts of the game,
    //          etc should all be done in this, not your draw.
    virtual void Update( const float dTime );

    //Message:  Used for receiving messages from the system.  In the base engine
    //          there is only input and focus messages, but you can have classes
    //          running concurrently to screens that can broadcast messages.
    //          this is how you receive them.
    virtual void Message( int Message, PStack & data, const MString & name );

    //Draw:     Used during the draw cycle.  This is optional.  We are using
    //          it in this case in order to treat the background specially.
    virtual void Draw();
private:
    //The following defines a milshape model for use in the screen.
    //A milkshape model is any three dimensional object created in Milkshape3D
    MercuryMilkshapeModel m_modMan;

    //All objects can contain children.  This is a useful way for managing
    //a large amount of objects that can fit togeather in a sort of group.
    MercuryObject m_objBoxes;
    vector< MercuryMilkshapeModel * > m_vBoxes;

    //Sprites... 2 dimensional objects that can only be viewed from the front.
    MercurySprite m_sprTitle;
    MercurySprite m_sprBackground;

    //Information regarding the game...
    
    //MercuryPoints:  A vector of sorts.  Among its members, it has an x, y and
    //z.  Basic vector math can be performed on it.

    //Information for "man"
    MercuryPoint m_pAcceleration;
    MercuryPoint m_pVelocity;
    MercuryPoint m_pLocation;

    //Private member function.  This is used to load the map (boxes) from the
    //file.
    void LoadMap( MString sFileName );

    //Variables for the special zooming (button c)
    bool m_bTightZoom;
    MercuryPoint m_pOldCamera;
};

#endif

/* 
 * Copyright (c) 2005-2006, Joshua Allen, Charles Lohr
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *  -   Redistributions of source code must retain the above
 *      copyright notice, this list of conditions and the following disclaimer.
 *  -   Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *  -   Neither the name of the Mercury Engine nor the names of its
 *      contributors may be used to endorse or promote products derived from
 *      this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

---

Hosted by