Package com.esri.arcgisruntime.mapping
Enum NavigationConstraint
- java.lang.Object
-
- java.lang.Enum<NavigationConstraint>
-
- com.esri.arcgisruntime.mapping.NavigationConstraint
-
- All Implemented Interfaces:
Serializable
,Comparable<NavigationConstraint>
public enum NavigationConstraint extends Enum<NavigationConstraint>
The options for constraining navigation based on the surface elevation.- Since:
- 100.5.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description NONE
Camera navigation is unconstrained.STAY_ABOVE
Camera navigation is constrained to remaining above the elevation surface.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static NavigationConstraint
valueOf(String name)
Returns the enum constant of this type with the specified name.static NavigationConstraint[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static NavigationConstraint[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (NavigationConstraint c : NavigationConstraint.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NavigationConstraint valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
-