Package com.luciad.format.nvg.nvg15.model

Class TLcdNVG15Circle

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.nvg.nvg15.model.TLcdNVG15Base
com.luciad.format.nvg.nvg15.model.TLcdNVG15DataObject
com.luciad.format.nvg.nvg15.model.TLcdNVG15MapObject
com.luciad.format.nvg.nvg15.model.TLcdNVG15Circle
All Implemented Interfaces:
ILcdDataObject, ILcdNVGNode, ILcdBounded, ILcdCircle, ILcdCurve, ILcdRing, ILcdShape, ILcd2DEditableCircle, ILcd2DEditableShape, ILcdCache, ILcdCloneable, ILcdDeepCloneable, ILcdInvalidateable, Serializable, Cloneable
public class TLcdNVG15Circle extends TLcdNVG15MapObject implements ILcd2DEditableCircle, ILcdRing, ILcdCache, ILcdInvalidateable
Implementation of ILcd2DEditableCircle that represents an NVG 1.5 Circle.
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.

    • RADIUS_PROPERTY

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

    • MODIFIERS_PROPERTY

      public static final TLcdDataProperty MODIFIERS_PROPERTY
      Data property that maps to the modifiers attribute. The possible values for this property are instances of TLcdNVGModifiers.

    • SYMBOL_PROPERTY

      public static final TLcdDataProperty SYMBOL_PROPERTY
      Data property that maps to the symbol attribute. The possible values for this property are instances of TLcdNVGSymbol.

    • LABEL_PROPERTY

      public static final TLcdDataProperty LABEL_PROPERTY
      Data property that maps to the label attribute. The possible values for this property are instances of String.

    • STYLE_PROPERTY

      public static final TLcdDataProperty STYLE_PROPERTY
      Data property that maps to the style attribute. The possible values for this property are instances of TLcdNVGStyle.

    • URI_PROPERTY

      public static final TLcdDataProperty URI_PROPERTY
      Data property that maps to the uri attribute. The possible values for this property are instances of URI.

  • Constructor Details

    • TLcdNVG15Circle

      public TLcdNVG15Circle()

    • TLcdNVG15Circle

      public TLcdNVG15Circle(TLcdDataType aDataType)
      Creates a new instance of TLcdNVG15Circle with the given data type.
      Parameters:
      aDataType - the data type for the circle.

  • Method Details

    • setX

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

      Longitude in decimal degrees using WGS-84 datum of center point of the circle.

      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.

      Latitude in decimal degrees using WGS-84 datum of center point of the circle.

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

    • setRadius

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

      Radius of the circle (distance).

      Specified by:
      setRadius in interface ILcd2DEditableCircle
      Parameters:
      aValue - the value to set for the RADIUS_PROPERTY property.

    • clone

      public TLcdNVG15Circle clone()
      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 TLcdNVG15Circle 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

    • insertIntoCache

      public void insertIntoCache(Object aKey, Object aObject)
      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)
      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)
      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()
      Clears the cache.
      Specified by:
      clearCache in interface ILcdCache

    • getCenter

      public ILcdPoint getCenter()
      Returns the center of this ILcdCircle.
      Specified by:
      getCenter in interface ILcdCircle
      Returns:
      the center of this ILcdCircle.

    • contains2D

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

    • contains2D

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

    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      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 aILcdPoint)
      Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aILcdPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • getFocusPoint

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

    • getBounds

      public ILcdBounds getBounds()
      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.

    • move2D

      public void move2D(double aX, double aY)
      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:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.

    • move2D

      public void move2D(ILcdPoint aILcdPoint)
      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:
      aILcdPoint - the ILcdPoint to move to.
      See Also:

    • translate2D

      public void translate2D(double aDeltaX, double aDeltaY)
      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:
      aDeltaX - the x coordinate of the translation vector.
      aDeltaY - the y coordinate of the translation vector.

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

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

    • 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

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

    • 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

    • symbolChanged

      protected void symbolChanged()

    • getX

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

      Longitude in decimal degrees using WGS-84 datum of center point of the circle.

      Returns:
      the value of the X_PROPERTY property.

    • getY

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

      Latitude in decimal degrees using WGS-84 datum of center point of the circle.

      Returns:
      the value of the Y_PROPERTY property.

    • getRadius

      public double getRadius()
      Returns the value of the property that maps to the r attribute.

      Radius of the circle (distance).

      Returns:
      the value of the RADIUS_PROPERTY property.

    • getModifiers

      public TLcdNVGModifiers getModifiers()
      Returns the value of the property that maps to the modifiers attribute.

      Modifiers to the specified symbology, possibly including rendering hints.

      Returns:
      the value of the MODIFIERS_PROPERTY property.

    • setModifiers

      public void setModifiers(TLcdNVGModifiers aValue)
      Sets the value of the property that maps to the modifiers attribute.

      Modifiers to the specified symbology, possibly including rendering hints.

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

    • getSymbol

      public TLcdNVGSymbol getSymbol()
      Returns the value of the property that maps to the symbol attribute.

      The symbol attribute is used to associate symbology with a given shape. Its format is the name of a standard followed by a colon and the text representation of the element in that standard. That standard can be used to derive the graphical representation of the element.

      Returns:
      the value of the SYMBOL_PROPERTY property.

    • setSymbol

      public void setSymbol(TLcdNVGSymbol aValue)
      Sets the value of the property that maps to the symbol attribute.

      The symbol attribute is used to associate symbology with a given shape. Its format is the name of a standard followed by a colon and the text representation of the element in that standard. That standard can be used to derive the graphical representation of the element.

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

    • getLabel

      public String getLabel()
      Returns the value of the property that maps to the label attribute.

      A textual representation of this element.

      Returns:
      the value of the LABEL_PROPERTY property.

    • setLabel

      public void setLabel(String aValue)
      Sets the value of the property that maps to the label attribute.

      A textual representation of this element.

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

    • getStyle

      public TLcdNVGStyle getStyle()
      Returns the value of the property that maps to the style attribute.

      CSS based style description which indicates how this element should be rendered graphically.

      Returns:
      the value of the STYLE_PROPERTY property.

    • setStyle

      public void setStyle(TLcdNVGStyle aValue)
      Sets the value of the property that maps to the style attribute.

      CSS based style description which indicates how this element should be rendered graphically.

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

    • getUri

      public URI getUri()
      Returns the value of the property that maps to the uri attribute.

      URI schema that uniquely identifies the object. See the URI Scheme for more details.

      Returns:
      the value of the URI_PROPERTY property.

    • setUri

      public void setUri(URI aValue)
      Sets the value of the property that maps to the uri attribute.

      URI schema that uniquely identifies the object. See the URI Scheme for more details.

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