map_polygon.proto

// Copyright 2020-2024 SIX AFTER, INC (SIX AFTER)
//
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: SIX AFTER, INC (SIX AFTER)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax="proto3";

package sixafter.types;

option go_package="github.com/sixafter/types;types";
option cc_enable_arenas = true;
option java_package = "com.sixafter.types";
option java_multiple_files = true;
option java_outer_classname = "MapPolygonProto";
option objc_class_prefix = "TPB";
option csharp_namespace = "SixAfter.Types.WellKnownTypes";

import "map_point.proto";

// The `MapPolygonPolygon` message represents a closed geometric shape on a map.
// The shape is defined by a series of points that are connected end-to-end,
// with the first and last points also connected to form a closed shape.
// This structure is commonly used in mapping applications, GIS, and geofencing.
message MapPolygon {

  // The set of points that define the polygon.
  // Each point is represented by a `MapPoint` message, which specifies the
  // location on the map. The points should be provided in the order they are
  // connected.
  //
  // Example: A triangle may have three points:
  // - Point 1: `x=0, y=0`
  // - Point 2: `x=10, y=0`
  // - Point 3: `x=5, y=5`
  // The first point is automatically connected to the last point to close the shape.
  repeated MapPoint points = 1;
}