EnvelopeBuilder

fun EnvelopeBuilder(envelope: Envelope?, block: EnvelopeBuilder.() -> Unit = {})

Creates an envelope builder from a envelope.

fun EnvelopeBuilder(spatialReference: SpatialReference? = null, block: EnvelopeBuilder.() -> Unit = {})

Creates an envelope builder.

fun EnvelopeBuilder(center: Point, width: Double, height: Double, depth: Double? = null, block: EnvelopeBuilder.() -> Unit = {})

Creates an envelope builder from a center point, width, height, depth, and configuration lambda.

center

val center: Point

The center point for the envelope builder. Creates a new Point that must be destroyed.

depth

val depth: Double?

The depth for the envelope builder or null if the builder does not have z-values.

height

val height: Double

The height for the envelope builder. The width for the envelope builder. Returns NAN if an error occurs.

mMax

var mMax: Double

The m maximum value for the envelope. Returns NAN if an error occurs.

mMin

var mMin: Double

The m minimum value for the envelope. Returns NAN if an error occurs.

width

val width: Double

The width for the envelope builder. Returns NAN if an error occurs.

xMax

var xMax: Double

The x maximum value for the envelope. Returns NAN if an error occurs.

xMin

var xMin: Double

The x minimum value for the envelope. Returns NAN if an error occurs.

yMax

var yMax: Double

The y maximum value for the envelope. Returns NAN if an error occurs.

yMin

var yMin: Double

The y minimum value for the envelope. Returns NAN if an error occurs.

zMax

var zMax: Double

The z maximum value for the envelope. Returns NAN if an error occurs.

zMin

var zMin: Double

The z minimum value for the envelope. Returns NAN if an error occurs.

extent

val extent: Envelope

The extent for the geometry in the builder. The extent for the geometry in the builder which is a envelope and contains the same spatial reference as the input geometry.

hasCurves

val hasCurves: Boolean

A value indicating whether the geometry builder currently contains any curve segments. ArcGIS software supports polygon and polyline geometries that contain curve segments (where Segment.isCurve is true, sometimes known as true curves or nonlinear segments). Curves may be present in certain types of data - for example Mobile Map Packages (MMPKs), or geometry JSON.

hasM

val hasM: Boolean

A value indicating if the geometry builder has M. If an error occurs false is returned. M is a vertex value that is stored with the geometry builder.

hasZ

val hasZ: Boolean

A value indicating if the geometry builder has Z. If an error occurs false is returned. Z typically represent elevations or heights.

isEmpty

val isEmpty: Boolean

Check if a geometry builder is empty or not. Only check the geometry builder to see if it is empty. Does not check the spatial reference. Returns true if an error occurs.

isSketchValid

val isSketchValid: Boolean

Check if a geometry builder contains sufficient points to show a valid graphical sketch. This can be used as an initial lightweight check to see if the current state of a builder produces a non-empty geometry; for example, it may be used to enable or disable functionality in an editing user interface. The exact requirements vary depending on the type of geometry produced by the builder:

spatialReference

val spatialReference: SpatialReference?

The spatial reference for the geometry. If the geometry does not have a spatial reference null is returned.

centerAt

fun centerAt(point: Point)

Centers the envelope over the given point.

changeAspectRatio

fun changeAspectRatio(width: Double, height: Double)

Adjust the envelope's aspect ratio to match the ratio of the given width and height. The operation preserves the center of the envelope and only increases either height or width, not both. If the new width would be greater than the old, the width is changed and the height remains the same. If the new width would be less than or equal to the old, the height is changed and the width remains the same.

expand

fun expand(factor: Double)

Expands the envelope by the given scale factor.

fun expand(anchor: Point, factor: Double)

Expands the envelope at the anchor point by the given factor.

offsetBy

fun offsetBy(x: Double, y: Double)

Offsets the envelope by the given offsets for the x and y dimension.

replaceGeometry

open override fun replaceGeometry(geometry: Envelope?)

Replaces the geometry in the builder with the new geometry. This does not update the spatial reference of the builder. If the geometry is null, the builder is cleared.

setM