Package com.luciad.format.gml31.model

Class TLcdGML31Ring

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.datamodel.TLcdFeaturedDataObject

com.luciad.format.gml31.model.TLcdGML31AbstractGML

com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

com.luciad.format.gml31.model.TLcdGML31AbstractRing

com.luciad.format.gml31.model.TLcdGML31Ring

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdCompositeCurve, ILcdCurve, ILcdEditableCompositeCurve, ILcdRing, ILcdShape, ILcdCloneable, ILcdDeepCloneable, ILcdFeatured, ILcdSelfDescribedFeatured, Serializable, Cloneable

public class TLcdGML31Ring
extends TLcdGML31AbstractRing
implements ILcdEditableCompositeCurve, ILcdRing

A ring is used to represent a single connected component of a surface boundary as specified in ISO 19107:2003, 6.3.6. Every gml:curveMember references or contains one curve, i.e. any element which is substitutable for gml:AbstractCurve. In the context of a ring, the curves describe the boundary of the surface. The sequence of curves shall be contiguous and connected in a cycle. If provided, the aggregationType attribute shall have the value "sequence".

Since:

10.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final TLcdDataProperty	CURVE_MEMBER_PROPERTY	Data property that maps to the curveMember element.
static final TLcdDataProperty	GID_PROPERTY	Property that maps on the gid attribute.

Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

SRS_PROPERTY

Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML

DESCRIPTION_PROPERTY, ID_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY

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	Description
TLcdGML31Ring()
TLcdGML31Ring(TLcdDataType aType)

Method Summary

Modifier and Type	Method	Description
TLcdGML31Ring	clone()	Returns a deep clone of this object.
TLcdDataObject	clone(Map aObjectDictionary)	Returns a deep clone 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	contains2D(ILcdPoint aPoint)	Checks whether this ILcdShape contains the given ILcdPoint in the 2D space.
boolean	contains3D(double aX, double aY, double aZ)	Checks whether this ILcdShape contains the given point in the 3D space.
boolean	contains3D(ILcdPoint aPoint)	Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
ILcdBounds	getBounds()	Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
List<TLcdGML31AbstractCurve>	getCurveMember()	Returns the value of the property that maps to the curveMember element.
List<ILcdCurve>	getCurves()	Returns a list with the curve's elements.
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	getGid()	Gets the value of the GID_PROPERTY property.
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.
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	setGid(String aValue)	Sets the value of the GID_PROPERTY property.

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

getSrs, setSrs, toString

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML

getDescription, getId, getMetaDataProperty, getName, setDescription, setId

Methods inherited from class com.luciad.datamodel.TLcdFeaturedDataObject

canSetFeature, getFeature, getFeature, getFeatureCount, getFeaturedDescriptor, setFeature, setFeature

Methods inherited from class com.luciad.datamodel.TLcdDataObject

getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

CURVE_MEMBER_PROPERTY

public static final TLcdDataProperty CURVE_MEMBER_PROPERTY

Data property that maps to the curveMember element. The possible values for this property are instances of List<TLcdGML31CurveProperty>.

GID_PROPERTY

public static final TLcdDataProperty GID_PROPERTY

Property that maps on the gid attribute. Acceptable values for this property are instances of java.lang.String.

Constructor Details

TLcdGML31Ring

public TLcdGML31Ring()

TLcdGML31Ring

public TLcdGML31Ring(TLcdDataType aType)

Method Details

getCurves

public List<ILcdCurve> getCurves()

Description copied from interface: ILcdCompositeCurve

Returns a list with the curve's elements. Each sub-curve's end point, except for the last sub-curve, must coincide with the next sub-curve's start point.

The returned list is not guaranteed to be editable. See ILcdEditableCompositeCurve for an editable variant of this interface.

Note that this adding curves to the result of calling this method may throw a ClassCastException or IllegalArgumentException in case the class of the curve(s) to add is not compatible with the implementation of the composite curve. Implementations should specify in their documentation all restrictions that apply in this context.

Specified by:

getCurves in interface ILcdCompositeCurve

Returns:

a list with the curve's elements

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

Overrides:

getStartTangent2D in class TLcdGML31AbstractRing

Returns:

the curve's angle in the start point

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

Overrides:

getEndTangent2D in class TLcdGML31AbstractRing

Returns:

the curve's angle in the end 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

Overrides:

getTangent2D in class TLcdGML31AbstractRing

Parameters:

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

Returns:

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

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

Overrides:

getLength2D in class TLcdGML31AbstractRing

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.

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

Overrides:

computePointSFCT in class TLcdGML31AbstractRing

Parameters:

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

aPointSFCT - the point to store the computed curve point in

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 ILcdCompositeCurve

Specified by:

getInterpolation in interface ILcdCurve

Overrides:

getInterpolation in class TLcdGML31AbstractRing

Returns:

the interpolation method used by this 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

Overrides:

getLineSegmentIntersectionCount in class TLcdGML31AbstractRing

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 ILcdCompositeCurve

Specified by:

getStartPoint in interface ILcdCurve

Overrides:

getStartPoint in class TLcdGML31AbstractRing

Returns:

the start point of the curve

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 ILcdCompositeCurve

Specified by:

getEndPoint in interface ILcdCurve

Overrides:

getEndPoint in class TLcdGML31AbstractRing

Returns:

the end point of the curve

contains2D

public boolean contains2D(ILcdPoint aPoint)

Description copied from interface: ILcdShape

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

Specified by:

contains2D in interface ILcdShape

Overrides:

contains2D in class TLcdGML31AbstractRing

Parameters:

aPoint - the ILcdPoint 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 interface: ILcdShape

Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.

Specified by:

contains3D in interface ILcdShape

Overrides:

contains3D in class TLcdGML31AbstractRing

Parameters:

aPoint - the ILcdPoint 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)

Description copied from interface: ILcdShape

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

Specified by:

contains3D in interface ILcdShape

Overrides:

contains3D in class TLcdGML31AbstractRing

Parameters:

aX - the x coordinate of the point.

aY - the y coordinate of the point.

aZ - the z coordinate of the point.

Returns:

the boolean result of the containment test.

contains2D

public boolean contains2D(double aX,
 double aY)

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 TLcdGML31AbstractRing

Parameters:

aX - the x coordinate of the point.

aY - the y coordinate of the point.

Returns:

the boolean result of the containment test.

getFocusPoint

public ILcdPoint getFocusPoint()

Description copied from interface: ILcdShape

Returns the focus point of this ILcdShape.

Specified by:

getFocusPoint in interface ILcdShape

Overrides:

getFocusPoint in class TLcdGML31AbstractRing

Returns:

the focus point of this ILcdShape.

getBounds

public ILcdBounds getBounds()

Description copied from interface: ILcdBounded

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

Specified by:

getBounds in interface ILcdBounded

Overrides:

getBounds in class TLcdGML31AbstractRing

Returns:

the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

clone

public TLcdGML31Ring clone()

Description copied from class: TLcdDataObject

Returns a deep clone of this object. This method delegates to TLcdDataObject.clone(Map).

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class TLcdDataObject

Returns:

a deep clone of this object

See Also:

• Object.clone()

clone

public TLcdDataObject clone(Map aObjectDictionary)

Description copied from class: TLcdDataObject

Returns a deep clone of this object. If the clone is not already present in the dictionary, a new instance if created as follows:

• First, a new instance is created using Java's clone() mechanism.
• Then, all properties of this object are cloned and set on the newly created instance. A property is cloned as follows:
  • If the property value is an ILcdDataObject, the value is cloned by first creating a new instance via the value.getDataType().newInstance() method, and then cloning its properties one by one.
  • If the value implements ILcdDeepCloneable or ILcdCloneable then this interface is used to clone the value.
  • Otherwise, the property value is copied by reference.

Specified by:

clone in interface ILcdDeepCloneable

Overrides:

clone in class TLcdDataObject

Parameters:

aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.

Returns:

a deep clone of this object

getCurveMember

public List<TLcdGML31AbstractCurve> getCurveMember()

Returns the value of the property that maps to the curveMember element.

This property element either references a curve via the XLink-attributes or contains the curve element. A curve element is any element which is substitutable for "_Curve".

Returns:

the value of the CURVE_MEMBER_PROPERTY property.

See Also:

• List

getGid

public String getGid()

Gets the value of the GID_PROPERTY property.

This attribute is included for backward compatibility with GML 2 and is deprecated with GML 3. This identifer is superceded by "gml:id" inherited from AbstractGMLType. The attribute "gid" should not be used anymore and may be deleted in future versions of GML without further notice.

Returns:

the value of the GID_PROPERTY property.

setGid

public void setGid(String aValue)

Sets the value of the GID_PROPERTY property.

This attribute is included for backward compatibility with GML 2 and is deprecated with GML 3. This identifer is superceded by "gml:id" inherited from AbstractGMLType. The attribute "gid" should not be used anymore and may be deleted in future versions of GML without further notice.

Parameters:

aValue - the value to set for the GID_PROPERTY property.