Enum Class NavigationConstraint

java.lang.Object
java.lang.Enum<NavigationConstraint>
com.esri.arcgisruntime.mapping.NavigationConstraint
All Implemented Interfaces:
Serializable, Comparable<NavigationConstraint>, Constable

public enum NavigationConstraint extends Enum<NavigationConstraint>
The options for constraining navigation based on the surface elevation.

Used to constrain all forms of camera navigation to the elevation surface.

Since:
100.5.0
  • Enum Constant Details

    • NONE

      public static final NavigationConstraint NONE
      Camera navigation is unconstrained. In this mode the camera may pass above and below the elevation surface.
      Since:
      100.5.0
    • STAY_ABOVE

      public static final NavigationConstraint STAY_ABOVE
      Camera navigation is constrained to remaining above the elevation surface. The altitude of the camera may not fall below the elevation of the surface. If the elevation is added or updates resulting in the camera altitude being below the surface the camera will be pushed up to be at the surface.
      Since:
      100.5.0
  • Method Details

    • values

      public static NavigationConstraint[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static NavigationConstraint valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null