terminal.h

Go to the documentation of this file.

/*
 * terminal.h
 *
 * Copyright (C) 2008-2010  Thomas A. Vaughan
 * 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 <organization> 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 THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 *
 *
 * A "terminal" object here acts like a computer terminal: it manages display
 * and input for a single player.
 */

#ifndef AESOP_CLIENT_TERMINAL_H__
#define AESOP_CLIENT_TERMINAL_H__

// includes --------------------------------------------------------------------
#include "common/common.h"

#include "events.h"

#include "dialog/dialog.h"
#include "geometry/geometry_3d.h"
#include "gamepad/manager.h"
#include "map-kdtree/map-kdtree.h"
#include "viewport/viewport.h"


// forward declarations
namespace aesop {
        class MapDynamics;
}



namespace aesop {



class TerminalHost {
public:
        // aesop::TerminalHost class interface methods ------------------------

        virtual void requestMove(IN int playerId,
                                IN const point3d_t& delta,
                                IN const point3d_t& euler,
                                OUT point3d_t& newPosition) = 0;

        virtual void notifyInput(IN int playerId,
                                IN const event_t& event) = 0;

protected:
        // cannot delete through this interface! -------------------------------
        virtual ~TerminalHost(void) throw();
};


class Terminal : public view::Host {
public:
        virtual ~Terminal(void) throw();

        // aesop::Terminal class interface methods ------------------------------
        virtual void setKeys(IN smart_ptr<crypto::DESKey>& desKey,
                                IN smart_ptr<gamepad::Manager>& mgr) = 0;
        virtual void input(IN gamepad::Gamepad * gp,
                                IN float dt) = 0;
        virtual void mouseMove(IN int x, IN int y) = 0;
        virtual void mouseButton(IN int button, IN int state,
                                IN int x, IN int y) = 0;
        virtual void keyboard(IN int key, IN int mods) = 0;
        virtual void showDialog(IN const char * id,
                                IN const Datahash * dialog,
                                IN dialog::Host * host) = 0;
        virtual void destroyDialog(IN const char * id) = 0;
        virtual void notifyMap(IN MapKdTree * mapKdTree) = 0;  
        virtual void notifyInstance(IN smart_ptr<Instance>& instance) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<Terminal> create(IN TerminalHost * host,
                                IN int playerId,
                                IN smart_ptr<glut::RenderQueue>& rq);
};



};      // aesop namespace

#endif  // AESOP_CLIENT_TERMINAL_H__