LinearLocation.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2011 Sandro Santilli <strk@keybit.net>
 * Copyright (C) 2005-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: linearref/LinearLocation.java r463
 *
 **********************************************************************/
 
#ifndef GEOS_LINEARREF_LINEARLOCATION_H
#define GEOS_LINEARREF_LINEARLOCATION_H
 
#include <string>
#include <memory> // for std::auto_ptr
 
#include <geos/geom/Coordinate.h>
#include <geos/geom/Geometry.h>
#include <geos/geom/LineSegment.h>
 
namespace geos {
namespace linearref { // geos::linearref
 

class LinearLocation
{
private:
        unsigned int componentIndex;
        unsigned int segmentIndex;
        double segmentFraction;

        void normalize();
 
public:
        static LinearLocation getEndLocation(const geom::Geometry* linear);

        static geom::Coordinate pointAlongSegmentByFraction(const geom::Coordinate& p0, const geom::Coordinate& p1, double frac);
 

        LinearLocation(unsigned int segmentIndex = 0, double segmentFraction = 0.0);
 
        LinearLocation(unsigned int componentIndex, unsigned int segmentIndex, double segmentFraction);

        void clamp(const geom::Geometry* linear);

        void snapToVertex(const geom::Geometry* linearGeom, double minDistance);

        double getSegmentLength(const geom::Geometry* linearGeom) const;

        void setToEnd(const geom::Geometry* linear);

        unsigned int getComponentIndex() const;

        unsigned int getSegmentIndex() const;

        double getSegmentFraction() const;

        bool isVertex() const;

        geom::Coordinate getCoordinate(const geom::Geometry* linearGeom) const;

        std::auto_ptr<geom::LineSegment> getSegment(const geom::Geometry* linearGeom) const;

        bool isValid(const geom::Geometry* linearGeom) const;

        int compareTo(const LinearLocation& other) const;

        int compareLocationValues(unsigned int componentIndex1, unsigned int segmentIndex1, double segmentFraction1) const;

        static int compareLocationValues(
                unsigned int componentIndex0, unsigned int segmentIndex0, double segmentFraction0,
                unsigned int componentIndex1, unsigned int segmentIndex1, double segmentFraction1);

        bool isOnSameSegment(const LinearLocation& loc) const;

        bool isEndpoint(const geom::Geometry& linearGeom) const;
 
        friend std::ostream& operator<< (std::ostream& out, const LinearLocation& obj );
 
};
 
 
} // namespace geos.linearref
} // namespace geos
 
#endif