com.luciad.shape.shape2D

LuciadLightspeedClass TLcdLonLatRhumbPolygon

java.lang.Object

com.luciad.shape.ALcdShape

com.luciad.shape.shape2D.ALcd2DEditableShape

com.luciad.shape.shape2D.ALcd2DEditablePolypoint

com.luciad.shape.shape2D.TLcdLonLatPolypoint

com.luciad.shape.shape2D.TLcdLonLatRhumbPolygon

All Implemented Interfaces:

ILcdBounded, ILcdCurve, ILcdPointList, ILcdPointList2 , ILcdPolygon, ILcdPolypoint, ILcdRing, ILcdShape, ILcd2DEditablePointList, ILcd2DEditablePolygon, ILcd2DEditablePolypoint, ILcd2DEditableShape, ILcdCache, ILcdCloneable, ILcdInvalidateable, Serializable, Cloneable

public class TLcdLonLatRhumbPolygon
extends TLcdLonLatPolypoint
implements ILcd2DEditablePolygon, ILcdRing

This class provides an implementation of ILcd2DEditablePolygon in the geodetic space. In addition to the properties defined by ILcd2DEditablePolygon, a TLcdLonLatRhumbPolygon has an ellipsoid on which it lives.

Contrary to TLcdLonLatPolygon, the line segments are not located on geodesics. Instead the segments are lines of constant azimuth.

All longitude/latitude coordinates are expressed in degrees.

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.

Since:

9.0

See Also:

TLcdLonLatPolygon, Serialized Form

Field Summary

Fields inherited from class com.luciad.shape.shape2D.ALcd2DEditablePolypoint

fBounds, fFocusPoint

Fields inherited from interface com.luciad.shape.ILcdPolygon

CLOCKWISE, COUNTERCLOCKWISE, INVALID_ORIENTATION

Fields inherited from interface com.luciad.shape.ILcdCurve

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 Summary

Constructors

Constructor and Description
TLcdLonLatRhumbPolygon() Constructs a polygon with no points that is defined on the default ellipsoid.
TLcdLonLatRhumbPolygon(ILcd2DEditablePointList a2DEditablePointList) Constructs a polygon with the given point list on the default ellipsoid.
TLcdLonLatRhumbPolygon(ILcd2DEditablePointList a2DEditablePointList, ILcdEllipsoid aEllipsoid) Constructs a polygon with the given point list on the given ellipsoid.
TLcdLonLatRhumbPolygon(ILcdEllipsoid aEllipsoid) Constructs a polygon with no points that is defined on the given ellipsoid.

Method Summary

Modifier and Type	Method and Description
protected void	calculateBounds() The bounds are determined by including all points that determine the Polygon.
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 x, double y) Checks whether this ILcdShape contains the given point in the 2D space.
boolean	contains2D(ILcdPoint aPoint) Checks whether this ALcdShape contains the given point in the 2D cartesian plane.
boolean	equals(Object aObject) Returns whether the given object has the same class, the same focus point, the same coordinates, and the same ellipsoid.
ILcdEllipsoid	getEllipsoid() Returns the ellipsoid on which this shape is defined.
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.
String	getInterpolation() Returns the interpolation method used by this curve.
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.
int	getOrientation() Returns the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE.
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	insert2DPoint(int aIndex, double aX, double aY) Inserts a point at the given index into this ILcd2DEditablePointList.
void	move2DPoint(int aIndex, double aX, double aY) Moves the specified point of this ILcd2DEditablePointList to the given point in the 2D space.
void	removePointAt(int aIndex) Removes the point at the given index from this ILcd2DEditablePointList.
void	set2DEditablePointList(ILcd2DEditablePointList a2DEditablePointList)
void	setEllipsoid(ILcdEllipsoid aEllipsoid) Sets the ellipsoid on which this shape is defined.
void	setOrientation(int aOrientation) Sets the orientation of this ILcd2DEditablePolygon.
void	translate2DPoint(int aIndex, double aDeltaX, double aDeltaY) Translates the specified point of this ILcd2DEditablePointList from its current position over the given translation vector in the 2D space.

Methods inherited from class com.luciad.shape.shape2D.TLcdLonLatPolypoint

calculateFocusPoint

Methods inherited from class com.luciad.shape.shape2D.ALcd2DEditablePolypoint

clearCache, get2DEditablePointList, getBounds, getCachedObject, getFocusPoint, getPoint, getPointCount, getPointSFCT, getX, getY, getZ, insertIntoCache, invalidateBounds, invalidateObject, move2D, removeCachedObject, setFocusPoint, toString, translate2D

Methods inherited from class com.luciad.shape.shape2D.ALcd2DEditableShape

contains3D, move2D

Methods inherited from class com.luciad.shape.ALcdShape

contains3D, fromDomainObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.shape.shape2D.ILcd2DEditableShape

move2D, move2D, translate2D

Methods inherited from interface com.luciad.shape.shape2D.ILcd2DEditablePointList

append2DPoint, translate2D

Methods inherited from interface com.luciad.shape.ILcdPointList

getPoint, getPointCount, getPointSFCT, getX, getY, getZ

Methods inherited from interface com.luciad.shape.ILcdShape

contains3D, contains3D, getFocusPoint

Methods inherited from interface com.luciad.shape.ILcdBounded

getBounds

Methods inherited from interface com.luciad.util.ILcdCache

clearCache, getCachedObject, insertIntoCache, removeCachedObject

Constructor Detail

TLcdLonLatRhumbPolygon

public TLcdLonLatRhumbPolygon()

Constructs a polygon with no points that is defined on the default ellipsoid.

TLcdLonLatRhumbPolygon

public TLcdLonLatRhumbPolygon(ILcdEllipsoid aEllipsoid)

Constructs a polygon with no points that is defined on the given ellipsoid.

Parameters:

aEllipsoid - the ellipsoid on which this shape is defined.

TLcdLonLatRhumbPolygon

public TLcdLonLatRhumbPolygon(ILcd2DEditablePointList a2DEditablePointList)

Constructs a polygon with the given point list on the default ellipsoid.

Parameters:

a2DEditablePointList - the point list that contains the points of the polygon.

TLcdLonLatRhumbPolygon

public TLcdLonLatRhumbPolygon(ILcd2DEditablePointList a2DEditablePointList,
                              ILcdEllipsoid aEllipsoid)

Constructs a polygon with the given point list on the given ellipsoid.

Parameters:

a2DEditablePointList - the point list that contains the points of the polygon.

aEllipsoid - the ellipsoid on which this shape is defined.

Method Detail

getOrientation

public int getOrientation()

Description copied from interface: ILcdPolygon

Returns the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE.

Specified by:

getOrientation in interface ILcdPolygon

Returns:

the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE. This method should not return INVALID_ORIENTATION, which is only to be used for resetting the orientation so that it can be recalculated.

setOrientation

public final void setOrientation(int aOrientation)

Sets the orientation of this ILcd2DEditablePolygon.

Note: modifying the geometry of this polygon or modifying the ellipsoid setEllipsoid(com.luciad.geodesy.ILcdEllipsoid) will clear the orientation.

Specified by:

setOrientation in interface ILcd2DEditablePolygon

Parameters:

aOrientation - ILcd2DEditablePolygon.CLOCKWISE, ILcd2DEditablePolygon.COUNTERCLOCKWISE or ILcd2DEditablePolygon.INVALID_ORIENTATION.

getEllipsoid

public ILcdEllipsoid getEllipsoid()

Returns the ellipsoid on which this shape is defined.

Returns:

the ellipsoid on which this shape is defined.

setEllipsoid

public void setEllipsoid(ILcdEllipsoid aEllipsoid)

Sets the ellipsoid on which this shape is defined.

Parameters:

aEllipsoid - the new ellipsoid on which this shape is defined.

calculateBounds

protected void calculateBounds()

The bounds are determined by including all points that determine the Polygon. Sample points are taken on each line segment in order to take the geodesic characteristics into account. Since the maximum or minimum may be missed this way a small extension of the bounds is applied.

Overrides:

calculateBounds in class TLcdLonLatPolypoint

contains2D

public boolean contains2D(ILcdPoint aPoint)

Description copied from class: ALcdShape

Checks whether this ALcdShape contains the given point in the 2D cartesian plane.

Specified by:

contains2D in interface ILcdShape

Overrides:

contains2D in class ALcdShape

Parameters:

aPoint - the point to test.

Returns:

the boolean result of the containment test.

See Also:

ILcdShape.contains2D(double, double)

contains2D

public boolean contains2D(double x,
                          double y)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered.

Specified by:

contains2D in interface ILcdShape

Overrides:

contains2D in class ALcd2DEditablePolypoint

Parameters:

x - the x coordinate of the point.

y - the y coordinate of the point.

Returns:

the boolean result of the containment test.

set2DEditablePointList

public void set2DEditablePointList(ILcd2DEditablePointList a2DEditablePointList)

Overrides:

set2DEditablePointList in class ALcd2DEditablePolypoint

move2DPoint

public void move2DPoint(int aIndex,
                        double aX,
                        double aY)

Description copied from interface: ILcd2DEditablePointList

Moves the specified point of this ILcd2DEditablePointList to the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.

Specified by:

move2DPoint in interface ILcd2DEditablePointList

Overrides:

move2DPoint in class ALcd2DEditablePolypoint

Parameters:

aIndex - a valid index in the list of points.

aX - the x coordinate of the point.

aY - the y coordinate of the point.

translate2DPoint

public void translate2DPoint(int aIndex,
                             double aDeltaX,
                             double aDeltaY)

Description copied from interface: ILcd2DEditablePointList

Translates the specified point of this ILcd2DEditablePointList from its current position over the given translation vector in the 2D space. Only the first two dimensions of the points are considered. The third dimension is left unchanged.

Specified by:

translate2DPoint in interface ILcd2DEditablePointList

Overrides:

translate2DPoint in class ALcd2DEditablePolypoint

aDeltaX - the x coordinate of the translation vector.

aDeltaY - the y coordinate of the translation vector.

insert2DPoint

public void insert2DPoint(int aIndex,
                          double aX,
                          double aY)

Description copied from interface: ILcd2DEditablePointList

Inserts a point at the given index into this ILcd2DEditablePointList.

Specified by:

insert2DPoint in interface ILcd2DEditablePointList

Overrides:

insert2DPoint in class ALcd2DEditablePolypoint

Parameters:

aIndex - a valid new index in the list of points.

aX - the x coordinate of the new point.

aY - the y coordinate of the new point.

removePointAt

public void removePointAt(int aIndex)

Description copied from interface: ILcd2DEditablePointList

Removes the point at the given index from this ILcd2DEditablePointList.

Specified by:

removePointAt in interface ILcd2DEditablePointList

Overrides:

removePointAt in class ALcd2DEditablePolypoint

Parameters:

aIndex - a valid index in the list of ILcdPoint objects.

computePointSFCT

public void computePointSFCT(double aParam,
                             ILcd3DEditablePoint aPointSFCT)

Description copied from interface: ILcdCurve

Computes a point of the curve, defined by the given parameter.

• At parameter 0, the point is the same as ILcdCurve.getStartPoint().
• At parameter 1, the point is the same as ILcdCurve.getEndPoint().

Specified by:

computePointSFCT in interface ILcdCurve

Parameters:

aParam - a value of the closed interval [0,1]

aPointSFCT - the point to store the computed curve point in

getEndPoint

public ILcdPoint getEndPoint()

Description copied from interface: ILcdCurve

Retrieves the end point of the curve.

This is equivalent to computePointSFCT(1).

Specified by:

getEndPoint in interface ILcdCurve

Returns:

the end point of the curve

getEndTangent2D

public double getEndTangent2D()

Description copied from interface: ILcdCurve

Returns the angle of the curve's tangent at the end point, in degrees counterclockwise from the direction at 3 o'clock.

The tangent orientation is from the end point, away from the curve before it.

This is the same as getTangent2D(1).

Specified by:

getEndTangent2D in interface ILcdCurve

Returns:

the curve's angle in the end point

getInterpolation

public String getInterpolation()

Description copied from interface: ILcdCurve

Returns the interpolation method used by this curve.

A set of predefined constants are defined in this interface, which are used by the default ILcdCurve implementations provided by LuciadLightspeed.

Custom implementations can define their own constants, and use them to interpret the interpolation of the curve.

Specified by:

getInterpolation in interface ILcdCurve

Returns:

the interpolation method used by this curve.

getLength2D

public double getLength2D(double aParam1,
                          double aParam2)

Description copied from interface: ILcdCurve

Returns the length between two points of the curve, defined by the given parameters.

• When aParam1 == aParam2, the length is 0.
• When aParam1 == 0 and aParam2 == 1, the length is the whole length of the curve.
• When aParam1 > aParam2, the length is (aParam1 to 1) + (0 to aParam2).

Specified by:

getLength2D in interface ILcdCurve

Parameters:

aParam1 - a value of the closed interval [0,1]

aParam2 - a value of the closed interval [0,1]

Returns:

the length of the curve.

getLineSegmentIntersectionCount

public int getLineSegmentIntersectionCount(ILcdPoint aP1,
                                           ILcdPoint aP2)

Description copied from interface: ILcdCurve

Returns the number of intersections between this curve and a line segment defined by the two specified points.

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.

Specified by:

getLineSegmentIntersectionCount in interface ILcdCurve

Parameters:

aP1 - the first point of the line segment

aP2 - the second point of the line segment

Returns:

the number of intersections between the curve and the line segment

getStartPoint

public ILcdPoint getStartPoint()

Description copied from interface: ILcdCurve

Retrieves the start point of the curve.

This is equivalent to computePointSFCT(0).

Specified by:

getStartPoint in interface ILcdCurve

Returns:

the start point of the curve

getStartTangent2D

public double getStartTangent2D()

Description copied from interface: ILcdCurve

Returns the angle of the curve's tangent at the start point, in degrees counterclockwise from the direction at 3 o'clock.

The tangent orientation is from the start point towards the rest of the shape.

This is the same as getTangent2D(0).

Specified by:

getStartTangent2D in interface ILcdCurve

Returns:

the curve's angle in the start point

getTangent2D

public double getTangent2D(double aParam)

Description copied from interface: ILcdCurve

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.

The tangent orientation is from the point at parameter aParam towards the rest of the shape.

• The tangent at parameter 0 is the same as ILcdCurve.getStartTangent2D().
• The tangent at parameter 1 is the same as ILcdCurve.getEndTangent2D().

Specified by:

getTangent2D in interface ILcdCurve

Parameters:

aParam - a value of the closed interval [0,1]

Returns:

the curve's angle in the point defined by the given parameter

clone

public Object clone()

Creates and returns a copy of this object.

The contained editable points list is cloned.

The contained ellipsoid is copied without being cloned.

The cache, the bounds and the focus point are not copied or cloned at all, but recalculated when needed.

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class TLcdLonLatPolypoint

See Also:

Object.clone()

equals

public boolean equals(Object aObject)

Returns whether the given object has the same class, the same focus point, the same coordinates, and the same ellipsoid.

Overrides:

equals in class ALcd2DEditablePolypoint

hashCode

public int hashCode()

Description copied from class: ALcdShape

The hash code of this shape is the hash code of its class, in order to be consistent with the ALcdShape.equals(Object) method. Extensions should refine this implementation, based on their properties.

Overrides:

hashCode in class ALcd2DEditablePolypoint