Module org.arakhne.afc.gis.gisroad
Package org.arakhne.afc.gis.road.layer

Class RoadNetworkLayerConstants

  • public final class RoadNetworkLayerConstants
extends Object
    Constants for the road network layer API.
    Since:
    14.0
    Version:
    17.0 2020-01-04 14:41:55
    Author:
    Stéphane GALLAND
    Maven Group Id:
    org.arakhne.afc.gis
    Maven Artifact Id:
    gisroad

    • Field Detail

      • DEFAULT_ROAD_COLORS

        public static final int[] DEFAULT_ROAD_COLORS
        Defaults colors for the different types of roads. The array contains pairs of colors: one for the inner part, and one for the borders.

      • DEFAULT_ROAD_INTERN_DRAWING

        public static final boolean DEFAULT_ROAD_INTERN_DRAWING
        Default flag indicating if the internal data structures of the road networks may be drawn on the displayers.
        See Also:
        Constant Field Values

      • DEFAULT_ROAD_INTERN_COLOR

        public static final int DEFAULT_ROAD_INTERN_COLOR
        Color of the internal data structures of the road networks when they are drawn on the displayers.
        See Also:
        Constant Field Values

      • DEFAULT_BORDER_SIZE

        public static final int DEFAULT_BORDER_SIZE
        Default size of the road borders (in pixels).
        See Also:
        Constant Field Values

    • Method Detail

      • getPreferences

        @Pure
public static Preferences getPreferences()
        Replies the preferences for the road network layer.
        Returns:
        the preferences.

      • getPreferredRoadBorderSize

        @Pure
public static int getPreferredRoadBorderSize()
        Replies the preferred size of the roazd borders (in pixels).
        Returns:
        size of the road borders.

      • getPreferredRoadBorderSize

        @Pure
public static Integer getPreferredRoadBorderSize​(boolean useSystemValue)
        Replies the preferred size of the roazd borders (in pixels).
        Parameters:
        useSystemValue - indicates if the null value must be replaced by the default system value: DEFAULT_BORDER_SIZE.
        Returns:
        size of the road borders.

      • setPreferredRoadBorderSize

        public static void setPreferredRoadBorderSize​(Integer size)
        Set the preferred size of the roazd borders (in pixels).
        Parameters:
        size - is the preferred size of the roazd borders (in pixels).

      • getPreferredRoadColor

        @Pure
public static int getPreferredRoadColor​(RoadType roadType)
        Replies the preferred color to draw the content of the roads of the given type.
        Parameters:
        roadType - is the type of road for which the color should be replied.
        Returns:
        the color of the inner parts of the roads.

      • getPreferredRoadColor

        @Pure
public static int getPreferredRoadColor​(RoadType roadType,
                                        boolean useSystemValue)
        Replies the preferred color to draw the content of the roads of the given type.
        Parameters:
        roadType - is the type of road for which the color should be replied.
        useSystemValue - indicates if the null value must be replaced by the default system value in DEFAULT_ROAD_COLORS (if true).
        Returns:
        the color of the inner parts of the roads.

      • setPreferredRoadColor

        public static void setPreferredRoadColor​(RoadType roadType,
                                         Integer color)
        Set the preferred color to draw the content of the roads of the given type.
        Parameters:
        roadType - is the type of road for which the color should be replied.
        color - is the color or null to restore the default value.

      • getPreferredBorderColor

        @Pure
public static int getPreferredBorderColor​(RoadType roadType)
        Replies the preferred color to draw the borders of the roads of the given type.
        Parameters:
        roadType - is the type of road for which the color should be replied.
        Returns:
        the color of the inner parts of the roads.

      • getPreferredBorderColor

        @Pure
public static int getPreferredBorderColor​(RoadType roadType,
                                          boolean useSystemValue)
        Replies the preferred color to draw the borders of the roads of the given type.
        Parameters:
        roadType - is the type of road for which the color should be replied.
        useSystemValue - indicates if the null value must be replaced by the default system value in DEFAULT_ROAD_COLORS (if true).
        Returns:
        the color of the inner parts of the roads.

      • setPreferredBorderColor

        public static void setPreferredBorderColor​(RoadType roadType,
                                           Integer color)
        Set the preferred color to draw the borders of the roads of the given type.
        Parameters:
        roadType - is the type of road for which the color should be replied.
        color - is the color or null to restore the default value.

      • getPreferredRoadInternDrawing

        @Pure
public static boolean getPreferredRoadInternDrawing()
        Replies if the internal data structure used to store the road network may be drawn on the displayers.
        Returns:
        true if the internal data structures may be drawn on the displayers, otherwise false.

      • setPreferredRoadInternDrawing

        public static void setPreferredRoadInternDrawing​(Boolean draw)
        Set if the internal data structure used to store the road network may be drawn on the displayers.
        Parameters:
        draw - is true if the internal data structures may be drawn on the displayers, false if the internal data structures may not be drawn on the displayers, null to restore the default value given by DEFAULT_ROAD_INTERN_DRAWING.

      • getPreferredRoadInternColor

        @Pure
public static int getPreferredRoadInternColor()
        Replies the color of the internal data structures used when they are drawn on the displayers.
        Returns:
        the color of the internal data structures, never null.

      • setPreferredRoadInternColor

        public static void setPreferredRoadInternColor​(Integer color)
        Set the color of the internal data structures used when they are drawn on the displayers.
        Parameters:
        color - is the color of the internal data structures, never null.