quadtree/Key.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2009  Sandro Santilli <strk@keybit.net>
 * Copyright (C) 2006 Refractions Research Inc.
 * Copyright (C) 2001-2002 Vivid Solutions Inc.
 *
 * This is free software; you can redistribute and/or modify it under
 * the terms of the GNU Lesser General Public Licence as published
 * by the Free Software Foundation. 
 * See the COPYING file for more information.
 *
 **********************************************************************
 *
 * Last port: index/quadtree/Key.java rev 1.8 (JTS-1.10)
 *
 **********************************************************************/
 
#ifndef GEOS_IDX_QUADTREE_KEY_H
#define GEOS_IDX_QUADTREE_KEY_H
 
#include <geos/export.h>
#include <geos/geom/Coordinate.h> // for composition
#include <geos/geom/Envelope.h> // for composition
 
// Forward declarations
// ...
 
namespace geos {
namespace index { // geos::index
namespace quadtree { // geos::index::quadtree

class GEOS_DLL Key {
public:
 
        // Doesn't touch the Envelope, might as well be const
        static int computeQuadLevel(const geom::Envelope& env);
 
        // Reference to argument won't be used after construction
        Key(const geom::Envelope& itemEnv);
 
        // used to be virtual, but I don't see subclasses...
        ~Key();

        const geom::Coordinate& getPoint() const;
 
        int getLevel() const;

        const geom::Envelope& getEnvelope() const;

        geom::Coordinate* getCentre() const;

        void computeKey(const geom::Envelope& itemEnv);
 
private:        
        // the fields which make up the key
 
        // Owned by this class
        geom::Coordinate pt;
 
        int level;
 
        // auxiliary data which is derived from the key for use in computation
        geom::Envelope env;
 
        void computeKey(int level, const geom::Envelope& itemEnv);
};
 
} // namespace geos::index::quadtree
} // namespace geos::index
} // namespace geos
 
#endif // GEOS_IDX_QUADTREE_KEY_H