public class TLcdLonLatCircle extends ALcd2DEditableShape implements ILcd2DEditableCircle, ILcdRing, ILcdCache
ILcd2DEditableCircle
in the geodetic
space.
In addition to the properties defined by ILcd2DEditableCircle
, a TLcdLonLatCircle
has an ellipsoid on which it lives.
It implements ILcdCache
, thus providing a cache
to store expensive calculations, e.g. for painters,
to store model-world transformations. The cache is cleared whenever the shape is modified.
All longitude/latitude coordinates are expressed in degrees. Lengths are expressed in meters.
This class is thread-safe for concurrent read-only access of its contents. For read-write access, external locking must be used. Such locking is typically done at the model level.
INTERPOLATION_CIRCLE_BY_3POINTS, INTERPOLATION_CIRCLE_BY_CENTERPOINT, INTERPOLATION_CIRCULARARC_BY_3POINTS, INTERPOLATION_CIRCULARARC_BY_BULGE, INTERPOLATION_CIRCULARARC_BY_CENTERPOINT, INTERPOLATION_ELLIPTICAL, INTERPOLATION_GEODESIC, INTERPOLATION_LINEAR, INTERPOLATION_MIXED, INTERPOLATION_RHUMB
Constructor and Description |
---|
TLcdLonLatCircle()
Creates a new
TLcdLonLatCircle with all parameters set to 0,
and with a default ellipsoid. |
TLcdLonLatCircle(double aCenterLon,
double aCenterLat,
double aRadius,
ILcdEllipsoid aEllipsoid)
Creates a new
TLcdLonLatCircle with the specified parameters. |
TLcdLonLatCircle(ILcdPoint aCenter,
double aRadius,
ILcdEllipsoid aEllipsoid)
Creates a new
TLcdLonLatCircle with the specified parameters. |
TLcdLonLatCircle(TLcdLonLatCircle aCircle)
Creates a new
TLcdLonLatCircle that is a deep copy of the given
TLcdLonLatCircle . |
Modifier and Type | Method and Description |
---|---|
void |
clearCache()
Clears the cache.
|
Object |
clone()
Creates and returns a copy of this object.
|
void |
computePointSFCT(double aParam,
ILcd3DEditablePoint aPointSFCT)
Computes a point of the curve, defined by the given parameter.
|
boolean |
contains2D(double aX,
double aY)
Checks whether this
ILcdShape contains the given point in
the 2D space. |
boolean |
equals(Object aObject)
Returns whether the given object has the same class, coordinates, and
radius.
|
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
Object |
getCachedObject(Object aKey)
Looks up and returns the cached Object corresponding to the given key.
|
ILcdPoint |
getCenter()
Returns the center of this
ILcdCircle . |
ILcdEllipsoid |
getEllipsoid() |
ILcdPoint |
getEndPoint()
Retrieves the end point of the curve.
|
double |
getEndTangent2D()
Returns the angle of the curve's tangent at the end point,
in degrees counterclockwise from the direction at 3 o'clock.
|
ILcdPoint |
getFocusPoint()
Returns the focus point of this
ILcdShape . |
String |
getInterpolation()
Returns the interpolation method used by this curve,
which is
ILcdCurve.INTERPOLATION_CIRCLE_BY_CENTERPOINT . |
double |
getLength2D(double aParam1,
double aParam2)
Returns the length between two points of the curve,
defined by the given parameters.
|
int |
getLineSegmentIntersectionCount(ILcdPoint aP1,
ILcdPoint aP2)
Returns the number of intersections between this curve and a line segment
defined by the two specified points.
|
double |
getRadius()
Returns the radius of this
ILcdCircle . |
ILcdPoint |
getStartPoint()
Retrieves the start point of the curve.
|
double |
getStartTangent2D()
Returns the angle of the curve's tangent at the start point,
in degrees counterclockwise from the direction at 3 o'clock.
|
double |
getTangent2D(double aParam)
Returns the angle of the curve's tangent in the point defined
by the given parameter, in degrees counterclockwise from the
direction at 3 o'clock.
|
int |
hashCode()
The hash code of this shape is the hash code of its class, in order to
be consistent with the
ALcdShape.equals(Object) method. |
void |
insertIntoCache(Object aKey,
Object aObject)
Inserts a cache Object corresponding to the given key Object.
|
protected void |
invalidateBounds() |
void |
move2D(double aX,
double aY)
Translates this shape so that its focus point ends up at the specified
position.
|
Object |
removeCachedObject(Object aKey)
Looks up and removes the cached Object corresponding to the given key.
|
void |
setEllipsoid(ILcdEllipsoid aEllipsoid)
Sets the ellipsoid of this
TLcdLonLatCircle . |
void |
setRadius(double aRadius)
Sets the radius of this
TLcdLonLatCircle to aRadius . |
String |
toString() |
void |
translate2D(double aX,
double aY)
Translates this
ILcd2DEditableShape from its current position over the given translation
vector in the 2D space. |
contains3D, move2D
contains2D, contains3D, fromDomainObject
finalize, getClass, notify, notifyAll, wait, wait, wait
move2D
contains2D, contains3D, contains3D
public TLcdLonLatCircle()
TLcdLonLatCircle
with all parameters set to 0,
and with a default ellipsoid.public TLcdLonLatCircle(TLcdLonLatCircle aCircle)
TLcdLonLatCircle
that is a deep copy of the given
TLcdLonLatCircle
.aCircle
- the TLcdLonLatCircle
to copy.public TLcdLonLatCircle(ILcdPoint aCenter, double aRadius, ILcdEllipsoid aEllipsoid)
TLcdLonLatCircle
with the specified parameters.aCenter
- the center point.aRadius
- the radius of the circle (expressed in meters). The radius has to be positive (greater than or equal to 0).aEllipsoid
- the ellipsoid on which the circle is defined.IllegalArgumentException
- if the radius is less than 0.public TLcdLonLatCircle(double aCenterLon, double aCenterLat, double aRadius, ILcdEllipsoid aEllipsoid)
TLcdLonLatCircle
with the specified parameters.aCenterLon
- the longitude of the center.aCenterLat
- the latitude of the center.aRadius
- the radius of the circle (expressed in meters).The radius has to be positive (greater than or equal to 0).aEllipsoid
- the ellipsoid on which the circle is defined.IllegalArgumentException
- if the radius is less than 0.public ILcdEllipsoid getEllipsoid()
TLcdLonLatCircle
.public void setEllipsoid(ILcdEllipsoid aEllipsoid)
TLcdLonLatCircle
.aEllipsoid
- the new ellipsoid.public final double getRadius()
ILcdCircle
ILcdCircle
.getRadius
in interface ILcdCircle
ILcdCircle
.public void setRadius(double aRadius)
TLcdLonLatCircle
to aRadius
.setRadius
in interface ILcd2DEditableCircle
aRadius
- the new radius expressed in meters. The radius has to be positive (greater than or equal to 0).IllegalArgumentException
- if the radius is less than 0.public final ILcdPoint getCenter()
ILcdCircle
ILcdCircle
.getCenter
in interface ILcdCircle
ILcdCircle
.public ILcdPoint getFocusPoint()
ILcdShape
ILcdShape
.getFocusPoint
in interface ILcdShape
ILcdShape
.protected void invalidateBounds()
public ILcdBounds getBounds()
ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.
If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points)
the return value is unspecified.
It is highly recommended to return an undefined
bounds.
You can create undefined bounds using the default constructors
of TLcdLonLatBounds
or TLcdXYBounds
.
getBounds
in interface ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.public boolean contains2D(double aX, double aY)
ILcdShape
ILcdShape
contains the given point in
the 2D space. Only the first two dimensions of the ILcdShape
are considered.contains2D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.public void translate2D(double aX, double aY)
ILcd2DEditableShape
ILcd2DEditableShape
from its current position over the given translation
vector in the 2D space. Only the first two dimensions of the ILcdShape
are considered.
The third dimension is left unchanged.translate2D
in interface ILcd2DEditableShape
aX
- the x coordinate of the translation vector.aY
- the y coordinate of the translation vector.public void move2D(double aX, double aY)
ALcd2DEditableShape
move2D
in interface ILcd2DEditableShape
move2D
in class ALcd2DEditableShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.public ILcdPoint getStartPoint()
ILcdCurve
This is equivalent to computePointSFCT(0)
.
getStartPoint
in interface ILcdCurve
public ILcdPoint getEndPoint()
ILcdCurve
This is equivalent to computePointSFCT(1)
.
getEndPoint
in interface ILcdCurve
public double getStartTangent2D()
ILcdCurve
The tangent orientation is from the start point towards the rest of the shape.
This is the same as getTangent2D(0)
.
getStartTangent2D
in interface ILcdCurve
public double getEndTangent2D()
ILcdCurve
The tangent orientation is from the end point, away from the curve before it.
This is the same as getTangent2D(1)
.
getEndTangent2D
in interface ILcdCurve
public double getTangent2D(double aParam)
ILcdCurve
The tangent orientation is from the point at parameter aParam
towards the rest of the shape.
ILcdCurve.getStartTangent2D()
.ILcdCurve.getEndTangent2D()
.getTangent2D
in interface ILcdCurve
aParam
- a value of the closed interval [0,1]public double getLength2D(double aParam1, double aParam2)
ILcdCurve
aParam1 == aParam2
, the length is 0.aParam1 == 0 and aParam2 == 1
, the length is the whole length of the curve.aParam1 > aParam2
, the length is (aParam1 to 1
) + (0 to aParam2
).getLength2D
in interface ILcdCurve
aParam1
- a value of the closed interval [0,1]aParam2
- a value of the closed interval [0,1]public void computePointSFCT(double aParam, ILcd3DEditablePoint aPointSFCT)
ILcdCurve
ILcdCurve.getStartPoint()
.ILcdCurve.getEndPoint()
.computePointSFCT
in interface ILcdCurve
aParam
- a value of the closed interval [0,1]aPointSFCT
- the point to store the computed curve point inpublic String getInterpolation()
ILcdCurve.INTERPOLATION_CIRCLE_BY_CENTERPOINT
.getInterpolation
in interface ILcdCurve
INTERPOLATION_CIRCLE_BY_CENTERPOINT
.public int getLineSegmentIntersectionCount(ILcdPoint aP1, ILcdPoint aP2)
ILcdCurve
This information can be used to perform containment calculations, if this curve is closed or if this curve is part of a composite closed curve. By determining the number of intersections between this curve and a line segment starting from a given point in a fixed direction, one can determine whether a point is located within the closed curve by using the even-odd rule.
getLineSegmentIntersectionCount
in interface ILcdCurve
aP1
- the first point of the line segmentaP2
- the second point of the line segmentpublic void insertIntoCache(Object aKey, Object aObject)
ILcdCache
insertIntoCache
in interface ILcdCache
aKey
- the key Object that will be used to identify the Object.
The key must therefore be a unique identifier, typically the caller
itself: insertIntoCache(this, ...)
.aObject
- the Object to be cached.public Object getCachedObject(Object aKey)
ILcdCache
getCachedObject
in interface ILcdCache
aKey
- the key Object that was used for storing the cache Object.public Object removeCachedObject(Object aKey)
ILcdCache
removeCachedObject
in interface ILcdCache
aKey
- the key Object that was used for storing the cache Object.public void clearCache()
ILcdCache
clearCache
in interface ILcdCache
public Object clone()
clone
in interface ILcdCloneable
clone
in class ALcdShape
Object.clone()
public boolean equals(Object aObject)
public int hashCode()
ALcdShape
ALcdShape.equals(Object)
method.
Extensions should refine this implementation, based on their properties.