Package com.luciad.format.s52

Interface ILcdDepthDisplaySettings

All Known Implementing Classes:
TLcdS101DisplaySettings, TLcdS52DisplaySettings
public interface ILcdDepthDisplaySettings
Configuration object containing all display settings concerning water depth, as available in the ECDIS rendering library.
Since:
2026.0

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getDeepContour()
    Returns the depth of the deep contour.
    double
    getSafetyContour()
    Returns the depth of the safety contour.
    double
    getSafetyDepth()
    Returns the ship's safety depth.
    double
    getShallowContour()
    Returns the depth of the shallow contour.
    boolean
    isUseTwoShades()
    Returns whether to use a 2- or 4-color schema for depth area rendering.
    void
    setDeepContour(double aDeepContour)
    Sets the depth of the deep contour.
    void
    setSafetyContour(double aSafetyContour)
    Sets the ship's safety contour depth.
    void
    setSafetyDepth(double aSafetyDepth)
    Sets the ship's safety depth.
    void
    setShallowContour(double aShallowContour)
    Sets the depth of the shallow contour.
    void
    setUseTwoShades(boolean aUseTwoShades)
    Sets whether to use a 2- or 4-color schema for depth area rendering.

  • Method Details

    • getSafetyDepth

      double getSafetyDepth()
      Returns the ship's safety depth.
      Returns:
      the ship's safety depth.
      See Also:

    • setSafetyDepth

      void setSafetyDepth(double aSafetyDepth)
      Sets the ship's safety depth. The safety depth affects the way depth soundings are rendered: depth soundings with a value less than the safety depth will be rendered in a dark color, while depth sounding with a value more than the safety depth will be rendered in a light color.

      The safety contour depth and safety depth are independent settings; the former affects the safety contour line and the depth area fill colors, the latter affects the depth soundings colors.

      Parameters:
      aSafetyDepth - the ship's safety depth.
      See Also:

    • getShallowContour

      double getShallowContour()
      Returns the depth of the shallow contour.

      The shallow contour is only relevant if the two shades setting is turned off.

      Returns:
      the shallow contour depth.
      See Also:

    • setShallowContour

      void setShallowContour(double aShallowContour)
      Sets the depth of the shallow contour. Areas with a depth less than the shallow contour depth will be rendered in a darker color than areas with a depth more than the shallow contour depth.

      The shallow contour is only relevant if the two shades setting is turned off.

      Parameters:
      aShallowContour - the shallow contour depth.
      See Also:

    • getSafetyContour

      double getSafetyContour()
      Returns the depth of the safety contour.
      Returns:
      the depth of the safety contour.
      See Also:

    • setSafetyContour

      void setSafetyContour(double aSafetyContour)
      Sets the ship's safety contour depth. The safety contour is a bold line indicating the boundaries of the area in which the ship can safely navigate. All areas with a depth less than the safety contour depth (on one side of the safety contour) will be rendered with a darker color than the areas with a depth more than the safety contour depth (on the other side of the safety contour).

      The safety contour depth and safety depth are independent settings; the former affects the safety contour line and the depth area fill colors, the latter affects the depth soundings colors.

      Parameters:
      aSafetyContour - the ship's safety contour depth.
      See Also:

    • getDeepContour

      double getDeepContour()
      Returns the depth of the deep contour.
      Returns:
      the deep contour depth.
      See Also:

    • setDeepContour

      void setDeepContour(double aDeepContour)
      Sets the depth of the deep contour. Areas with a depth less than the deep contour depth will be rendered in a darker color than areas with a depth more than the deep contour depth.

      The deep contour is only relevant if the two shades setting is turned off.

      Parameters:
      aDeepContour - the deep contour depth.
      See Also:

    • isUseTwoShades

      boolean isUseTwoShades()
      Returns whether to use a 2- or 4-color schema for depth area rendering.
      Returns:
      whether to use a 2- or 4-color schema for depth area rendering.
      See Also:

    • setUseTwoShades

      void setUseTwoShades(boolean aUseTwoShades)
      Sets whether to use a 2- or 4-color schema for depth area rendering. If true, only 2 colors will be used (darker for depths less than the safety contour, lighter for depths more than the safety contour), if false, 4 colors will be used (the shallow and deep contour depth will also be taken into account).
      Parameters:
      aUseTwoShades - boolean indicating whether to use a 2- or 4-color schema for depth area rendering.
      See Also: