map-manager.h

Go to the documentation of this file.

/*
 * map-manager.h
 *
 * Copyright (C) 2009  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.
 *
 * Server-side map management.
 */

#ifndef AESOP_MAP_MANAGER_H__
#define AESOP_MAP_MANAGER_H__

// includes --------------------------------------------------------------------
#include "map-dynamics/map-dynamics.h"
#include "story/story.h"


namespace aesop {

/// \ingroup aesop_map_mgmt
/// \defgroup map_manager Map Manager
///
/// This library helps to maintain lists of active (in-memory) maps.
/*@{*/


/// Object that helps the server (and rules engine) manage loaded maps,
/// including the dynamics.
///
/// This map manager is used on the client and the server.  So there is no
/// dependency on specific rendering engines or input allowed, \e etc. 
///
/// NOTE: (to implementers) these calls must be threadsafe!
///
/// Loading maps is *very* expensive and must be on separate threads without
/// locking mutex's for a long time etc.
class MapManager {
public:
        // public typedefs -----------------------------------------------------
        struct iterator_t {
        private:
                byte_t          opaque[8 * sizeof(long)];
        };

        // virtual destructor --------------------------------------------------
        virtual ~MapManager(void) throw();

        // aesop::MapManager class interface methods ---------------------------
        virtual void clear(void) = 0;
        virtual void requestLoad(IN const char * id) = 0;
        virtual smart_ptr<MapDynamics> getMap(IN const char * id) = 0;
        virtual void tickMaps(IN float seconds) = 0;
        virtual void getIterator(OUT iterator_t& i) = 0;
        virtual bool getNextMap(IO iterator_t& i,
                                OUT smart_ptr<MapDynamics>& map) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<MapManager> create(IN smart_ptr<Datahash>& params,
                                IN smart_ptr<story::Story>& story);
};



};      // aesop namespace

#endif  // AESOP_MAP_MANAGER_H__