src/lib/gshhs.hpp

//
// AutoCoast: Automatic Coastline scenery generator for Flight Simulator
//
// Copyright (c) 2004, Takuya Murakami. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 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 REGENTS 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.

/*
 * GSHHS: Global Self-consistent Hierarchical High-resolution Shorelines
 * handling library
 */

#ifndef _GSHHS_HPP
#define _GSHHS_HPP

#include <stdio.h>
#include <vector>

using namespace std;

#include "gpc.hpp"
#include "bbox.hpp"

//
// GSHHS data header
//
struct GSHHS_Header {
        int     id;             // Polygon ID
        int     num;            // number of vertices
        int     level;          // 1:land, 2:water, 3:water in land, 4:land in water in land
        int     xmin, xmax;     // Range (east-west: micro-degree)
        int     ymin, ymax;     // Range (south-north)
        int     area;           // Area size (1/10km^2)
        int     version;        // Version
        short   greenwich;      // Greenwich flag
        short   source;         // 0 = CIA WDB II, 1 = WVS
};

//
// GSHHS polygon class
//
class GVertexList : public GpcVertexList {
private:
        GSHHS_Header    header;
        BoundingBox     bbox;

public:
        GVertexList();
        ~GVertexList();

        bool readHeader(FILE *fp);
        bool readData(FILE *fp, bool skip=false, bool isWestHemisphere=false);

        void printHeader(void);

        inline int id(void) { return header.id; }
        inline int level(void) { return header.level; }

        inline gpc_vertex_list *getvlist(void) { return vlist; }

        bool inBound(BoundingBox &c);
        bool inBoundVertices(BoundingBox &clip);
};

//
// GSHHS polygon set class (for each level)
//
class GPolygon : public GpcPolygon {
private:
//      vector<GVertexList*>    vlists;

public:
        GPolygon(void);
        ~GPolygon();

        int LoadFromGshhsBinary(const char *fname, int level, BoundingBox &bbox, int skipid);
        int SaveGpcFile(const char *fname);
};

#endif
