GEOS 3.10.1
LineString.h
1/**********************************************************************
2 *
3 * GEOS - Geometry Engine Open Source
4 * http://geos.osgeo.org
5 *
6 * Copyright (C) 2011 Sandro Santilli <strk@kbt.io>
7 * Copyright (C) 2001-2002 Vivid Solutions Inc.
8 * Copyright (C) 2005 2006 Refractions Research Inc.
9 *
10 * This is free software; you can redistribute and/or modify it under
11 * the terms of the GNU Lesser General Public Licence as published
12 * by the Free Software Foundation.
13 * See the COPYING file for more information.
14 *
15 **********************************************************************
16 *
17 * Last port: geom/LineString.java r320 (JTS-1.12)
18 *
19 **********************************************************************/
20
21#ifndef GEOS_GEOS_LINESTRING_H
22#define GEOS_GEOS_LINESTRING_H
23
24#include <geos/export.h>
25#include <geos/geom/Geometry.h> // for inheritance
26#include <geos/geom/CoordinateSequence.h> // for proper use of unique_ptr<>
27#include <geos/geom/Envelope.h> // for proper use of unique_ptr<>
28#include <geos/geom/Dimension.h> // for Dimension::DimensionType
29
30#include <string>
31#include <vector>
32#include <memory> // for unique_ptr
33
34#include <geos/inline.h>
35
36#ifdef _MSC_VER
37#pragma warning(push)
38#pragma warning(disable: 4251) // warning C4251: needs to have dll-interface to be used by clients of class
39#endif
40
41namespace geos {
42namespace geom {
43class Coordinate;
44class CoordinateArraySequence;
45class CoordinateSequenceFilter;
46}
47}
48
49namespace geos {
50namespace geom { // geos::geom
51
68class GEOS_DLL LineString: public Geometry {
69
70public:
71
72 friend class GeometryFactory;
73
75 typedef std::vector<const LineString*> ConstVect;
76
77 ~LineString() override;
78
86 std::unique_ptr<LineString> clone() const
87 {
88 return std::unique_ptr<LineString>(cloneImpl());
89 }
90
91 std::unique_ptr<CoordinateSequence> getCoordinates() const override;
92
95
96 virtual const Coordinate& getCoordinateN(std::size_t n) const;
97
105 std::unique_ptr<CoordinateSequence> releaseCoordinates();
106
109
115 int getBoundaryDimension() const override;
116
118 uint8_t getCoordinateDimension() const override;
119
125 std::unique_ptr<Geometry> getBoundary() const override;
126
127 bool isEmpty() const override;
128
129 std::size_t getNumPoints() const override;
130
131 virtual std::unique_ptr<Point> getPointN(std::size_t n) const;
132
137 virtual std::unique_ptr<Point> getStartPoint() const;
138
143 virtual std::unique_ptr<Point> getEndPoint() const;
144
145 virtual bool isClosed() const;
146
147 virtual bool isRing() const;
148
149 std::string getGeometryType() const override;
150
152
153 virtual bool isCoordinate(Coordinate& pt) const;
154
155 bool equalsExact(const Geometry* other, double tolerance = 0)
156 const override;
157
158 void apply_rw(const CoordinateFilter* filter) override;
159
160 void apply_ro(CoordinateFilter* filter) const override;
161
162 void apply_rw(GeometryFilter* filter) override;
163
164 void apply_ro(GeometryFilter* filter) const override;
165
166 void apply_rw(GeometryComponentFilter* filter) override;
167
168 void apply_ro(GeometryComponentFilter* filter) const override;
169
170 void apply_rw(CoordinateSequenceFilter& filter) override;
171
172 void apply_ro(CoordinateSequenceFilter& filter) const override;
173
181 void normalize() override;
182
183 //was protected
184 int compareToSameClass(const Geometry* ls) const override;
185
186 const Coordinate* getCoordinate() const override;
187
188 double getLength() const override;
189
196 std::unique_ptr<LineString> reverse() const { return std::unique_ptr<LineString>(reverseImpl()); }
197
198protected:
199
200 LineString(const LineString& ls);
201
206
208 LineString(CoordinateSequence::Ptr && pts,
209 const GeometryFactory& newFactory);
210
211 LineString* cloneImpl() const override { return new LineString(*this); }
212
213 LineString* reverseImpl() const override;
214
215 Envelope::Ptr computeEnvelopeInternal() const override;
216
217 CoordinateSequence::Ptr points;
218
219 int
220 getSortIndex() const override
221 {
222 return SORTINDEX_LINESTRING;
223 };
224
225private:
226
227 void validateConstruction();
228 void normalizeClosed();
229
230
231};
232
233struct GEOS_DLL LineStringLT {
234 bool
235 operator()(const LineString* ls1, const LineString* ls2) const
236 {
237 return ls1->compareTo(ls2) < 0;
238 }
239};
240
241} // namespace geos::geom
242} // namespace geos
243
244#ifdef _MSC_VER
245#pragma warning(pop)
246#endif
247
248#endif // ndef GEOS_GEOS_LINESTRING_H
Geometry classes support the concept of applying a coordinate filter to every coordinate in the Geome...
Definition: CoordinateFilter.h:43
Interface for classes which provide operations that can be applied to the coordinates in a Coordinate...
Definition: CoordinateSequenceFilter.h:57
The internal representation of a list of coordinates inside a Geometry.
Definition: CoordinateSequence.h:58
Coordinate is the lightweight class used to store coordinates.
Definition: Coordinate.h:60
DimensionType
Definition: Dimension.h:31
Definition: GeometryComponentFilter.h:43
Supplies a set of utility methods for building Geometry objects from CoordinateSequence or other Geom...
Definition: GeometryFactory.h:68
Geometry classes support the concept of applying a Geometry filter to the Geometry.
Definition: GeometryFilter.h:47
Basic implementation of Geometry, constructed and destructed by GeometryFactory.
Definition: Geometry.h:188
Definition: LineString.h:68
void apply_ro(CoordinateSequenceFilter &filter) const override
virtual std::unique_ptr< Point > getStartPoint() const
Return the start point of the LineString or NULL if this is an EMPTY LineString.
std::unique_ptr< Geometry > getBoundary() const override
Returns a MultiPoint. Empty for closed LineString, a Point for each vertex otherwise.
LineString * reverseImpl() const override
Make a geometry with coordinates in reverse order.
LineString(CoordinateSequence *pts, const GeometryFactory *newFactory)
Constructs a LineString taking ownership the given CoordinateSequence.
void normalize() override
Normalizes a LineString.
std::unique_ptr< CoordinateSequence > getCoordinates() const override
Returns this Geometry vertices. Caller takes ownership of the returned object.
const Coordinate * getCoordinate() const override
Returns a vertex of this Geometry, or NULL if this is the empty geometry.
bool isEmpty() const override
Returns whether or not the set of points in this Geometry is empty.
Dimension::DimensionType getDimension() const override
Returns line dimension (1)
LineString * cloneImpl() const override
Make a deep-copy of this Geometry.
Definition: LineString.h:211
GeometryTypeId getGeometryTypeId() const override
Return an integer representation of this Geometry type.
std::unique_ptr< LineString > reverse() const
Definition: LineString.h:196
virtual std::unique_ptr< Point > getEndPoint() const
Return the end point of the LineString or NULL if this is an EMPTY LineString.
std::vector< const LineString * > ConstVect
A vector of const LineString pointers.
Definition: LineString.h:75
void apply_rw(CoordinateSequenceFilter &filter) override
std::unique_ptr< CoordinateSequence > releaseCoordinates()
Take ownership of the CoordinateSequence managed by this geometry. After releasing the coordinates,...
LineString(CoordinateSequence::Ptr &&pts, const GeometryFactory &newFactory)
Hopefully cleaner version of the above.
double getLength() const override
Returns the length of this Geometry.
int getBoundaryDimension() const override
Returns Dimension::False for a closed LineString, 0 otherwise (LineString boundary is a MultiPoint)
std::string getGeometryType() const override
Return a string representation of this Geometry type.
bool equalsExact(const Geometry *other, double tolerance=0) const override
Returns true iff the two Geometrys are of the same type and their vertices corresponding by index are...
const CoordinateSequence * getCoordinatesRO() const
Returns a read-only pointer to internal CoordinateSequence.
uint8_t getCoordinateDimension() const override
Returns coordinate dimension.
std::size_t getNumPoints() const override
Returns the count of this Geometrys vertices.
std::unique_ptr< LineString > clone() const
Creates and returns a full copy of this LineString object (including all coordinates contained by it)
Definition: LineString.h:86
GeometryTypeId
Geometry types.
Definition: Geometry.h:75
Basic namespace for all GEOS functionalities.
Definition: geos.h:40