001: /*
002: * The JTS Topology Suite is a collection of Java classes that
003: * implement the fundamental operations required to validate a given
004: * geo-spatial data set to a known topological specification.
005: *
006: * Copyright (C) 2001 Vivid Solutions
007: *
008: * This library is free software; you can redistribute it and/or
009: * modify it under the terms of the GNU Lesser General Public
010: * License as published by the Free Software Foundation; either
011: * version 2.1 of the License, or (at your option) any later version.
012: *
013: * This library is distributed in the hope that it will be useful,
014: * but WITHOUT ANY WARRANTY; without even the implied warranty of
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
016: * Lesser General Public License for more details.
017: *
018: * You should have received a copy of the GNU Lesser General Public
019: * License along with this library; if not, write to the Free Software
020: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
021: *
022: * For more information, contact:
023: *
024: * Vivid Solutions
025: * Suite #1A
026: * 2328 Government Street
027: * Victoria BC V8T 5G5
028: * Canada
029: *
030: * (250)385-6040
031: * www.vividsolutions.com
032: */
033: package com.vividsolutions.jts.operation.distance;
034:
035: import com.vividsolutions.jts.geom.*;
036:
037: /**
038: * Represents the location of a point on a Geometry.
039: * Maintains both the actual point location (which of course
040: * may not be exact) as well as information about the component
041: * and segment index where the point occurs.
042: * Locations inside area Geometrys will not have an associated segment index,
043: * so in this case the segment index will have the sentinel value of INSIDE_AREA.
044: *
045: * @version 1.7
046: */
047: public class GeometryLocation {
048:
049: /**
050: * Special value of segment-index for locations inside area geometries. These
051: * locations do not have an associated segment index.
052: */
053: public static final int INSIDE_AREA = -1;
054:
055: private Geometry component = null;
056: private int segIndex;
057: private Coordinate pt = null;
058:
059: /**
060: * Constructs a GeometryLocation specifying a point on a geometry, as well as the
061: * segment that the point is on (or INSIDE_AREA if the point is not on a segment).
062: */
063: public GeometryLocation(Geometry component, int segIndex,
064: Coordinate pt) {
065: this .component = component;
066: this .segIndex = segIndex;
067: this .pt = pt;
068: }
069:
070: /**
071: * Constructs a GeometryLocation specifying a point inside an area geometry.
072: */
073: public GeometryLocation(Geometry component, Coordinate pt) {
074: this (component, INSIDE_AREA, pt);
075: }
076:
077: /**
078: * Returns the geometry associated with this location.
079: */
080: public Geometry getGeometryComponent() {
081: return component;
082: }
083:
084: /**
085: * Returns the segment index for this location. If the location is inside an
086: * area, the index will have the value INSIDE_AREA;
087: *
088: * @return the segment index for the location, or INSIDE_AREA
089: */
090: public int getSegmentIndex() {
091: return segIndex;
092: }
093:
094: /**
095: * Returns the location.
096: */
097: public Coordinate getCoordinate() {
098: return pt;
099: }
100:
101: /**
102: * Returns whether this GeometryLocation represents a point inside an area geometry.
103: */
104: public boolean isInsideArea() {
105: return segIndex == INSIDE_AREA;
106: }
107: }
|