Get Started Contact sales

GoogleMaps3D Framework Reference

Polygon

struct Polygon
 
extension Polygon : Copyable, Equatable, Escapable, Hashable, Identifiable, MapContent

A 3D polygon that can be placed on a map.

Map(mode: .hybrid) {
  Polygon(
    outerCoordinates: [
      .init(latitude: 37.7749, longitude: -122.4194, altitude: 0),
      .init(latitude: 37.7740, longitude: -122.4184, altitude: 0),
      .init(latitude: 37.7750, longitude: -122.4174, altitude: 0),
    ]
  )
}

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (a: Polygon, b: Polygon) -> Bool

  • ID

    A type representing the stable identity of the entity associated with an instance.

    Declaration

    Swift

    @available(watchOS, introduced: 6.0)
@available(macOS, introduced: 10.15)
@available(iOS, introduced: 13.0)
@available(tvOS, introduced: 13.0)
typealias ID = String

  • Declaration

    Swift

    struct StyleOptions
     
    extension Polygon.StyleOptions : Equatable, Hashable

  • Declaration

    Swift

    func add(coordinator: RenderingCoordinator)

  • Specifies how altitudes in the coordinates are interpreted. Default value: clampToGround.

    Declaration

    Swift

    let altitudeMode: AltitudeMode

  • The draw order compared to other polys. Default value: 0.

    Declaration

    Swift

    let drawOrder: Int32

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • The hash value.

    Hash values are not guaranteed to be equal across different executions of your program. Do not save hash values to use during a future execution.

    Important

    hashValue is deprecated as a Hashable requirement. To conform to Hashable, implement the hash(into:) requirement instead. The compiler provides an implementation for hashValue for you.

    Declaration

    Swift

    var hashValue: Int { get }

  • id

    The id used to store the polygon as KML feature in the KML document. It’s created and used only internally.

    Declaration

    Swift

    let id: String

  • Declaration

    Swift

    init(outerCoordinates: [LatLngAltitude], innerCoordinates: [[LatLngAltitude]] = [], altitudeMode: AltitudeMode = .clampToGround, drawOrder: Int32 = 0)

  • Inner boundary of the polygon. A Polygon can contain multiple inner coordinates, which create multiple cut-outs inside the polygon.

    Declaration

    Swift

    let innerCoordinates: [[LatLngAltitude]]

  • Outer boundary of the polygon.

    Declaration

    Swift

    let outerCoordinates: [LatLngAltitude]

  • Declaration

    Swift

    func remove(coordinator: RenderingCoordinator)

  • Declaration

    Swift

    func style(_ style: Polygon.StyleOptions) -> Polygon

  • Style options of the polygon.

    Declaration

    Swift

    var styleOptions: Polygon.StyleOptions

  • Declaration

    Swift

    func update(coordinator: RenderingCoordinator)