Package provided.owlMaps.components.shapes

Interface IPolyMouseEvent

All Superinterfaces:
IMouseEvent
public interface IPolyMouseEvent
extends IMouseEvent
An extension of IMouseEvent that adds parameters applicable to events occurring on IPolygons or IPolylines.
Author:
swong

  • Method Summary

    Modifier and Type Method Description
    int getEdge()
    The index of the edge within the path beneath the cursor when the event occurred, if the event occurred on a mid-point on an editable polygon.
    int getPath()
    The index of the path beneath the cursor when the event occurred, if the event occurred on a vertex and the polygon is editable.
    int getVertex()
    The index of the vertex beneath the cursor when the event occurred, if the event occurred on a vertex and the polyline or polygon is editable.
    static IPolyMouseEvent make​(ILatLng latLng, int edge, int path, int vertex)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD! ***
    Factory to instantiate an IPolyMouseEvent from the given data values

    Methods inherited from interface provided.owlMaps.mouse.IMouseEvent

    getLatLng

  • Method Details

    • getEdge

      int getEdge()
      The index of the edge within the path beneath the cursor when the event occurred, if the event occurred on a mid-point on an editable polygon.
      Returns:
      The index of the edge

    • getPath

      int getPath()
      The index of the path beneath the cursor when the event occurred, if the event occurred on a vertex and the polygon is editable. Otherwise undefined.
      Returns:
      The index of the path

    • getVertex

      int getVertex()
      The index of the vertex beneath the cursor when the event occurred, if the event occurred on a vertex and the polyline or polygon is editable. If the event does not occur on a vertex, the value is undefined.
      Returns:
      The index of the vertex

    • make

      static IPolyMouseEvent make​(ILatLng latLng, int edge, int path, int vertex)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER USE THIS METHOD! ***
      Factory to instantiate an IPolyMouseEvent from the given data values
      Parameters:
      latLng - The ILatLng where the event occurred on the map
      edge - The edge index of where the event occurred on the polyline/polygon
      path - The index of the path segment where the event occurred on the polyline/polygon
      vertex - The index of the vertex where the event occurred on the polyline/polygon
      Returns:
      A new IPolyMouseEvent instance