Class EncEnvironmentSettings.DisplaySettings.MarinerSettings
- Enclosing class:
EncEnvironmentSettings.DisplaySettings
- Since:
- 100.2.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Represents the type of symbols used to display area features.static enum
Represents various color schemes that effect all layers on the map.static final class
Represents settings in the S-52 standard that allow selection of different display categories.static enum
Represents the units used to display soundings and contours.static enum
Represents the type of symbol used to display point features. -
Method Summary
Modifier and TypeMethodDescriptionGets the type of line symbol used to display area features.Gets the color scheme that will effect all layers attached to the map.double
Gets the depth of the deep water contour.Gets theEncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayDepthUnits
used to display soundings and contours.Gets the type of symbol used to display point features.double
Gets the safety contour depth.double
Gets the shallow contour depth.boolean
Gets the visibility of the CATZOC attribute of the M_QUAL object for bathymetric data and the POSACC attribute of the M_ACCY object (if available) for non-bathymetric data.boolean
Gets whether the setting DisplayNOBJNM (display national names when available) is applied.boolean
Gets whether the SCAMIN (Scale Min) S-57 feature attribute is used.boolean
Gets the visibility of isolated dangerous objects location in shallow waters.boolean
Gets whether to display depth and safety contour labels.boolean
Gets whether to display safety contour labels.boolean
Gets whether low accuracy symbols are being used (CATZOC).boolean
Gets whether the shallow depth pattern is symbolized.boolean
Gets whether the number of display shades is 2 or 4.void
Resets all settings to defaults.void
setAreaSymbolizationType
(EncEnvironmentSettings.DisplaySettings.MarinerSettings.AreaSymbolizationType areaSymbolizationType) Sets the type of line symbol used to display area features.void
Sets the type of color scheme that all layers attached to map will use.void
setDeepContour
(double deepContour) Sets the depth of the deep water contour.void
setDisplayDepthUnits
(EncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayDepthUnits displayDepthUnits) Sets the type of display depth units.void
setIsDataQuality
(boolean dataQuality) Sets the visibility of the CATZOC attribute of the M_QUAL object for bathymetric data and the POSACC attribute of the M_ACCY object (if available) for non-bathymetric data.void
setIsDisplayNOBJNM
(boolean displayNOBJNM) Sets whether to apply DisplayNOBJNM (display national names when available) setting.void
setIsHonorSCAMIN
(boolean honorSCAMIN) Sets whether to use the SCAMIN (Scale Min) attribute on features.void
setIsIsolatedDangers
(boolean isolatedDangers) Sets the visibility of isolated dangerous objects location in shallow waters.void
setIsLabelContours
(boolean labelContours) Sets whether to display depth and safety contour labels.void
setIsLabelSafetyContours
(boolean labelSafetyContours) Sets whether to display safety contour labels.void
setIsLowAccuracy
(boolean labelLowAccuracy) Sets whether to use low accuracy symbols.void
setIsShallowDepthPattern
(boolean shallowDepthPattern) Sets whether to symbolize the shallow depth pattern.void
setIsTwoDepthShades
(boolean twoDepthShades) Sets whether to use 2 or 4 display shades.void
setPointSymbolizationType
(EncEnvironmentSettings.DisplaySettings.MarinerSettings.PointSymbolizationType pointSymbolizationType) Sets the type of symbol used to display point features.void
setSafetyContour
(double safetyContour) Sets the safety contour depth.void
setShallowContour
(double shallowContour) Sets the shallow contour depth.
-
Method Details
-
getAreaSymbolizationType
public EncEnvironmentSettings.DisplaySettings.MarinerSettings.AreaSymbolizationType getAreaSymbolizationType()Gets the type of line symbol used to display area features.Defaults to symbolized.
- Returns:
- the type of line symbol used to display area features
- Since:
- 100.2.0
-
setAreaSymbolizationType
public void setAreaSymbolizationType(EncEnvironmentSettings.DisplaySettings.MarinerSettings.AreaSymbolizationType areaSymbolizationType) Sets the type of line symbol used to display area features.- Parameters:
areaSymbolizationType
- the type of line symbol used to display area features- Throws:
IllegalArgumentException
- if areaSymbolizationType is null- Since:
- 100.2.0
-
getColorScheme
Gets the color scheme that will effect all layers attached to the map.Defaults to day.
- Returns:
- the color scheme
- Since:
- 100.2.0
-
setColorScheme
public void setColorScheme(EncEnvironmentSettings.DisplaySettings.MarinerSettings.ColorScheme colorScheme) Sets the type of color scheme that all layers attached to map will use.- Parameters:
colorScheme
- the type of color scheme- Throws:
IllegalArgumentException
- if colorScheme is null- Since:
- 100.2.0
-
isDataQuality
public boolean isDataQuality()Gets the visibility of the CATZOC attribute of the M_QUAL object for bathymetric data and the POSACC attribute of the M_ACCY object (if available) for non-bathymetric data.This is viewing group 31010 per IHO S-52 Annex A.
Defaults to false, meaning quality of data will not be displayed.
- Returns:
- true if the viewing group DataQuality is visible, otherwise false
- Since:
- 100.2.0
-
setIsDataQuality
public void setIsDataQuality(boolean dataQuality) Sets the visibility of the CATZOC attribute of the M_QUAL object for bathymetric data and the POSACC attribute of the M_ACCY object (if available) for non-bathymetric data.- Parameters:
dataQuality
- true if the viewing group DataQuality should be visible, otherwise false- Since:
- 100.2.0
-
getDeepContour
public double getDeepContour()Gets the depth of the deep water contour.When four (rather than two) depth shades are used, this controls the boundary between safe and deep areas.
Defaults to 30 meters.
- Returns:
- the deep water contour, in meters
- Since:
- 100.2.0
-
setDeepContour
public void setDeepContour(double deepContour) Sets the depth of the deep water contour.This value must be greater than or equal to the safety contour value.
- Parameters:
deepContour
- the deep water contour, in meters- Since:
- 100.2.0
-
getDisplayCategories
public EncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayCategories getDisplayCategories()- Returns:
- the display categories
- Since:
- 100.2.0
-
getDisplayDepthUnits
public EncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayDepthUnits getDisplayDepthUnits()Gets theEncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayDepthUnits
used to display soundings and contours.The default value is
EncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayDepthUnits.METERS
.- Returns:
- the type of depth units used to display soundings and contours
- Since:
- 100.2.0
-
setDisplayDepthUnits
public void setDisplayDepthUnits(EncEnvironmentSettings.DisplaySettings.MarinerSettings.DisplayDepthUnits displayDepthUnits) Sets the type of display depth units.- Parameters:
displayDepthUnits
- the type of display depth units- Throws:
IllegalArgumentException
- if depthUnits is null- Since:
- 100.2.0
-
isDisplayNOBJNM
public boolean isDisplayNOBJNM()Gets whether the setting DisplayNOBJNM (display national names when available) is applied.This is text group 31 per IHO S-52 Annex A.
Defaults to true, meaning national names will be displayed.
- Returns:
- true if the DisplayNOBJNM setting is applied, otherwise false
- Since:
- 100.2.0
-
setIsDisplayNOBJNM
public void setIsDisplayNOBJNM(boolean displayNOBJNM) Sets whether to apply DisplayNOBJNM (display national names when available) setting.This is text group 31 per IHO S-52 Annex A.
- Parameters:
displayNOBJNM
- true if the setting DisplayNOBJNM should be applied, otherwise false- Since:
- 100.2.0
-
isHonorSCAMIN
public boolean isHonorSCAMIN()Gets whether the SCAMIN (Scale Min) S-57 feature attribute is used.If false, all ENC features will be rendered regardless of scale.
Defaults to true, meaning the scale min attribute will be respected.
- Returns:
- true if the SCAMIN (Scale Min) feature attribute is used, otherwise false
- Since:
- 100.2.0
-
setIsHonorSCAMIN
public void setIsHonorSCAMIN(boolean honorSCAMIN) Sets whether to use the SCAMIN (Scale Min) attribute on features.- Parameters:
honorSCAMIN
- true if the SCAMIN (Scale Min) attribute should be used, otherwise false- Since:
- 100.2.0
-
isIsolatedDangers
public boolean isIsolatedDangers()Gets the visibility of isolated dangerous objects location in shallow waters.This is viewing group 24020, 24050 per IHO 2-52 Annex A.
Defaults to false, meaning isolated dangers will not be shown.
- Returns:
- true if isolated dangerous objects in unsafe waters are displayed, otherwise false
- Since:
- 100.2.0
-
setIsIsolatedDangers
public void setIsIsolatedDangers(boolean isolatedDangers) Sets the visibility of isolated dangerous objects location in shallow waters.This is viewing group 24020, 24050 per IHO 2-52 Annex A.
- Parameters:
isolatedDangers
- true to display isolated dangers in unsafe waters, otherwise false- Since:
- 100.2.0
-
isLabelContours
public boolean isLabelContours()Gets whether to display depth and safety contour labels.This is viewing group 33021, 33022 per IHO S-52 Annex A.
Defaults to true, meaning the depth contour labels will be displayed.
- Returns:
- true if the contour labels are displayed, otherwise false
- Since:
- 100.2.0
-
setIsLabelContours
public void setIsLabelContours(boolean labelContours) Sets whether to display depth and safety contour labels.This is viewing group 33021, 33022 per IHO S-52 Annex A.
- Parameters:
labelContours
- true if the contour labels should be displayed, otherwise false- Since:
- 100.2.0
-
isLabelSafetyContours
public boolean isLabelSafetyContours()Gets whether to display safety contour labels.This is viewing group 33021, 33022 per IHO S-52 Annex A.
Defaults to true, meaning safety labels will be displayed.
- Returns:
- true if the safety contour labels are displayed, otherwise false
- Since:
- 100.2.0
-
setIsLabelSafetyContours
public void setIsLabelSafetyContours(boolean labelSafetyContours) Sets whether to display safety contour labels.This is viewing group 33021, 33022 per IHO S-52 Annex A.
- Parameters:
labelSafetyContours
- true if the safety contour labels should be displayed, otherwise false- Since:
- 100.2.0
-
isLowAccuracy
public boolean isLowAccuracy()Gets whether low accuracy symbols are being used (CATZOC).This is viewing group 31010 per IHO S-52 Annex A.
If false, low accuracy data will be visually indistinguishable from other data.
Defaults to true, meaning vectors marked as 'low accuracy data' will be symbolized differently.
- Returns:
- true if low accuracy symbols are being used, otherwise false
- Since:
- 100.2.0
-
setIsLowAccuracy
public void setIsLowAccuracy(boolean labelLowAccuracy) Sets whether to use low accuracy symbols.This is viewing group 31010 per IHO S-52 Annex A.
- Parameters:
labelLowAccuracy
- true if the low accuracy symbols should be used, otherwise false- Since:
- 100.2.0
-
getPointSymbolizationType
public EncEnvironmentSettings.DisplaySettings.MarinerSettings.PointSymbolizationType getPointSymbolizationType()Gets the type of symbol used to display point features.Paperchart symbolization is based on traditional paper charts. Simplified symbols are more compact and visible.
Defaults to paperchart.
- Returns:
- the type of symbol used to display point features
- Since:
- 100.2.0
-
setPointSymbolizationType
public void setPointSymbolizationType(EncEnvironmentSettings.DisplaySettings.MarinerSettings.PointSymbolizationType pointSymbolizationType) Sets the type of symbol used to display point features.- Parameters:
pointSymbolizationType
- the type of symbol used to display point features- Throws:
IllegalArgumentException
- if pointSymbolizationType is null- Since:
- 100.2.0
-
getSafetyContour
public double getSafetyContour()Gets the safety contour depth.The safety contour separates safe from unsafe areas.
Defaults to 30 meters.
- Returns:
- the safety contour depth, in meters
- Since:
- 100.2.0
-
setSafetyContour
public void setSafetyContour(double safetyContour) Sets the safety contour depth.- Parameters:
safetyContour
- the safety contour depth, in meters- Since:
- 100.2.0
-
getShallowContour
public double getShallowContour()Gets the shallow contour depth.When 4 (rather than 2) depth shades are used, this value controls the separation between shallow and unsafe areas.
Defaults to 2 meters.
- Returns:
- the shallow contour depth, in meters
- Since:
- 100.2.0
-
setShallowContour
public void setShallowContour(double shallowContour) Sets the shallow contour depth.This value must be less than or equal to the safety contour value.
- Parameters:
shallowContour
- the shallow contour depth, in meters- Since:
- 100.2.0
-
isShallowDepthPattern
public boolean isShallowDepthPattern()Gets whether the shallow depth pattern is symbolized.Defaults to false, meaning the shallow depth pattern will not be symbolized.
- Returns:
- true if the shallow depth pattern is symbolized, otherwise false
- Since:
- 100.2.0
-
setIsShallowDepthPattern
public void setIsShallowDepthPattern(boolean shallowDepthPattern) Sets whether to symbolize the shallow depth pattern.- Parameters:
shallowDepthPattern
- true to symbolize the shallow depth pattern, otherwise false- Since:
- 100.2.0
-
isTwoDepthShades
public boolean isTwoDepthShades()Gets whether the number of display shades is 2 or 4.Defaults to true, meaning 2 depth shades will be used.
- Returns:
- true if the number of display shades is 2, false if the number of display shades is 4
- Since:
- 100.2.0
-
setIsTwoDepthShades
public void setIsTwoDepthShades(boolean twoDepthShades) Sets whether to use 2 or 4 display shades.- Parameters:
twoDepthShades
- true to use 2 display shades, false to use 4 display shades- Since:
- 100.2.0
-
resetToDefaults
public void resetToDefaults()Resets all settings to defaults.- Since:
- 100.2.0
-