GMSOverlay.h 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. //
  2. // GMSOverlay.h
  3. // Google Maps SDK for iOS
  4. //
  5. // Copyright 2013 Google Inc.
  6. //
  7. // Usage of this SDK is subject to the Google Maps/Google Earth APIs Terms of
  8. // Service: https://developers.google.com/maps/terms
  9. //
  10. #import <CoreLocation/CoreLocation.h>
  11. @class GMSMapView;
  12. /**
  13. * GMSOverlay is an abstract class that represents some overlay that may be
  14. * attached to a specific GMSMapView. It may not be instantiated directly;
  15. * instead, instances of concrete overlay types should be created directly
  16. * (such as GMSMarker, GMSPolyline, and GMSPolygon).
  17. *
  18. * This supports the NSCopying protocol; [overlay_ copy] will return a copy
  19. * of the overlay type, but with |map| set to nil.
  20. */
  21. @interface GMSOverlay : NSObject<NSCopying>
  22. /**
  23. * Title, a short description of the overlay. Some overlays, such as markers,
  24. * will display the title on the map. The title is also the default
  25. * accessibility text.
  26. */
  27. @property(nonatomic, copy) NSString *title;
  28. /**
  29. * The map this overlay is on. Setting this property will add the overlay to the
  30. * map. Setting it to nil removes this overlay from the map. An overlay may be
  31. * active on at most one map at any given time.
  32. */
  33. @property(nonatomic, weak) GMSMapView *map;
  34. /**
  35. * If this overlay should cause tap notifications. Some overlays, such as
  36. * markers, will default to being tappable.
  37. */
  38. @property(nonatomic, assign, getter=isTappable) BOOL tappable;
  39. /**
  40. * Higher |zIndex| value overlays will be drawn on top of lower |zIndex|
  41. * value tile layers and overlays. Equal values result in undefined draw
  42. * ordering. Markers are an exception that regardless of |zIndex|, they will
  43. * always be drawn above tile layers and other non-marker overlays; they
  44. * are effectively considered to be in a separate z-index group compared to
  45. * other overlays.
  46. */
  47. @property(nonatomic, assign) int zIndex;
  48. @end