Package org.geotools.geometry.jts

Class CircularString

Object

Geometry

LineString

CircularString

All Implemented Interfaces:

Serializable, Cloneable, Comparable, CurvedGeometry<LineString>, SingleCurvedGeometry<LineString>, Lineal

public class CircularString
extends LineString
implements SingleCurvedGeometry<LineString>

A CircularString is a sequence of zero or more connected circular arc segments. A circular arc segment is a curved segment defined by three points in a two-dimensional plane; the first point cannot be the same as the third point.

Author:

Andrea Aime - GeoSolutions

See Also:

• Serialized Form

Field Summary

Fields inherited from class LineString

MINIMUM_VALID_SIZE, points

Fields inherited from class Geometry

envelope, factory, SRID, TYPECODE_GEOMETRYCOLLECTION, TYPECODE_LINEARRING, TYPECODE_LINESTRING, TYPECODE_MULTILINESTRING, TYPECODE_MULTIPOINT, TYPECODE_MULTIPOLYGON, TYPECODE_POINT, TYPECODE_POLYGON, TYPENAME_GEOMETRYCOLLECTION, TYPENAME_LINEARRING, TYPENAME_LINESTRING, TYPENAME_MULTILINESTRING, TYPENAME_MULTIPOINT, TYPENAME_MULTIPOLYGON, TYPENAME_POINT, TYPENAME_POLYGON

Constructor Summary

Constructors

Constructor	Description
CircularString(double[] controlPoints, GeometryFactory factory, double tolerance)
CircularString(CoordinateSequence points, GeometryFactory factory, double tolerance)

Method Summary

Modifier and Type	Method	Description
void	apply(CoordinateFilter filter)
void	apply(CoordinateSequenceFilter filter)
void	apply(GeometryComponentFilter filter)
void	apply(GeometryFilter filter)
Geometry	buffer(double distance)
Geometry	buffer(double distance, int quadrantSegments)
Geometry	buffer(double distance, int quadrantSegments, int endCapStyle)
int	compareTo(Object o)
int	compareTo(Object o, CoordinateSequenceComparator comp)
protected Envelope	computeEnvelopeInternal()
boolean	contains(Geometry g)
Geometry	convexHull()
protected CircularString	copyInternal()
boolean	coveredBy(Geometry g)
boolean	covers(Geometry g)
boolean	crosses(Geometry g)
Geometry	difference(Geometry other)
boolean	disjoint(Geometry g)
double	distance(Geometry g)
boolean	equals(Object o)
boolean	equals(Geometry other)
boolean	equalsExact(Geometry other)
boolean	equalsExact(Geometry other, double tolerance)
boolean	equalsNorm(Geometry g)
boolean	equalsTopo(Geometry other)
void	geometryChanged()
CircularArc	getArcN(int arcIndex)	Returns the n-th circular arc making up the geometry
double	getArea()
Geometry	getBoundary()
int	getBoundaryDimension()
Point	getCentroid()
double[]	getControlPoints()	Returns the control points for this string/ring.
Coordinate	getCoordinate()
Coordinate	getCoordinateN(int n)
Coordinate[]	getCoordinates()
int	getCoordinatesDimension()	Returns the dimension of the geometry without forcing access to the coordinate sequence
CoordinateSequence	getCoordinateSequence()
int	getDimension()
Point	getEndPoint()
Geometry	getEnvelope()
Envelope	getEnvelopeInternal()
GeometryFactory	getFactory()
Geometry	getGeometryN(int n)
String	getGeometryType()
Point	getInteriorPoint()
double	getLength()
CoordinateSequence	getLinearizedCoordinateSequence(double tolerance)	Returns the linearized coordinates at the given tolerance
int	getNumArcs()	Number of arc circles
int	getNumGeometries()
int	getNumPoints()
Point	getPointN(int n)
PrecisionModel	getPrecisionModel()
int	getSRID()
Point	getStartPoint()
double	getTolerance()	The default linearization tolerance
Object	getUserData()
int	hashCode()
Geometry	intersection(Geometry other)
boolean	intersects(Geometry g)
boolean	isClosed()
boolean	isCoordinate(Coordinate pt)
boolean	isEmpty()
boolean	isRectangle()
boolean	isRing()
boolean	isSimple()
boolean	isValid()
boolean	isWithinDistance(Geometry geom, double distance)
LineString	linearize()	Linearizes the geometry using the built-in linearization tolerance
LineString	linearize(double tolerance)	Linearizes the geometry using the provided tolerance, the result is guaranteed to be less than tolerance away from the curved geometry unless the number of points needed to linearize the geometry exceeds the build-in per quadrant maximum, see CircularArc.MAX_SEGMENTS_QUADRANT
Geometry	norm()
void	normalize()
boolean	overlaps(Geometry g)
IntersectionMatrix	relate(Geometry g)
boolean	relate(Geometry g, String intersectionPattern)
CircularString	reverse()
protected CircularString	reverseInternal()
void	setSRID(int SRID)
void	setUserData(Object userData)
Geometry	symDifference(Geometry other)
String	toCurvedText()	Parallel method to Geometry.toText() that will output the geometry as curved instead of as linear
String	toString()
String	toText()
boolean	touches(Geometry g)
Geometry	union()
Geometry	union(Geometry other)
boolean	within(Geometry g)

Methods inherited from class LineString

clone, compareToSameClass, compareToSameClass, getTypeCode, isEquivalentClass

Methods inherited from class Geometry

compare, copy, equal, geometryChangedAction, hasDimension, hasNonEmptyElements, hasNullElements, isGeometryCollection

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CircularString

public CircularString(CoordinateSequence points,
 GeometryFactory factory,
 double tolerance)

CircularString

public CircularString(double[] controlPoints,
 GeometryFactory factory,
 double tolerance)

Method Details

getControlPoints

public double[] getControlPoints()

Description copied from interface: SingleCurvedGeometry

Returns the control points for this string/ring.

Specified by:

getControlPoints in interface SingleCurvedGeometry<LineString>

getTolerance

public double getTolerance()

Description copied from interface: CurvedGeometry

The default linearization tolerance

Specified by:

getTolerance in interface CurvedGeometry<LineString>

getNumArcs

public int getNumArcs()

Description copied from interface: SingleCurvedGeometry

Number of arc circles

Specified by:

getNumArcs in interface SingleCurvedGeometry<LineString>

getArcN

public CircularArc getArcN(int arcIndex)

Description copied from interface: SingleCurvedGeometry

Returns the n-th circular arc making up the geometry

Specified by:

getArcN in interface SingleCurvedGeometry<LineString>

linearize

public LineString linearize()

Description copied from interface: CurvedGeometry

Linearizes the geometry using the built-in linearization tolerance

Specified by:

linearize in interface CurvedGeometry<LineString>

linearize

public LineString linearize(double tolerance)

Description copied from interface: CurvedGeometry

Linearizes the geometry using the provided tolerance, the result is guaranteed to be less than tolerance away from the curved geometry unless the number of points needed to linearize the geometry exceeds the build-in per quadrant maximum, see CircularArc.MAX_SEGMENTS_QUADRANT

Specified by:

linearize in interface CurvedGeometry<LineString>

Parameters:

tolerance - Linearization tolerance, should be zero or positive. When zero is used, the maximum number of allowed linearization points will be used, see CircularArc.MAX_SEGMENTS_QUADRANT

getLinearizedCoordinateSequence

public CoordinateSequence getLinearizedCoordinateSequence(double tolerance)

Description copied from interface: SingleCurvedGeometry

Returns the linearized coordinates at the given tolerance

Specified by:

getLinearizedCoordinateSequence in interface SingleCurvedGeometry<LineString>

isClosed

public boolean isClosed()

Overrides:

isClosed in class LineString

getDimension

public int getDimension()

Overrides:

getDimension in class LineString

getBoundaryDimension

public int getBoundaryDimension()

Overrides:

getBoundaryDimension in class LineString

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class LineString

getGeometryType

public String getGeometryType()

Overrides:

getGeometryType in class LineString

reverse

public CircularString reverse()

Overrides:

reverse in class LineString

reverseInternal

protected CircularString reverseInternal()

Overrides:

reverseInternal in class LineString

getInteriorPoint

public Point getInteriorPoint()

Overrides:

getInteriorPoint in class Geometry

getEnvelope

public Geometry getEnvelope()

Overrides:

getEnvelope in class Geometry

getEnvelopeInternal

public Envelope getEnvelopeInternal()

Overrides:

getEnvelopeInternal in class Geometry

computeEnvelopeInternal

protected Envelope computeEnvelopeInternal()

Overrides:

computeEnvelopeInternal in class LineString

getNumGeometries

public int getNumGeometries()

Overrides:

getNumGeometries in class Geometry

getGeometryN

public Geometry getGeometryN(int n)

Overrides:

getGeometryN in class Geometry

setUserData

public void setUserData(Object userData)

Overrides:

setUserData in class Geometry

getSRID

public int getSRID()

Overrides:

getSRID in class Geometry

setSRID

public void setSRID(int SRID)

Overrides:

setSRID in class Geometry

getFactory

public GeometryFactory getFactory()

Overrides:

getFactory in class Geometry

getUserData

public Object getUserData()

Overrides:

getUserData in class Geometry

getPrecisionModel

public PrecisionModel getPrecisionModel()

Overrides:

getPrecisionModel in class Geometry

isRectangle

public boolean isRectangle()

Overrides:

isRectangle in class Geometry

equalsExact

public boolean equalsExact(Geometry other)

Overrides:

equalsExact in class Geometry

equalsExact

public boolean equalsExact(Geometry other,
 double tolerance)

Overrides:

equalsExact in class LineString

equals

public boolean equals(Geometry other)

Overrides:

equals in class Geometry

equalsTopo

public boolean equalsTopo(Geometry other)

Overrides:

equalsTopo in class Geometry

equals

public boolean equals(Object o)

Overrides:

equals in class Geometry

hashCode

public int hashCode()

Overrides:

hashCode in class Geometry

toString

public String toString()

Overrides:

toString in class Geometry

toCurvedText

public String toCurvedText()

Description copied from interface: CurvedGeometry

Parallel method to Geometry.toText() that will output the geometry as curved instead of as linear

Specified by:

toCurvedText in interface CurvedGeometry<LineString>

equalsNorm

public boolean equalsNorm(Geometry g)

Overrides:

equalsNorm in class Geometry

getPointN

public Point getPointN(int n)

Overrides:

getPointN in class LineString

getStartPoint

public Point getStartPoint()

Overrides:

getStartPoint in class LineString

getEndPoint

public Point getEndPoint()

Overrides:

getEndPoint in class LineString

getCoordinates

public Coordinate[] getCoordinates()

Overrides:

getCoordinates in class LineString

getCoordinateSequence

public CoordinateSequence getCoordinateSequence()

Overrides:

getCoordinateSequence in class LineString

getCoordinateN

public Coordinate getCoordinateN(int n)

Overrides:

getCoordinateN in class LineString

getCoordinate

public Coordinate getCoordinate()

Overrides:

getCoordinate in class LineString

getNumPoints

public int getNumPoints()

Overrides:

getNumPoints in class LineString

isRing

public boolean isRing()

Overrides:

isRing in class LineString

getLength

public double getLength()

Overrides:

getLength in class LineString

getBoundary

public Geometry getBoundary()

Overrides:

getBoundary in class LineString

isCoordinate

public boolean isCoordinate(Coordinate pt)

Overrides:

isCoordinate in class LineString

apply

public void apply(CoordinateFilter filter)

Overrides:

apply in class LineString

apply

public void apply(CoordinateSequenceFilter filter)

Overrides:

apply in class LineString

apply

public void apply(GeometryFilter filter)

Overrides:

apply in class LineString

apply

public void apply(GeometryComponentFilter filter)

Overrides:

apply in class LineString

copyInternal

protected CircularString copyInternal()

Overrides:

copyInternal in class LineString

normalize

public void normalize()

Overrides:

normalize in class LineString

isSimple

public boolean isSimple()

Overrides:

isSimple in class Geometry

isValid

public boolean isValid()

Overrides:

isValid in class Geometry

distance

public double distance(Geometry g)

Overrides:

distance in class Geometry

isWithinDistance

public boolean isWithinDistance(Geometry geom,
 double distance)

Overrides:

isWithinDistance in class Geometry

getArea

public double getArea()

Overrides:

getArea in class Geometry

getCentroid

public Point getCentroid()

Overrides:

getCentroid in class Geometry

geometryChanged

public void geometryChanged()

Overrides:

geometryChanged in class Geometry

disjoint

public boolean disjoint(Geometry g)

Overrides:

disjoint in class Geometry

touches

public boolean touches(Geometry g)

Overrides:

touches in class Geometry

intersects

public boolean intersects(Geometry g)

Overrides:

intersects in class Geometry

crosses

public boolean crosses(Geometry g)

Overrides:

crosses in class Geometry

within

public boolean within(Geometry g)

Overrides:

within in class Geometry

contains

public boolean contains(Geometry g)

Overrides:

contains in class Geometry

overlaps

public boolean overlaps(Geometry g)

Overrides:

overlaps in class Geometry

covers

public boolean covers(Geometry g)

Overrides:

covers in class Geometry

coveredBy

public boolean coveredBy(Geometry g)

Overrides:

coveredBy in class Geometry

relate

public boolean relate(Geometry g,
 String intersectionPattern)

Overrides:

relate in class Geometry

relate

public IntersectionMatrix relate(Geometry g)

Overrides:

relate in class Geometry

buffer

public Geometry buffer(double distance)

Overrides:

buffer in class Geometry

buffer

public Geometry buffer(double distance,
 int quadrantSegments)

Overrides:

buffer in class Geometry

buffer

public Geometry buffer(double distance,
 int quadrantSegments,
 int endCapStyle)

Overrides:

buffer in class Geometry

convexHull

public Geometry convexHull()

Overrides:

convexHull in class Geometry

intersection

public Geometry intersection(Geometry other)

Overrides:

intersection in class Geometry

union

public Geometry union(Geometry other)

Overrides:

union in class Geometry

difference

public Geometry difference(Geometry other)

Overrides:

difference in class Geometry

symDifference

public Geometry symDifference(Geometry other)

Overrides:

symDifference in class Geometry

union

public Geometry union()

Overrides:

union in class Geometry

norm

public Geometry norm()

Overrides:

norm in class Geometry

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class Geometry

compareTo

public int compareTo(Object o,
 CoordinateSequenceComparator comp)

Overrides:

compareTo in class Geometry

toText

public String toText()

Overrides:

toText in class Geometry

getCoordinatesDimension

public int getCoordinatesDimension()

Description copied from interface: CurvedGeometry

Returns the dimension of the geometry without forcing access to the coordinate sequence

Specified by:

getCoordinatesDimension in interface CurvedGeometry<LineString>