map.h

Go to the documentation of this file.

/*
 * map.h
 *
 * Copyright (C) 2007-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.
 *
 *
 * Definition of the basic aesop::map object.
 */

#ifndef AESOP_MAP_MAP_H__
#define AESOP_MAP_MAP_H__

// includes --------------------------------------------------------------------
#include "zone.h"                       // zone objects

#include <iostream>


namespace aesop {



struct destination_t {
        // constructor, manipulators
        destination_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        id[0] = 0;
                        rect.clear();
                }

        // data fields
        char                    id[eAESOP_IdBufferSize];
        rect3d_t                rect;           
};



typedef void (*zone_iteration_fn)(IN Zone * zone,
                                IN void * context);


class Map {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Map(void) throw();

        // aesop::Map class interface methods -----------------------------------
        virtual const char * getId(void) const throw() = 0;
        virtual Zone * getRootZone(void) throw() = 0;
        virtual Zone * getZone(IN const char * zone_id) = 0;
        virtual void iterateZones(IN zone_iteration_fn,
                                IN void * context) = 0;
        virtual const char * getDefaultStartingPointId(void) const throw() = 0;
        virtual void getStartingPointIds(OUT VecString& ids) const = 0;
        virtual void getStartingPoint(IN const char * id,
                                OUT destination_t& start) const = 0;
};

































smart_ptr<Map> loadMap(IN const char * id,
                                IN const char * path_to_map_file);



class MapFormatReader {
public:
        // virtual destructor --------------------------------------------------
        virtual ~MapFormatReader(void) throw();

        // aesop::MapFormatReader class interface methods -----------------------
        virtual const char * getDescription(void) = 0;
        virtual bool isMyFormat(IN const char * mapId,
                                IN const char * path_to_map_file) = 0;
        virtual smart_ptr<Map> loadMap(IN const char * mapId,
                                IN const char * path_to_map_file) = 0;
};



void registerMapFormatReader(IN smart_ptr<MapFormatReader>& reader);



};      // aesop namespace

#endif  // AESOP_MAP_MAP_H__