Package com.luciad.format.gml31.model

Class TLcdGML31OffsetCurve

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.datamodel.TLcdFeaturedDataObject
com.luciad.format.gml31.model.TLcdGML31AbstractCurveSegment
com.luciad.format.gml31.model.TLcdGML31OffsetCurve
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdCurve, ILcdShape, ILcdCloneable, ILcdDeepCloneable, ILcdFeatured, ILcdSelfDescribedFeatured, Serializable, Cloneable
public class TLcdGML31OffsetCurve extends TLcdGML31AbstractCurveSegment
An offset curve is a curve at a constant distance from the basis curve. They can be useful as a cheap and simple alternative to constructing curves that are offsets by definition.
Since:
10.0
See Also:

  • Field Details

    • OFFSET_BASE_PROPERTY

      public static final TLcdDataProperty OFFSET_BASE_PROPERTY
      Data property that maps to the offsetBase element. The possible values for this property are instances of TLcdGML31CurveProperty.

    • DISTANCE_PROPERTY

      public static final TLcdDataProperty DISTANCE_PROPERTY
      Data property that maps to the distance element. The possible values for this property are instances of TLcdGML31Length.

    • REF_DIRECTION_PROPERTY

      public static final TLcdDataProperty REF_DIRECTION_PROPERTY
      Data property that maps to the refDirection element. The possible values for this property are instances of TLcdGML31Vector.

    • NUM_DERIVATIVE_INTERIOR_PROPERTY

      public static final TLcdDataProperty NUM_DERIVATIVE_INTERIOR_PROPERTY
      Data property that maps to the numDerivativeInterior attribute. The possible values for this property are instances of long.

    • NUM_DERIVATIVES_AT_END_PROPERTY

      public static final TLcdDataProperty NUM_DERIVATIVES_AT_END_PROPERTY
      Data property that maps to the numDerivativesAtEnd attribute. The possible values for this property are instances of long.

    • NUM_DERIVATIVES_AT_START_PROPERTY

      public static final TLcdDataProperty NUM_DERIVATIVES_AT_START_PROPERTY
      Data property that maps to the numDerivativesAtStart attribute. The possible values for this property are instances of long.

  • Constructor Details

    • TLcdGML31OffsetCurve

      public TLcdGML31OffsetCurve()

    • TLcdGML31OffsetCurve

      public TLcdGML31OffsetCurve(TLcdDataType aType)

  • Method Details

    • getOffsetBase

      public TLcdGML31AbstractCurve getOffsetBase()
      Returns the value of the property that maps to the offsetBase element.

      offsetBase is a reference to thecurve from which this curve is define as an offset.

      Returns:
      the value of the OFFSET_BASE_PROPERTY property.
      See Also:

    • setOffsetBase

      public void setOffsetBase(TLcdGML31AbstractCurve aValue)
      Sets the value of the property that maps to the offsetBase element.

      offsetBase is a reference to thecurve from which this curve is define as an offset.

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

    • getDistance

      public TLcdGML31Length getDistance()
      Returns the value of the property that maps to the distance element.

      distance is the distance at which the offset curve is generated from the basis curve. In 2D systems, positive distances are to be to the left of the basis curve, and the negative distances are to be to the right of the basis curve.

      Returns:
      the value of the DISTANCE_PROPERTY property.

    • setDistance

      public void setDistance(TLcdGML31Length aValue)
      Sets the value of the property that maps to the distance element.

      distance is the distance at which the offset curve is generated from the basis curve. In 2D systems, positive distances are to be to the left of the basis curve, and the negative distances are to be to the right of the basis curve.

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

    • getRefDirection

      public TLcdGML31Vector getRefDirection()
      Returns the value of the property that maps to the refDirection element.

      refDistance is used to define the vector direction of the offset curve from the basis curve. It can be omitted in the 2D case, where the distance can be positive or negative. In that case, distance defines left side (positive distance) or right side (negative distance) with respect to the tangent to the basis curve. In 3D the basis curve shall have a well defined tangent direction for every point. The offset curve at any point in 3D, the basis curve shall have a well-defined tangent direction for every point. The offset curve at any point (parameter) on the basis curve c is in the direction - - - - s = v x t where v = c.refDirection() and - t = c.tangent() - For the offset direction to be well-defined, v shall not on any point of the curve be in the same, or opposite, direction as - t. The default value of the refDirection shall be the local co-ordinate axis vector for elevation, which indicates up for the curve in a geographic sense. NOTE! If the refDirection is the positive tangent to the local elevation axis ("points upward"), then the offset vector points to the left of the curve when viewed from above.

      Returns:
      the value of the REF_DIRECTION_PROPERTY property.

    • setRefDirection

      public void setRefDirection(TLcdGML31Vector aValue)
      Sets the value of the property that maps to the refDirection element.

      refDistance is used to define the vector direction of the offset curve from the basis curve. It can be omitted in the 2D case, where the distance can be positive or negative. In that case, distance defines left side (positive distance) or right side (negative distance) with respect to the tangent to the basis curve. In 3D the basis curve shall have a well defined tangent direction for every point. The offset curve at any point in 3D, the basis curve shall have a well-defined tangent direction for every point. The offset curve at any point (parameter) on the basis curve c is in the direction - - - - s = v x t where v = c.refDirection() and - t = c.tangent() - For the offset direction to be well-defined, v shall not on any point of the curve be in the same, or opposite, direction as - t. The default value of the refDirection shall be the local co-ordinate axis vector for elevation, which indicates up for the curve in a geographic sense. NOTE! If the refDirection is the positive tangent to the local elevation axis ("points upward"), then the offset vector points to the left of the curve when viewed from above.

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

    • getNumDerivativeInterior

      public long getNumDerivativeInterior()
      Returns the value of the property that maps to the numDerivativeInterior attribute.

      The attribute "numDerivativesInterior" specifies the type of continuity that is guaranteed interior to the curve. The default value of "0" means simple continuity, which is a mandatory minimum level of continuity. This level is referred to as "C 0 " in mathematical texts. A value of 1 means that the function and its first derivative are continuous at the appropriate end point: "C 1 " continuity. A value of "n" for any integer means the function and its first n derivatives are continuous: "C n " continuity. NOTE: Use of these values is only appropriate when the basic curve definition is an underdetermined system. For example, line string segments cannot support continuity above C 0 , since there is no spare control parameter to adjust the incoming angle at the end points of the segment. Spline functions on the other hand often have extra degrees of freedom on end segments that allow them to adjust the values of the derivatives to support C 1 or higher continuity.

      Returns:
      the value of the NUM_DERIVATIVE_INTERIOR_PROPERTY property.

    • setNumDerivativeInterior

      public void setNumDerivativeInterior(long aValue)
      Sets the value of the property that maps to the numDerivativeInterior attribute.

      The attribute "numDerivativesInterior" specifies the type of continuity that is guaranteed interior to the curve. The default value of "0" means simple continuity, which is a mandatory minimum level of continuity. This level is referred to as "C 0 " in mathematical texts. A value of 1 means that the function and its first derivative are continuous at the appropriate end point: "C 1 " continuity. A value of "n" for any integer means the function and its first n derivatives are continuous: "C n " continuity. NOTE: Use of these values is only appropriate when the basic curve definition is an underdetermined system. For example, line string segments cannot support continuity above C 0 , since there is no spare control parameter to adjust the incoming angle at the end points of the segment. Spline functions on the other hand often have extra degrees of freedom on end segments that allow them to adjust the values of the derivatives to support C 1 or higher continuity.

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

    • getNumDerivativesAtEnd

      public long getNumDerivativesAtEnd()
      Returns the value of the property that maps to the numDerivativesAtEnd attribute.

      The attribute "numDerivativesAtEnd" specifies the type of continuity between this curve segment and its successor. If this is the last curve segment in the curve, one of these values, as appropriate, is ignored. The default value of "0" means simple continuity, which is a mandatory minimum level of continuity. This level is referred to as "C 0 " in mathematical texts. A value of 1 means that the function and its first derivative are continuous at the appropriate end point: "C 1 " continuity. A value of "n" for any integer means the function and its first n derivatives are continuous: "C n " continuity. NOTE: Use of these values is only appropriate when the basic curve definition is an underdetermined system. For example, line string segments cannot support continuity above C 0 , since there is no spare control parameter to adjust the incoming angle at the end points of the segment. Spline functions on the other hand often have extra degrees of freedom on end segments that allow them to adjust the values of the derivatives to support C 1 or higher continuity.

      Returns:
      the value of the NUM_DERIVATIVES_AT_END_PROPERTY property.

    • setNumDerivativesAtEnd

      public void setNumDerivativesAtEnd(long aValue)
      Sets the value of the property that maps to the numDerivativesAtEnd attribute.

      The attribute "numDerivativesAtEnd" specifies the type of continuity between this curve segment and its successor. If this is the last curve segment in the curve, one of these values, as appropriate, is ignored. The default value of "0" means simple continuity, which is a mandatory minimum level of continuity. This level is referred to as "C 0 " in mathematical texts. A value of 1 means that the function and its first derivative are continuous at the appropriate end point: "C 1 " continuity. A value of "n" for any integer means the function and its first n derivatives are continuous: "C n " continuity. NOTE: Use of these values is only appropriate when the basic curve definition is an underdetermined system. For example, line string segments cannot support continuity above C 0 , since there is no spare control parameter to adjust the incoming angle at the end points of the segment. Spline functions on the other hand often have extra degrees of freedom on end segments that allow them to adjust the values of the derivatives to support C 1 or higher continuity.

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

    • getNumDerivativesAtStart

      public long getNumDerivativesAtStart()
      Returns the value of the property that maps to the numDerivativesAtStart attribute.

      The attribute "numDerivativesAtStart" specifies the type of continuity between this curve segment and its predecessor. If this is the first curve segment in the curve, one of these values, as appropriate, is ignored. The default value of "0" means simple continuity, which is a mandatory minimum level of continuity. This level is referred to as "C 0 " in mathematical texts. A value of 1 means that the function and its first derivative are continuous at the appropriate end point: "C 1 " continuity. A value of "n" for any integer means the function and its first n derivatives are continuous: "C n " continuity. NOTE: Use of these values is only appropriate when the basic curve definition is an underdetermined system. For example, line string segments cannot support continuity above C 0 , since there is no spare control parameter to adjust the incoming angle at the end points of the segment. Spline functions on the other hand often have extra degrees of freedom on end segments that allow them to adjust the values of the derivatives to support C 1 or higher continuity.

      Returns:
      the value of the NUM_DERIVATIVES_AT_START_PROPERTY property.

    • setNumDerivativesAtStart

      public void setNumDerivativesAtStart(long aValue)
      Sets the value of the property that maps to the numDerivativesAtStart attribute.

      The attribute "numDerivativesAtStart" specifies the type of continuity between this curve segment and its predecessor. If this is the first curve segment in the curve, one of these values, as appropriate, is ignored. The default value of "0" means simple continuity, which is a mandatory minimum level of continuity. This level is referred to as "C 0 " in mathematical texts. A value of 1 means that the function and its first derivative are continuous at the appropriate end point: "C 1 " continuity. A value of "n" for any integer means the function and its first n derivatives are continuous: "C n " continuity. NOTE: Use of these values is only appropriate when the basic curve definition is an underdetermined system. For example, line string segments cannot support continuity above C 0 , since there is no spare control parameter to adjust the incoming angle at the end points of the segment. Spline functions on the other hand often have extra degrees of freedom on end segments that allow them to adjust the values of the derivatives to support C 1 or higher continuity.

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