Class TLcdNVG15Arrow

All Implemented Interfaces:
ILcdDataObject, ILcdNVGNode, ILcdBounded, ILcdCurve, ILcdGeoBuffer, ILcdPointList, ILcdPolyline, ILcdShape, ILcd2DEditableGeoBuffer, ILcd2DEditablePointList, ILcd2DEditablePolyline, ILcd2DEditableShape, ILcdCache, ILcdCloneable, ILcdDeepCloneable, ILcdInvalidateable, Serializable, Cloneable

Implementation of an ILcd2DEditableGeoBuffer with an ILcd2DEditablePolyline as an underlying shape that represents an NVG 1.5 Arrow.
Since:
2015.0
See Also:
  • Field Details

    • WIDTH_NVG_PROPERTY

      public static final TLcdDataProperty WIDTH_NVG_PROPERTY
      Data property that maps to the width attribute. The possible values for this property are instances of double.
    • LEG_TYPE_PROPERTY

      public static final TLcdDataProperty LEG_TYPE_PROPERTY
      Data property that maps to the leg-type attribute. The possible values for this property are instances of String.
    • POINTS_PROPERTY

      public static final TLcdDataProperty POINTS_PROPERTY
      Data property that maps to the points attribute. The possible values for this property are instances of ILcd2DEditablePointList.
    • 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

    • TLcdNVG15Arrow

      public TLcdNVG15Arrow()
    • TLcdNVG15Arrow

      public TLcdNVG15Arrow(TLcdDataType aDataType)
      Creates a new instance of TLcdNVG15Arrow with the given data type.
      Parameters:
      aDataType - the data type of the arrow.
  • Method Details

    • clone

      public TLcdNVG15Arrow 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 TLcdNVG15Polyline
      Returns:
      a deep clone of this object
      See Also:
    • clone

      public TLcdNVG15Arrow 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 TLcdNVG15Polyline
      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
    • setBaseShape

      public void setBaseShape(ILcdShape aBaseShape)
      Description copied from interface: ILcd2DEditableGeoBuffer
      Sets the base shape of the buffer.
      Specified by:
      setBaseShape in interface ILcd2DEditableGeoBuffer
      Parameters:
      aBaseShape - the base shape of the buffer.
    • setJoinStyle

      public void setJoinStyle(int aJoinStyle)
      Description copied from interface: ILcd2DEditableGeoBuffer
      Sets the join style of the buffer, which must be ILcdGeoBuffer.JOIN_ROUND.
      Specified by:
      setJoinStyle in interface ILcd2DEditableGeoBuffer
      Parameters:
      aJoinStyle - the join style of the buffer.
    • setEndCapStyle

      public void setEndCapStyle(int aEndCapStyle)
      Description copied from interface: ILcd2DEditableGeoBuffer
      Sets the end cap style of the buffer, which must be either ILcdGeoBuffer.CAP_BUTT or ILcdGeoBuffer.CAP_ROUND.
      Specified by:
      setEndCapStyle in interface ILcd2DEditableGeoBuffer
      Parameters:
      aEndCapStyle - the end cap style of the buffer.
    • setWidth

      public void setWidth(double aWidth)
      Description copied from interface: ILcd2DEditableGeoBuffer
      Sets the width of the buffer, expressed in meters and measured from the axis to the border.
      Specified by:
      setWidth in interface ILcd2DEditableGeoBuffer
      Parameters:
      aWidth - the width of the buffer.
    • getWidth

      public double getWidth()
      Description copied from interface: ILcdGeoBuffer
      Returns the width of this buffer, expressed in meters and measured from the line segments of the base shape to the contour. The width is positive (width >= 0).
      Specified by:
      getWidth in interface ILcdGeoBuffer
      Returns:
      the width of the buffer.
    • getBaseShape

      public ILcd2DEditablePolyline getBaseShape()
      Description copied from interface: ILcdGeoBuffer
      Returns the base shape of the buffer.
      Specified by:
      getBaseShape in interface ILcdGeoBuffer
      Returns:
      the base shape of the buffer.
    • setWidthNVG

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

      Width of the corridor (distance)

      Parameters:
      aValue - the value to set for the WIDTH_NVG_PROPERTY property.
    • 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
      Overrides:
      invalidateObject in class TLcdNVG15Polyline
    • setPoints

      public void setPoints(ILcd2DEditablePointList aValue)
      Sets the value of the property that maps to the points attribute.

      Point list in decimal degrees, coordinate pairs, separated by spaces: lon1,lat1 lon2,lat2 ... lonn,latn

      Overrides:
      setPoints in class TLcdNVG15Polyline
      Parameters:
      aValue - the value to set for the POINTS_PROPERTY property.
    • getEndCapStyle

      public int getEndCapStyle()
      Description copied from interface: ILcdGeoBuffer
      Returns the end cap style of this buffer, which defines the representation of the contour at the endings of the base shape. This is one of ILcdGeoBuffer.CAP_ROUND or ILcdGeoBuffer.CAP_BUTT.
      Specified by:
      getEndCapStyle in interface ILcdGeoBuffer
      Returns:
      the end cap style of the buffer.
    • getJoinStyle

      public int getJoinStyle()
      Description copied from interface: ILcdGeoBuffer
      Returns the join style for the contour of this buffer, which defines the representation of the contour at the joins between two line segments of the base shape. This is always ILcdGeoBuffer.JOIN_ROUND.
      Specified by:
      getJoinStyle in interface ILcdGeoBuffer
      Returns:
      the join style of the buffer.
    • invalidateShape

      public void invalidateShape()
      Description copied from interface: ILcd2DEditableGeoBuffer
      Indicates that the base shape has been changed, and that the buffer should be recalculated.
      Specified by:
      invalidateShape in interface ILcd2DEditableGeoBuffer
    • getEllipsoid

      public ILcdEllipsoid getEllipsoid()
    • setEllipsoid

      public void setEllipsoid(ILcdEllipsoid aEllipsoid)
    • contains2D

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

      public boolean contains2D(double x, double y)
      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 TLcdNVG15Polyline
      Parameters:
      x - the x coordinate of the point.
      y - the y coordinate of the point.
      Returns:
      the boolean result of the containment test.
    • 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 TLcdNVG15Polyline
      Returns:
      the focus point of this ILcdShape.
    • 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 TLcdNVG15Polyline
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
    • 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
      Overrides:
      insertIntoCache in class TLcdNVG15Polyline
      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
      Overrides:
      getCachedObject in class TLcdNVG15Polyline
      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
      Overrides:
      removeCachedObject in class TLcdNVG15Polyline
      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
      Overrides:
      clearCache in class TLcdNVG15Polyline
    • 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
      Overrides:
      move2D in class TLcdNVG15Polyline
      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
      Overrides:
      contains3D in class TLcdNVG15Polyline
      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
      Overrides:
      contains3D in class TLcdNVG15Polyline
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:
    • move2D

      public void move2D(double aX, double aY)
      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
      Overrides:
      move2D in class TLcdNVG15Polyline
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
    • translate2D

      public void translate2D(double aX, double aY)
      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 ILcd2DEditablePointList
      Specified by:
      translate2D in interface ILcd2DEditableShape
      Overrides:
      translate2D in class TLcdNVG15Polyline
      Parameters:
      aX - the x coordinate of the translation vector.
      aY - the y coordinate of the translation vector.
    • getWidthNVG

      public double getWidthNVG()
      Returns the value of the property that maps to the width attribute.

      Width of the corridor (distance)

      Returns:
      the value of the WIDTH_NVG_PROPERTY property.
    • getLegType

      public String getLegType()
      Returns the value of the property that maps to the leg-type attribute.
      Returns:
      the value of the LEG_TYPE_PROPERTY property.
    • getPoints

      public ILcd2DEditablePointList getPoints()
      Returns the value of the property that maps to the points attribute.

      Point list in decimal degrees, coordinate pairs, separated by spaces: lon1,lat1 lon2,lat2 ... lonn,latn

      Returns:
      the value of the POINTS_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.