Package com.luciad.format.gml31.model

Class TLcdGML31OrientableCurve

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.TLcdGML31AbstractGeometricPrimitive
com.luciad.format.gml31.model.TLcdGML31AbstractCurve
com.luciad.format.gml31.model.TLcdGML31OrientableCurve
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdCurve, ILcdShape, ILcdCloneable, ILcdDeepCloneable, ILcdFeatured, ILcdSelfDescribedFeatured, Serializable, Cloneable
public class TLcdGML31OrientableCurve extends TLcdGML31AbstractCurve implements ILcdShape, ILcdCurve
OrientableCurve consists of a curve and an orientation. If the orientation is "+", then the OrientableCurve is identical to the baseCurve. If the orientation is "-", then the OrientableCurve is related to another AbstractCurve with a parameterization that reverses the sense of the curve traversal.
Since:
10.0
See Also:

  • Field Details

    • ORIENTATION_PROPERTY

      public static final TLcdDataProperty ORIENTATION_PROPERTY
      Data property that maps to the orientation attribute. The possible values for this property are instances of ELcdGML31Sign.

    • BASE_CURVE_PROPERTY

      public static final TLcdDataProperty BASE_CURVE_PROPERTY
      Data property that maps to the baseCurve element. The possible values for this property are instances of 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

    • TLcdGML31OrientableCurve

      public TLcdGML31OrientableCurve()

    • TLcdGML31OrientableCurve

      public TLcdGML31OrientableCurve(TLcdDataType aType)

    • TLcdGML31OrientableCurve

      public TLcdGML31OrientableCurve(TLcdGML31AbstractCurve aBaseCurve, ELcdGML31Sign aForwardOrientation)
      Constructs an orientable curve for a given base curve.
      Parameters:
      aBaseCurve - the base curve for this object
      aForwardOrientation - the orientation of the base curve

    • TLcdGML31OrientableCurve

      public TLcdGML31OrientableCurve(TLcdDataType aDataType, ILcdModelReference aSrs)
      Constructs an orientable curve and initializes its model reference (srs).
      Parameters:
      aDataType - the data type for this object
      aSrs - the model reference for this object
      See Also:

    • TLcdGML31OrientableCurve

      public TLcdGML31OrientableCurve(ILcdModelReference aSrs)
      Constructs an orientable curve and initializes its model reference (srs).
      Parameters:
      aSrs - the model reference for this object
      See Also:

  • Method Details

    • 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
      Overrides:
      getStartPoint in class TLcdGML31AbstractCurve
      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 ILcdCurve
      Overrides:
      getEndPoint in class TLcdGML31AbstractCurve
      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 interface ILcdCurve
      Overrides:
      getStartTangent2D in class TLcdGML31AbstractCurve
      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 TLcdGML31AbstractCurve
      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.

      Specified by:
      getTangent2D in interface ILcdCurve
      Overrides:
      getTangent2D in class TLcdGML31AbstractCurve
      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 TLcdGML31AbstractCurve
      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.
      Specified by:
      computePointSFCT in interface ILcdCurve
      Overrides:
      computePointSFCT in class TLcdGML31AbstractCurve
      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 ILcdCurve
      Overrides:
      getInterpolation in class TLcdGML31AbstractCurve
      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 TLcdGML31AbstractCurve
      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

    • 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 TLcdGML31AbstractGeometry
      Returns:
      the focus point of this ILcdShape.

    • contains2D

      public boolean contains2D(ILcdPoint aILcdPoint)
      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 TLcdGML31AbstractGeometry
      Parameters:
      aILcdPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains2D

      public boolean contains2D(double v, double v1)
      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 TLcdGML31AbstractGeometry
      Parameters:
      v - the x coordinate of the point.
      v1 - the y coordinate of the point.
      Returns:
      the boolean result of the containment test.

    • contains3D

      public boolean contains3D(ILcdPoint aILcdPoint)
      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 TLcdGML31AbstractGeometry
      Parameters:
      aILcdPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains3D

      public boolean contains3D(double v, double v1, double v2)
      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 TLcdGML31AbstractGeometry
      Parameters:
      v - the x coordinate of the point.
      v1 - the y coordinate of the point.
      v2 - the z coordinate of the point.
      Returns:
      the boolean result of the containment test.

    • 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 TLcdGML31AbstractGeometry
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

    • getOrientation

      public ELcdGML31Sign getOrientation()
      Returns the value of the property that maps to the orientation attribute.

      If the orientation is "+", then the OrientableCurve is identical to the baseCurve. If the orientation is "-", then the OrientableCurve is related to another _Curve with a parameterization that reverses the sense of the curve traversal. "+" is the default value.

      Returns:
      the value of the ORIENTATION_PROPERTY property.

    • setOrientation

      public void setOrientation(ELcdGML31Sign aValue)
      Sets the value of the property that maps to the orientation attribute.

      If the orientation is "+", then the OrientableCurve is identical to the baseCurve. If the orientation is "-", then the OrientableCurve is related to another _Curve with a parameterization that reverses the sense of the curve traversal. "+" is the default value.

      Parameters:
      aValue - the value to set for the ORIENTATION_PROPERTY property.

    • getBaseCurve

      public TLcdGML31AbstractCurve getBaseCurve()
      Returns the value of the property that maps to the baseCurve 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 BASE_CURVE_PROPERTY property.
      See Also:

    • setBaseCurve

      public void setBaseCurve(TLcdGML31AbstractCurve aValue)
      Sets the value of the property that maps to the baseCurve 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".

      Parameters:
      aValue - the value to set for the BASE_CURVE_PROPERTY property.

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