Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping
Enum Class NavigationConstraint
- All Implemented Interfaces:
Serializable
,Comparable<NavigationConstraint>
,Constable
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
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionCamera navigation is unconstrained.Camera navigation is constrained to remaining above the elevation surface. -
Method Summary
Modifier and TypeMethodDescriptionstatic NavigationConstraint
Returns the enum constant of this class with the specified name.static NavigationConstraint[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
Camera navigation is unconstrained. In this mode the camera may pass above and below the elevation surface.- Since:
- 100.5.0
-
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
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
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 nameNullPointerException
- if the argument is null
-