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

Class TLcdNVG15Text

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.nvg.nvg15.model.TLcdNVG15Base
com.luciad.format.nvg.nvg15.model.TLcdNVG15Text
All Implemented Interfaces:
ILcdDataObject, ILcdNVGNode, ILcdBounded, ILcdPoint, ILcdShape, ILcd2DEditablePoint, ILcd2DEditableShape, ILcdCache, ILcdCloneable, ILcdDeepCloneable, ILcdOrientationSettable, ILcdOriented, Serializable, Cloneable
public class TLcdNVG15Text extends TLcdNVG15Base implements ILcd2DEditablePoint, ILcdOrientationSettable, ILcdCache
Represents textual information at a certain location.
Since:
2015.0
See Also:

  • Field Details

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

    • X_PROPERTY

      public static final TLcdDataProperty X_PROPERTY
      Data property that maps to the x 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 y attribute. The possible values for this property are instances of double.

    • TEXT_STRING_PROPERTY

      public static final TLcdDataProperty TEXT_STRING_PROPERTY
      Data property that maps to the content element. The possible values for this property are instances of String.

    • 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

    • TLcdNVG15Text

      public TLcdNVG15Text()

    • TLcdNVG15Text

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

  • Method Details

    • clone

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

    • getZ

      public double getZ()
      Returns the z coordinate of this ILcdPoint.
      Specified by:
      getZ in interface ILcdPoint
      Returns:
      the z coordinate of this ILcdPoint.

    • getCosX

      public double getCosX()
      Returns cos( getX() * DEG2RAD ).
      Specified by:
      getCosX in interface ILcdPoint
      Returns:
      cos( getX() * DEG2RAD ).

    • getCosY

      public double getCosY()
      Returns cos( getY() * DEG2RAD ).
      Specified by:
      getCosY in interface ILcdPoint
      Returns:
      cos( getY() * DEG2RAD ).

    • getSinX

      public double getSinX()
      Returns sin( getX() * DEG2RAD ).
      Specified by:
      getSinX in interface ILcdPoint
      Returns:
      sin( getX() * DEG2RAD ).

    • getSinY

      public double getSinY()
      Returns sin( getY() * DEG2RAD ).
      Specified by:
      getSinY in interface ILcdPoint
      Returns:
      sin( getY() * DEG2RAD ).

    • getTanX

      public double getTanX()
      Returns tan( getX() * DEG2RAD ).
      Specified by:
      getTanX in interface ILcdPoint
      Returns:
      tan( getX() * DEG2RAD ).

    • getTanY

      public double getTanY()
      Returns tan( getY() * DEG2RAD ).
      Specified by:
      getTanY in interface ILcdPoint
      Returns:
      tan( getY() * DEG2RAD ).

    • cloneAs2DEditablePoint

      public ILcd2DEditablePoint cloneAs2DEditablePoint()
      Returns a copy of this ILcdPoint that is also an ILcd2DEditablePoint. This makes sure that the first two dimensions of the copy are writable,
      Specified by:
      cloneAs2DEditablePoint in interface ILcdPoint
      Returns:
      a copy of this ILcdPoint that is also an ILcd2DEditablePoint. This makes sure that the first two dimensions of the copy are writable, even if the original ILcdPoint object may be read-only.
      See Also:

    • cloneAs3DEditablePoint

      public ILcd3DEditablePoint cloneAs3DEditablePoint()
      Returns a copy of this ILcdPoint that is also an ILcd3DEditablePoint. This makes sure that all three dimensions of the copy are writable,
      Specified by:
      cloneAs3DEditablePoint in interface ILcdPoint
      Returns:
      a copy of this ILcdPoint that is also an ILcd3DEditablePoint. This makes sure that all three dimensions of the copy are writable, even if the original ILcdPoint object may be read-only.
      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.

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

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

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

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

    • 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(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:

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

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

    • getOrientation

      public double getOrientation()
      Description copied from interface: ILcdOriented
      Returns the orientation of this object in degrees. The orientation should be interpreted as a clockwise angle in degrees starting from 12 o'clock.

      If there is no rotation known for this object, return Double.NaN.

      Specified by:
      getOrientation in interface ILcdOriented
      Returns:
      the orientation of this object in degrees, or NaN if undefined.

    • setOrientation

      public void setOrientation(double aOrientation)
      Description copied from interface: ILcdOrientationSettable
      Sets the orientation on this object.
      Specified by:
      setOrientation in interface ILcdOrientationSettable
      Parameters:
      aOrientation - the orientation specified in degrees with 0 located at 12 o'clock and increasing clockwise.
      See Also:

    • setValue

      public void setValue(TLcdDataProperty aProperty, Object aValue)
      Description copied from interface: ILcdDataObject

      Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.

      The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.

      Specified by:
      setValue in interface ILcdDataObject
      Overrides:
      setValue in class TLcdDataObject
      Parameters:
      aProperty - the property for which the value is to be set
      aValue - the value to set
      See Also:

    • getRotAngle

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

    • setRotAngle

      public void setRotAngle(double aValue)
      Sets the value of the property that maps to the rotation attribute.
      Parameters:
      aValue - the value to set for the ROT_ANGLE_PROPERTY property.

    • getX

      public double getX()
      Returns the value of the property that maps to the x attribute.
      Returns:
      the value of the X_PROPERTY property.

    • setX

      public void setX(double aValue)
      Sets the value of the property that maps to the x attribute.
      Parameters:
      aValue - the value to set for the X_PROPERTY property.

    • getY

      public double getY()
      Returns the value of the property that maps to the y attribute.
      Returns:
      the value of the Y_PROPERTY property.

    • setY

      public void setY(double aValue)
      Sets the value of the property that maps to the y attribute.
      Parameters:
      aValue - the value to set for the Y_PROPERTY property.

    • getTextString

      public String getTextString()
      Returns the value of the property that maps to the content element.
      Returns:
      the value of the TEXT_STRING_PROPERTY property.

    • setTextString

      public void setTextString(String aValue)
      Sets the value of the property that maps to the content element.
      Parameters:
      aValue - the value to set for the TEXT_STRING_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.