Class TLcdGML31Curve
- All Implemented Interfaces:
ILcdDataObject
,ILcdBounded
,ILcdCompositeCurve
,ILcdCurve
,ILcdEditableCompositeCurve
,ILcdShape
,ILcdCloneable
,ILcdDeepCloneable
,ILcdFeatured
,ILcdInvalidateable
,ILcdSelfDescribedFeatured
,Serializable
,Cloneable
- Since:
- 10.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final TLcdDataProperty
Property that maps on thegid
attribute.static final TLcdDataProperty
Data property that maps to thesegments
element.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
ConstructorDescriptionTLcdGML31Curve
(TLcdDataType aType) TLcdGML31Curve
(TLcdDataType aDataType, ILcdModelReference aSrs) Constructs a curve and initializes its model reference (srs).Constructs a curve and initializes its model reference (srs). -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a deep clone of this object.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 thisILcdShape
contains the given point in the 2D space.boolean
contains2D
(ILcdPoint aPoint) Checks whether thisILcdShape
contains the givenILcdPoint
in the 2D space.boolean
contains3D
(double aX, double aY, double aZ) Checks whether thisILcdShape
contains the given point in the 3D space.boolean
contains3D
(ILcdPoint aPoint) Checks whether thisILcdShape
contains the givenILcdPoint
in the 3D space.boolean
Returns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.Returns a list with the curve's elements.Retrieves the end point of the curve.double
Returns the angle of the curve's tangent at the end point, in degrees counterclockwise from the direction at 3 o'clock.Returns the focus point of thisILcdShape
.getGid()
Gets the value of theGID_PROPERTY
property.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
Returns the number of intersections between this curve and a line segment defined by the two specified points.Returns the role value contained in the value of theSEGMENTS_PROPERTY
property.Retrieves the start point of the curve.double
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()
void
Invalidates all cached values of this object.void
Sets the value of theGID_PROPERTY
property.void
setSegments
(List<TLcdGML31AbstractCurveSegment> aValue) Sets the value of the property that maps to thesegments
element.void
setSrs
(ILcdModelReference aValue) Sets the value of theSRS_PROPERTY
property.void
setValue
(TLcdDataProperty aProperty, Object aValue) Sets the value of the given property for this data object.Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractCurve
getEndTangent, getLength, getStartTangent
Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGeometry
getSrs, 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
-
Field Details
-
SEGMENTS_PROPERTY
Data property that maps to thesegments
element. The possible values for this property are instances ofTLcdGML31CurveSegmentArrayProperty
. -
GID_PROPERTY
Property that maps on thegid
attribute. Acceptable values for this property are instances ofjava.lang.String
.
-
-
Constructor Details
-
TLcdGML31Curve
public TLcdGML31Curve() -
TLcdGML31Curve
-
TLcdGML31Curve
Constructs a curve and initializes its model reference (srs).- Parameters:
aSrs
- the model reference for this object- See Also:
-
TLcdGML31Curve
Constructs a curve and initializes its model reference (srs).- Parameters:
aDataType
- the data type of this curveaSrs
- the model reference for this object- See Also:
-
-
Method Details
-
setSrs
Description copied from class:TLcdGML31AbstractGeometry
Sets the value of theSRS_PROPERTY
property.- Overrides:
setSrs
in classTLcdGML31AbstractGeometry
- Parameters:
aValue
- the value to set for theSRS_PROPERTY
property.
-
setValue
Description copied from interface:ILcdDataObject
Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.
The given property must be declared in thedata object's type
or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw anIllegalArgumentException
.- Specified by:
setValue
in interfaceILcdDataObject
- Overrides:
setValue
in classTLcdDataObject
- Parameters:
aProperty
- the property for which the value is to be setaValue
- the value to set- See Also:
-
invalidateObject
public void invalidateObject()Description copied from interface:ILcdInvalidateable
Invalidates all cached values of this object. Call this method whenever one or more of this object's compositing values has been changed, to notify this object it needs to recompute its cached values.- Specified by:
invalidateObject
in interfaceILcdInvalidateable
-
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
orIllegalArgumentException
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 interfaceILcdCompositeCurve
- Returns:
- a list with the curve's elements
-
getStartPoint
Description copied from interface:ILcdCurve
Retrieves the start point of the curve.This is equivalent to
computePointSFCT(0)
.- Specified by:
getStartPoint
in interfaceILcdCompositeCurve
- Specified by:
getStartPoint
in interfaceILcdCurve
- Overrides:
getStartPoint
in classTLcdGML31AbstractCurve
- Returns:
- the start point of the curve
-
getEndPoint
Description copied from interface:ILcdCurve
Retrieves the end point of the curve.This is equivalent to
computePointSFCT(1)
.- Specified by:
getEndPoint
in interfaceILcdCompositeCurve
- Specified by:
getEndPoint
in interfaceILcdCurve
- Overrides:
getEndPoint
in classTLcdGML31AbstractCurve
- Returns:
- the end 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 interfaceILcdCurve
- Overrides:
getStartTangent2D
in classTLcdGML31AbstractCurve
- 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 interfaceILcdCurve
- Overrides:
getEndTangent2D
in classTLcdGML31AbstractCurve
- 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 interfaceILcdCurve
- Overrides:
getTangent2D
in classTLcdGML31AbstractCurve
- Parameters:
aParam
- a value of the closed interval [0,1]- Returns:
- the curve's angle in the point defined by the given parameter
- The tangent at parameter 0 is the same as
-
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 interfaceILcdCurve
- Overrides:
getLength2D
in classTLcdGML31AbstractCurve
- 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.
- When
-
computePointSFCT
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 interfaceILcdCurve
- Overrides:
computePointSFCT
in classTLcdGML31AbstractCurve
- Parameters:
aParam
- a value of the closed interval [0,1]aPointSFCT
- the point to store the computed curve point in
- At parameter 0, the point is the same as
-
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 interfaceILcdCompositeCurve
- Specified by:
getInterpolation
in interfaceILcdCurve
- Overrides:
getInterpolation
in classTLcdGML31AbstractCurve
- Returns:
- the interpolation method used by this curve.
-
getLineSegmentIntersectionCount
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 interfaceILcdCurve
- Overrides:
getLineSegmentIntersectionCount
in classTLcdGML31AbstractCurve
- Parameters:
aP1
- the first point of the line segmentaP2
- the second point of the line segment- Returns:
- the number of intersections between the curve and the line segment
-
getFocusPoint
Description copied from interface:ILcdShape
Returns the focus point of thisILcdShape
.- Specified by:
getFocusPoint
in interfaceILcdShape
- Overrides:
getFocusPoint
in classTLcdGML31AbstractGeometry
- Returns:
- the focus point of this
ILcdShape
.
-
contains2D
public boolean contains2D(double aX, double aY) Description copied from interface:ILcdShape
Checks whether thisILcdShape
contains the given point in the 2D space. Only the first two dimensions of theILcdShape
are considered.- Specified by:
contains2D
in interfaceILcdShape
- Overrides:
contains2D
in classTLcdGML31AbstractGeometry
- Parameters:
aX
- the x coordinate of the point.aY
- the y coordinate of the point.- Returns:
- the boolean result of the containment test.
-
contains3D
public boolean contains3D(double aX, double aY, double aZ) Description copied from interface:ILcdShape
Checks whether thisILcdShape
contains the given point in the 3D space.- Specified by:
contains3D
in interfaceILcdShape
- Overrides:
contains3D
in classTLcdGML31AbstractGeometry
- 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
Description copied from interface:ILcdShape
Checks whether thisILcdShape
contains the givenILcdPoint
in the 2D space. Only the first two dimensions of theILcdShape
and theILcdPoint
are considered.- Specified by:
contains2D
in interfaceILcdShape
- Overrides:
contains2D
in classTLcdGML31AbstractGeometry
- Parameters:
aPoint
- theILcdPoint
to test.- Returns:
- the boolean result of the containment test.
- See Also:
-
contains3D
Description copied from interface:ILcdShape
Checks whether thisILcdShape
contains the givenILcdPoint
in the 3D space.- Specified by:
contains3D
in interfaceILcdShape
- Overrides:
contains3D
in classTLcdGML31AbstractGeometry
- Parameters:
aPoint
- theILcdPoint
to test.- Returns:
- the boolean result of the containment test.
- See Also:
-
getBounds
Description copied from interface:ILcdBounded
Returns theILcdBounds
by which the geometry of thisILcdBounded
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 ofTLcdLonLatBounds
orTLcdXYBounds
.- Specified by:
getBounds
in interfaceILcdBounded
- Overrides:
getBounds
in classTLcdGML31AbstractGeometry
- Returns:
- the
ILcdBounds
by which the geometry of thisILcdBounded
object is bounded.
-
clone
Description copied from class:TLcdDataObject
Returns a deep clone of this object. This method delegates toTLcdDataObject.clone(Map)
.- Specified by:
clone
in interfaceILcdCloneable
- Overrides:
clone
in classTLcdDataObject
- Returns:
- a deep clone of this object
- See Also:
-
clone
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 thevalue.getDataType().newInstance()
method, and then cloning its properties one by one. - If the value implements
ILcdDeepCloneable
orILcdCloneable
then this interface is used to clone the value. - Otherwise, the property value is copied by reference.
- If the property value is an
- Specified by:
clone
in interfaceILcdDeepCloneable
- Overrides:
clone
in classTLcdDataObject
- 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
-
equals
-
hashCode
public int hashCode() -
getSegments
Returns the role value contained in the value of theSEGMENTS_PROPERTY
property. Returnsnull
if the value of theSEGMENTS_PROPERTY
property isnull
.This property element contains a list of curve segments. The order of the elements is significant and shall be preserved when processing the array.
- Returns:
- the role value of the
SEGMENTS_PROPERTY
property. - See Also:
-
setSegments
Sets the value of the property that maps to thesegments
element. to a new instance of the association classTLcdGML31CurveSegmentArrayProperty
initialized with the given role value. In case the given role value isnull
, theSEGMENTS_PROPERTY
property is set tonull
.This property element contains a list of curve segments. The order of the elements is significant and shall be preserved when processing the array.
- Parameters:
aValue
- the role value to set for theSEGMENTS_PROPERTY
property.
-
getGid
Gets the value of theGID_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
Sets the value of theGID_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 theGID_PROPERTY
property.
-