Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.mapping.view.geometryeditor

Enum Class ShapeToolType

java.lang.Object

java.lang.Enum<ShapeToolType>

com.esri.arcgisruntime.mapping.view.geometryeditor.ShapeToolType

All Implemented Interfaces:

Serializable, Comparable<ShapeToolType>, Constable

public enum ShapeToolType
extends Enum<ShapeToolType>

The shapes that can be created by using a ShapeTool with a GeometryEditor.

Since:

200.2.0

See Also:

• ShapeTool.create(ShapeToolType)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARROW	Allows you to drag on a map view to define the corners of a bounding box within which an arrow-shaped geometry fits.
ELLIPSE	Allows you to drag on a map view to define the center point and a point on the circumference of an ellipse-shaped geometry.
RECTANGLE	Allows you to drag on a map view to define the corners of a bounding box within which a rectangle-shaped geometry fits.
TRIANGLE	Allows you to drag on a map view to define the center point and a corner of a triangle-shaped geometry.

Method Summary

Modifier and Type	Method	Description
static ShapeToolType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ShapeToolType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARROW

public static final ShapeToolType ARROW

Allows you to drag on a map view to define the corners of a bounding box within which an arrow-shaped geometry fits.

The created arrow shape is aligned along the horizontal axis, pointing in the direction of the drag. To create arrows pointing in other directions, ensure InteractionConfiguration.allowRotatingSelectedElementProperty() and InteractionConfiguration.allowPartSelectionProperty() are true to allow interactive selection and rotation to the desired direction.

Since:

200.2.0

ELLIPSE

public static final ShapeToolType ELLIPSE

Allows you to drag on a map view to define the center point and a point on the circumference of an ellipse-shaped geometry.

To create a circular shape, use this value in combination with a ShapeTool.configurationProperty() InteractionConfiguration.scaleModeProperty() value of GeometryEditorScaleMode.UNIFORM. Geometries created using this type are not represented by true curves but rather consist of a series of straight lines (Geometry.hasCurves() is false).

Since:

200.2.0

RECTANGLE

public static final ShapeToolType RECTANGLE

Allows you to drag on a map view to define the corners of a bounding box within which a rectangle-shaped geometry fits.

To create a square shape, use this value in combination with a ShapeTool.configurationProperty() InteractionConfiguration.scaleModeProperty() value of GeometryEditorScaleMode.UNIFORM. Geometries created using this type are either polygons or polylines, depending on the parameter passed to GeometryEditor.start(GeometryType) - it cannot create an Envelope geometry.

Since:

200.2.0

TRIANGLE

public static final ShapeToolType TRIANGLE

Allows you to drag on a map view to define the center point and a corner of a triangle-shaped geometry.

The created triangle shape is aligned along the vertical axis, pointing opposite to the direction of the drag. To create triangles pointing in other directions, ensure InteractionConfiguration.allowRotatingSelectedElementProperty() and InteractionConfiguration.allowPartSelectionProperty() are true to allow interactive selection and rotation to the desired direction.

To create an equilateral triangle, use this value in combination with a ShapeTool.configurationProperty() InteractionConfiguration.scaleModeProperty() value of GeometryEditorScaleMode.UNIFORM.

Since:

200.2.0

Method Details

values

public static ShapeToolType[] 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 ShapeToolType 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