mapzone.h

Go to the documentation of this file.

/*
 * mapzone.h
 *
 * Copyright (C) 2008,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.
 *
 *
 * Entry point for the mapzone library.  See the aesop-map headers.
 * Basically, this is a particular implementation of maps + zones.
 */

#ifndef AESOP_MAPZONE_H__
#define AESOP_MAPZONE_H__

// includes --------------------------------------------------------------------
#include "aesop-map/map.h"


namespace mapzone {



//
//      public API
//

smart_ptr<aesop::MapFormatReader> getMapFormatReader(void);



//
//      internals
//
//      Don't use these outside of the mapzone library!
//

typedef std::map<std::string, smart_ptr<aesop::Zone> > zone_map_t;


// load maps + zones from streams (don't use these!  Use getMapFormatReader()
smart_ptr<aesop::Map> loadMap(IN const char * id,
                                IN std::istream& stream);

smart_ptr<aesop::Zone> loadZone(IN std::istream& stream,
                                IN aesop::Zone::eType type);

// again, internal only.  After all zones are loaded, zones can resolve IDs
void resolveZoneIds(IN aesop::Zone * zone,
                                IN zone_map_t& map);

// internal only.  third pass of loading!
void calcBoundaries(IN aesop::Zone * zone);


};      // mapzone namespace

#endif  // AESOP_MAPZONE_H__