Polygon

open class Polygon @JvmOverloads constructor(positions: List<Position> = emptyList(), attributes: ShapeAttributes = ShapeAttributes()) : AbstractShape

Constructors

Link copied to clipboard
constructor(positions: List<Position> = emptyList(), attributes: ShapeAttributes = ShapeAttributes())

Types

Link copied to clipboard
object Companion
Link copied to clipboard
open class PolygonData

Properties

Link copied to clipboard
open override var altitudeMode: AltitudeMode

AltitudeMode used by movable object

Link copied to clipboard
open override var attributes: ShapeAttributes

Indicates the shape's normal (non-highlight) attributes.

Link copied to clipboard

Base altitude level of shape sides. Is dependent on altitudeMode. Ground level by default.

Link copied to clipboard
Link copied to clipboard
open override var displayName: String?
Link copied to clipboard

Indicates the shape's highlight attributes.

Link copied to clipboard

Determines whether surface shape should be batched to terrain textures cache or single color attachment. Set this flag to true when shape editing is intended and to false when editing is finished.

Link copied to clipboard
open override var isEnabled: Boolean
Link copied to clipboard

Draw sides of the shape which extend from the defined position and altitude to baseAltitude level.

Link copied to clipboard

Determines whether this shape's geometry follows the terrain surface or is fixed at a constant altitude.

Link copied to clipboard
open override var isHighlighted: Boolean

Indicates whether the shape is highlighted.

Link copied to clipboard
open override var isPickEnabled: Boolean
Link copied to clipboard

Opt in to flat geometry under AltitudeMode.RELATIVE_TO_GROUND: vertex altitudes anchor to a single terrain sample at the polygon's reference position. Default false keeps per-vertex draping (KML 2.x semantics). Set true for a fixed-AGL surface or a floating extruded slab (non-zero baseAltitude without a ground-anchored foundation); on extruded shapes it flattens the skirt too.

Link copied to clipboard

true when this shape's referencePosition coincides with where the user actually sees the shape (Placemark, Label, sightlines — the reference is the rendered location). false for shapes whose reference is computed from extended geometry and may sit far from where the user grabbed (Polygon centroid, Path centroid, Mesh).

Link copied to clipboard

Optional lambda to control current shape visibility based on its attributes and frame render context

Link copied to clipboard

Maximum number of intermediate edge intervals across a half-equator (PI radians) of arc. Per-edge subdivision count is scaled by edge length: steps = round(maximumNumEdgeIntervals * distanceRadians / PI), then further adjusted by polarThrottle near the poles for surface shapes. 3D shapes use the unthrottled count. A value of 0 disables intermediate vertex generation.

Link copied to clipboard
Link copied to clipboard
open override var pickDelegate: Any?
Link copied to clipboard

Pole-throttle factor: higher values shrink the subdivision step near ±90° latitude so the straight 2D lon/lat segments between samples more closely follow the true great-circle path. A value of 0 disables throttling (uniform step).

Link copied to clipboard
open override val referencePosition: Position

A position associated with the object that indicates its aggregate geographic position. The chosen position varies among implementers of this interface. For objects defined by a list of positions, the reference position is typically the first position in the list. For symmetric objects the reference position is often the center of the object. In many cases the object's reference position may be explicitly specified by the application.

Link copied to clipboard
open override var zOrder: Double

Functions

Link copied to clipboard
fun addBoundary(positions: List<Position>): Boolean
fun addBoundary(index: Int, positions: List<Position>)
Link copied to clipboard
fun AbstractShape.applyFeatureStyle(properties: LinkedHashMap<String, Any?>, defaultLineColor: Color? = null, defaultFillColor: Color? = null)

Apply simplestyle stroke / fill / stroke-width to a Path or Polygon's attributes. Writes outline / interior color only when there's an explicit value to apply — either the feature's stroke / fill property OR a non-null defaultLineColor / defaultFillColor. With both null (the default), an absent property leaves the renderable's existing color alone — important when the layer's shapeAttributes supplied an intentional template colour at construction time (e.g. Shapefile's translucent blue) that would otherwise be clobbered by auto-style.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun <T> getUserProperty(key: Any): T?
Link copied to clipboard
open override fun hasUserProperty(key: Any): Boolean
Link copied to clipboard
open override fun moveTo(globe: Globe, position: Position)

Move the shape over the globe's surface while maintaining its original azimuth, its orientation relative to North.

Link copied to clipboard
open override fun putUserProperty(key: Any, value: Any): Any?
Link copied to clipboard
Link copied to clipboard
open override fun removeUserProperty(key: Any): Any?
Link copied to clipboard
open override fun render(rc: RenderContext)
Link copied to clipboard
open override fun reset()
Link copied to clipboard
fun setBoundary(index: Int, positions: List<Position>): List<Position>