Package com.luciad.format.nvg.nvg20.model

Class TLcdNVG20EllipticRing

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.nvg.nvg20.model.TLcdNVG20EllipticRing
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdCurve, ILcdEllipse, ILcdRing, ILcdShape, ILcd2DEditableEllipse, ILcd2DEditableShape, ILcdCache, ILcdCloneable, ILcdDeepCloneable, ILcdInvalidateable, Serializable, Cloneable
public class TLcdNVG20EllipticRing extends TLcdDataObject implements ILcd2DEditableEllipse, ILcdInvalidateable, ILcdCache, ILcdRing
Implementation of an ILcd2DEditableEllipse that represents an NVG 2.0 Elliptic Ring.
Since:
2015.0
See Also:

  • Field Details

    • X_PROPERTY

      public static final TLcdDataProperty X_PROPERTY
      Data property that maps to the cx attribute. The possible values for this property are instances of double.

    • Y_PROPERTY

      public static final TLcdDataProperty Y_PROPERTY
      Data property that maps to the cy attribute. The possible values for this property are instances of double.

    • ROT_ANGLE_PROPERTY

      public static final TLcdDataProperty ROT_ANGLE_PROPERTY
      Data property that maps to the rotation attribute. The possible values for this property are instances of double.

    • A_PROPERTY

      public static final TLcdDataProperty A_PROPERTY
      Data property that maps to the rx attribute. The possible values for this property are instances of double.

    • B_PROPERTY

      public static final TLcdDataProperty B_PROPERTY
      Data property that maps to the ry attribute. The possible values for this property are instances of double.

  • Constructor Details

    • TLcdNVG20EllipticRing

      public TLcdNVG20EllipticRing()

    • TLcdNVG20EllipticRing

      public TLcdNVG20EllipticRing(TLcdDataType aDataType)
      Constructs a new instance of TLcdNVG20EllipticRing with the given data type.
      Parameters:
      aDataType - The data type of the elliptic ring

  • Method Details

    • getCenter

      public ILcdPoint getCenter()
      Description copied from interface: ILcdEllipse
      Returns the center of this ILcdEllipse.
      Specified by:
      getCenter in interface ILcdEllipse
      Returns:
      the center of this ILcdEllipse.

    • 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 interface ILcdInvalidateable

    • getEllipsoid

      public ILcdEllipsoid getEllipsoid()

    • setEllipsoid

      public void setEllipsoid(ILcdEllipsoid aEllipsoid)

    • getFocusPoint

      public ILcdPoint getFocusPoint()
      Description copied from interface: ILcdShape
      Returns the focus point of this ILcdShape.
      Specified by:
      getFocusPoint in interface ILcdShape
      Returns:
      the focus point of this ILcdShape.

    • corner2DEditablePointSFCT

      public void corner2DEditablePointSFCT(int aCorner, ILcd2DEditablePoint a2DEditablePointSFCT)
      Description copied from interface: ILcdEllipse
      Computes the position of the specified corner of this ILcdEllipse.
      Specified by:
      corner2DEditablePointSFCT in interface ILcdEllipse
      Parameters:
      aCorner - the corner: ILcdEllipse.MAJOR_RADIUS_CORNER, ILcdEllipse.MINOR_RADIUS_CORNER, ILcdEllipse.MAJOR_RADIUS_OPPOSITE_CORNER, ILcdEllipse.MINOR_RADIUS_OPPOSITE_CORNER.
      a2DEditablePointSFCT - an ILcd2DEditablePoint into which the result is written as a side-effect.

    • updateForCornerPoint2D

      public void updateForCornerPoint2D(int aCorner, ILcdPoint aPoint)
      Description copied from interface: ILcd2DEditableEllipse
      Updates the ellipse for the specified corner point location. The end point of the axis should be at the specified location on return of this method.
      Specified by:
      updateForCornerPoint2D in interface ILcd2DEditableEllipse
      Parameters:
      aCorner - a constant indicating which corner is to be moved: ILcdEllipse.MAJOR_RADIUS_CORNER, ILcdEllipse.MINOR_RADIUS_CORNER, ILcdEllipse.MAJOR_RADIUS_OPPOSITE_CORNER, ILcdEllipse.MINOR_RADIUS_OPPOSITE_CORNER.
      aPoint - the new coordinate of the point.

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

    • contains2D

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

    • contains2D

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

    • translate2D

      public void translate2D(double x, double y)
      Description copied from interface: ILcd2DEditableShape
      Translates this ILcd2DEditableShape from its current position over the given translation vector in the 2D space. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
      Specified by:
      translate2D in interface ILcd2DEditableShape
      Parameters:
      x - the x coordinate of the translation vector.
      y - the y coordinate of the translation vector.

    • move2D

      public void move2D(double x, double y)
      Description copied from interface: ILcd2DEditableShape
      Moves this ILcd2DEditableShape to the given point in the 2D space. The focus point is used as the handle by which the shape is moved. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
      Specified by:
      move2D in interface ILcd2DEditableShape
      Parameters:
      x - the x coordinate of the point.
      y - the y coordinate of the point.

    • insertIntoCache

      public void insertIntoCache(Object aKey, Object aObject)
      Description copied from interface: ILcdCache
      Inserts a cache Object corresponding to the given key Object.
      Specified by:
      insertIntoCache in interface ILcdCache
      Parameters:
      aKey - the key Object that will be used to identify the Object. The key must therefore be a unique identifier, typically the caller itself: insertIntoCache(this, ...).
      aObject - the Object to be cached.

    • getCachedObject

      public Object getCachedObject(Object aKey)
      Description copied from interface: ILcdCache
      Looks up and returns the cached Object corresponding to the given key.
      Specified by:
      getCachedObject in interface ILcdCache
      Parameters:
      aKey - the key Object that was used for storing the cache Object.
      Returns:
      the cached Object, or null if there is no Object corresponding to the given key.

    • removeCachedObject

      public Object removeCachedObject(Object aKey)
      Description copied from interface: ILcdCache
      Looks up and removes the cached Object corresponding to the given key.
      Specified by:
      removeCachedObject in interface ILcdCache
      Parameters:
      aKey - the key Object that was used for storing the cache Object.
      Returns:
      the cached Object, or null if there was no Object corresponding to the given key.

    • clearCache

      public void clearCache()
      Description copied from interface: ILcdCache
      Clears the cache.
      Specified by:
      clearCache in interface ILcdCache

    • move2D

      public void move2D(ILcdPoint aPoint)
      Description copied from interface: ILcd2DEditableShape
      Moves this ILcd2DEditableShape to the given point in the 2D space. The focus point is used as the handle by which the shape is moved. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered. The third dimension is left unchanged.
      Specified by:
      move2D in interface ILcd2DEditableShape
      Parameters:
      aPoint - the ILcdPoint to move to.
      See Also:

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

    • 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
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • 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

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

    • 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
      Parameters:
      aParam - a value of the closed interval [0,1]
      aPointSFCT - the point to store the computed curve point in

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

    • 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
      Parameters:
      aParam - a value of the closed interval [0,1]
      Returns:
      the curve's angle in the point defined by the given parameter

    • 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

    • 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

    • 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

    • 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

    • setX

      public void setX(double aValue)
      Sets the value of the property that maps to the cx attribute.

      Center longitude in decimal degrees (WGS84)

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

    • setY

      public void setY(double aValue)
      Sets the value of the property that maps to the cy attribute.

      Center latitude in decimal degrees (WGS84)

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

    • setRotAngle

      public void setRotAngle(double aValue)
      Sets the value of the property that maps to the rotation attribute.

      Rotation in the counter-clockwise direction around the center point (cx, cy). The default value is 0.0 degrees rotation.

      Specified by:
      setRotAngle in interface ILcd2DEditableEllipse
      Parameters:
      aValue - the value to set for the ROT_ANGLE_PROPERTY property.

    • setA

      public void setA(double aValue)
      Sets the value of the property that maps to the rx attribute.

      The radius of the ellipse along the X axis (East/West) prior to rotation, in meters. This number should be positive.

      Specified by:
      setA in interface ILcd2DEditableEllipse
      Parameters:
      aValue - the value to set for the A_PROPERTY property.

    • setB

      public void setB(double aValue)
      Sets the value of the property that maps to the ry attribute.

      The radius of the ellipse along the Y axis (North/South) prior to rotation, in meters. This number should be positive.

      Specified by:
      setB in interface ILcd2DEditableEllipse
      Parameters:
      aValue - the value to set for the B_PROPERTY property.

    • clone

      public TLcdNVG20EllipticRing 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:

    • clone

      public TLcdNVG20EllipticRing 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

    • getX

      public double getX()
      Returns the value of the property that maps to the cx attribute.

      Center longitude in decimal degrees (WGS84)

      Returns:
      the value of the X_PROPERTY property.

    • getY

      public double getY()
      Returns the value of the property that maps to the cy attribute.

      Center latitude in decimal degrees (WGS84)

      Returns:
      the value of the Y_PROPERTY property.

    • getRotAngle

      public double getRotAngle()
      Returns the value of the property that maps to the rotation attribute.

      Rotation in the counter-clockwise direction around the center point (cx, cy). The default value is 0.0 degrees rotation.

      Returns:
      the value of the ROT_ANGLE_PROPERTY property.

    • getA

      public double getA()
      Returns the value of the property that maps to the rx attribute.

      The radius of the ellipse along the X axis (East/West) prior to rotation, in meters. This number should be positive.

      Returns:
      the value of the A_PROPERTY property.

    • getB

      public double getB()
      Returns the value of the property that maps to the ry attribute.

      The radius of the ellipse along the Y axis (North/South) prior to rotation, in meters. This number should be positive.

      Returns:
      the value of the B_PROPERTY property.