com.luciad.shape.shape3D

LuciadFusionClass TLcdLonLatHeightPolygon

java.lang.Object

com.luciad.shape.ALcdShape

com.luciad.shape.shape2D.ALcd2DEditableShape

com.luciad.shape.shape3D.ALcd3DEditableShape

com.luciad.shape.shape3D.ALcd3DEditablePolypoint

com.luciad.shape.shape3D.TLcdLonLatHeightPolypoint

com.luciad.shape.shape3D.TLcdLonLatHeightPolygon

All Implemented Interfaces:

ILcdBounded, ILcdCurve, ILcdPointList, ILcdPointList2 , ILcdPolygon, ILcdPolypoint, ILcdRing, ILcdShape, ILcd2DEditablePointList, ILcd2DEditablePolygon, ILcd2DEditablePolypoint, ILcd2DEditableShape, ILcd3DEditablePointList, ILcd3DEditablePolygon, ILcd3DEditablePolypoint, ILcd3DEditableShape, ILcdCache, ILcdCloneable, Serializable, Cloneable

Direct Known Subclasses:

TLcdLonLatHeightMPolygon

public class TLcdLonLatHeightPolygon
extends TLcdLonLatHeightPolypoint
implements ILcd3DEditablePolygon, ILcd2DEditablePolygon, ILcdRing

This class provides an implementation of ILcd3DEditablePolygon in the geodetic space.

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.

Note that the ILcd3DEditablePointList representing the actual geometry should provide geodetic points (TLcdLonLatHeightPoint), not cartesian (TLcdXYZPoint).

See Also:

Serialized Form

Field Summary

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
TLcdLonLatHeightPolygon() Creates an empty polygon on a default (WGS 84) ellipsoid.
TLcdLonLatHeightPolygon(ILcd3DEditablePointList a3DEditablePointList) Creates a polygon using the given point list.
TLcdLonLatHeightPolygon(ILcd3DEditablePointList a3DEditablePointList, ILcdEllipsoid aEllipsoid) Creates a polygon using the given point list.
TLcdLonLatHeightPolygon(TLcdLonLatHeightPolygon aLonLatHeightPolygon) Creates copy of another polygon.
TLcdLonLatHeightPolygon(TLcdLonLatHeightPolygon aLonLatHeightPolygon, boolean aDeepCopy) Creates a polygon based on another polygon.

Method Summary

Modifier and Type	Method and Description
protected ILcd3DEditableBounds	calculateBounds() This method should compute the bounds of the polypoint.
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 aLon, double aLat) Determines whether this contains the given point.
boolean	contains2D(ILcdPoint aPoint) Checks whether this ALcdShape contains the given point in the 2D cartesian plane.
boolean	contains3D(double aX, double aY, double aZ) Returns whether the specified point is contained within this polygon.
boolean	contains3D(ILcdPoint aPoint) Checks whether this ALcdShape contains the given point in the 3D space.
ILcdEllipsoid	getEllipsoid() Get the ellipsoid used for this polygon.
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.
void	setEllipsoid(ILcdEllipsoid aEllipsoid) Set the ellipsoid used for this polygon.
void	setOrientation(int aOrientation) Sets the orientation of this ILcd2DEditablePolygon.

Methods inherited from class com.luciad.shape.shape3D.TLcdLonLatHeightPolypoint

calculateFocusPoint

Methods inherited from class com.luciad.shape.shape3D.ALcd3DEditablePolypoint

clearCache, equals, get3DEditablePointList, getBounds, getCachedObject, getFocusPoint, getPoint, getPointCount, getPointSFCT, getX, getY, getZ, hashCode, insert2DPoint, insert3DPoint, insertIntoCache, invalidateBounds, move2D, move2DPoint, move3DPoint, removeCachedObject, removePointAt, set3DEditablePointList, set3DEditablePointList, setFocusPoint, toString, translate2D, translate2DPoint, translate3D, translate3DPoint

Methods inherited from class com.luciad.shape.shape3D.ALcd3DEditableShape

move3D, move3D

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

move2D

Methods inherited from class com.luciad.shape.ALcdShape

fromDomainObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.shape.shape3D.ILcd3DEditableShape

move3D, move3D, translate3D

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

move2D, move2D, translate2D

Methods inherited from interface com.luciad.shape.ILcdShape

getFocusPoint

Methods inherited from interface com.luciad.shape.ILcdBounded

getBounds

Methods inherited from interface com.luciad.shape.shape3D.ILcd3DEditablePointList

insert3DPoint, move3DPoint, removePointAt, translate3D, translate3DPoint

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

append2DPoint, insert2DPoint, move2DPoint, translate2D, translate2DPoint

Methods inherited from interface com.luciad.shape.ILcdPointList

getPoint, getPointCount, getPointSFCT, getX, getY, getZ

Methods inherited from interface com.luciad.util.ILcdCache

clearCache, getCachedObject, insertIntoCache, removeCachedObject

Constructor Detail

TLcdLonLatHeightPolygon

public TLcdLonLatHeightPolygon()

Creates an empty polygon on a default (WGS 84) ellipsoid.

TLcdLonLatHeightPolygon

public TLcdLonLatHeightPolygon(ILcd3DEditablePointList a3DEditablePointList)

Creates a polygon using the given point list.

• The point list and the points therein are not copied, and can be modified by this object
• The point list should contain TLcdLonLatHeightPoints

The default ellipsoid (WGS 84) is used.

Parameters:

a3DEditablePointList - A point list containing lon-lat points.

TLcdLonLatHeightPolygon

public TLcdLonLatHeightPolygon(ILcd3DEditablePointList a3DEditablePointList,
                               ILcdEllipsoid aEllipsoid)

Creates a polygon using the given point list.

• The point list and the points therein are not copied, and can be modified by this object
• The point list should contain TLcdLonLatHeightPoints

Parameters:

a3DEditablePointList - A point list containing lon-lat points.

aEllipsoid - the ellipsoid on which to define the polygon

TLcdLonLatHeightPolygon

public TLcdLonLatHeightPolygon(TLcdLonLatHeightPolygon aLonLatHeightPolygon,
                               boolean aDeepCopy)

Creates a polygon based on another polygon.

• When aDeepCopy is true, and the given polygon has a cloneable pointlist (see ILcdCloneable, for example TLcd3DEditablePointList), the underlying points will be cloned.
• Otherwise, the underlying pointlist is re-used by the new polygon, and updates affect both polygons.

Parameters:

aLonLatHeightPolygon - The polygon to copy

aDeepCopy - whether to make a copy of the points, if possible

TLcdLonLatHeightPolygon

public TLcdLonLatHeightPolygon(TLcdLonLatHeightPolygon aLonLatHeightPolygon)

Creates copy of another polygon.

• The new polygon is a deep copy of the given object, and updates do not affect each-other.

Parameters:

aLonLatHeightPolygon - The polygon to copy

Method Detail

getEllipsoid

public ILcdEllipsoid getEllipsoid()

Get the ellipsoid used for this polygon.

Returns:

the ellipsoid using for this polygon

setEllipsoid

public void setEllipsoid(ILcdEllipsoid aEllipsoid)

Set the ellipsoid used for this polygon.

Parameters:

aEllipsoid - the new ellipsoid

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 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.

calculateBounds

protected ILcd3DEditableBounds calculateBounds()

Description copied from class: ALcd3DEditablePolypoint

This method should compute the bounds of the polypoint. The resulting ILcd2DEditableBounds should be stored in fBounds.

Overrides:

calculateBounds in class TLcdLonLatHeightPolypoint

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)

contains3D

public boolean contains3D(ILcdPoint aPoint)

Description copied from class: ALcdShape

Checks whether this ALcdShape contains the given point in the 3D space.

Specified by:

contains3D in interface ILcdShape

Overrides:

contains3D in class ALcdShape

Parameters:

aPoint - the point to test.

Returns:

the boolean result of the containment test.

See Also:

ILcdShape.contains3D(double, double, double)

contains3D

public boolean contains3D(double aX,
                          double aY,
                          double aZ)

Returns whether the specified point is contained within this polygon. A point is considered contained inside the polygon if:

• the projection (on the earth's surface, aZ == 0) of the point is contained within the projection (on the earth's surface) of this polygon
• and the z value of the point lies between the minimum and maximum z value of this polygon.

If the z values of the tested point and all points of the polygon are identical, this corresponds to a simple contains2D test.

Specified by:

contains3D in interface ILcdShape

Overrides:

contains3D in class ALcd3DEditablePolypoint

Parameters:

aX - the first coordinate of the point

aY - the second coordinate of the point

aZ - the third coordinate of the point

Returns:

whether the specified point is contained within this polygon.

contains2D

public boolean contains2D(double aLon,
                          double aLat)

Determines whether this contains the given point. This method uses the TLcdSphereUtil method.

Specified by:

contains2D in interface ILcdShape

Overrides:

contains2D in class ALcd3DEditablePolypoint

Parameters:

aLon - the x coordinate of the point.

aLat - the y coordinate of the point.

Returns:

the boolean result of the containment test.

clone

public Object clone()

Creates and returns a copy of this object.

The contained editable points list is cloned. If cloning is not possible, a warning is sent to the log and a shallow copy is returned.

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 TLcdLonLatHeightPolypoint

See Also:

Object.clone()

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