// // GMSMapView.h // Google Maps SDK for iOS // // Copyright 2012 Google LLC // // Usage of this SDK is subject to the Google Maps/Google Earth APIs Terms of // Service: https://developers.google.com/maps/terms // #import #import #if __has_feature(modules) @import GoogleMapsBase; #else #import #endif #if __has_feature(modules) @import GoogleMapsBase; #else #import #endif #import "GMSMapLayer.h" #import "GMSUISettings.h" #import "GMSAccessibilityLabels.h" @class GMSCameraPosition; @class GMSCameraUpdate; @class GMSCoordinateBounds; @class GMSIndoorDisplay; @class GMSMapLayer; @class GMSMapStyle; @class GMSMapView; @class GMSMarker; @class GMSOverlay; @class GMSProjection; NS_ASSUME_NONNULL_BEGIN /** Delegate for events on GMSMapView. */ @protocol GMSMapViewDelegate @optional /** * Called before the camera on the map changes, either due to a gesture, animation (e.g., by a user * tapping on the "My Location" button) or by being updated explicitly via the camera or a * zero-length animation on layer. * * @param mapView The map view that was tapped. * @param gesture If YES, this is occurring due to a user gesture. */ - (void)mapView:(GMSMapView *)mapView willMove:(BOOL)gesture; /** * Called repeatedly during any animations or gestures on the map (or once, if the camera is * explicitly set). This may not be called for all intermediate camera positions. It is always * called for the final position of an animation or gesture. */ - (void)mapView:(GMSMapView *)mapView didChangeCameraPosition:(GMSCameraPosition *)position; /** * Called when the map becomes idle, after any outstanding gestures or animations have completed (or * after the camera has been explicitly set). */ - (void)mapView:(GMSMapView *)mapView idleAtCameraPosition:(GMSCameraPosition *)position; /** * Called after a tap gesture at a particular coordinate, but only if a marker was not tapped. This * is called before deselecting any currently selected marker (the implicit action for tapping on * the map). */ - (void)mapView:(GMSMapView *)mapView didTapAtCoordinate:(CLLocationCoordinate2D)coordinate; /** * Called after a long-press gesture at a particular coordinate. * * @param mapView The map view that was tapped. * @param coordinate The location that was tapped. */ - (void)mapView:(GMSMapView *)mapView didLongPressAtCoordinate:(CLLocationCoordinate2D)coordinate; /** * Called after a marker has been tapped. * * @param mapView The map view that was tapped. * @param marker The marker that was tapped. * @return YES if this delegate handled the tap event, which prevents the map from performing its * default selection behavior, and NO if the map should continue with its default selection * behavior. */ - (BOOL)mapView:(GMSMapView *)mapView didTapMarker:(GMSMarker *)marker; /** * Called after a marker's info window has been tapped. */ - (void)mapView:(GMSMapView *)mapView didTapInfoWindowOfMarker:(GMSMarker *)marker; /** * Called after a marker's info window has been long pressed. */ - (void)mapView:(GMSMapView *)mapView didLongPressInfoWindowOfMarker:(GMSMarker *)marker; /** * Called after an overlay has been tapped. * * This method is not called for taps on markers. * * @param mapView The map view that was tapped. * @param overlay The overlay that was tapped. */ - (void)mapView:(GMSMapView *)mapView didTapOverlay:(GMSOverlay *)overlay; /** * Called after a POI has been tapped. * * @param mapView The map view that was tapped. * @param placeID The placeID of the POI that was tapped. * @param name The name of the POI that was tapped. * @param location The location of the POI that was tapped. */ - (void)mapView:(GMSMapView *)mapView didTapPOIWithPlaceID:(NSString *)placeID name:(NSString *)name location:(CLLocationCoordinate2D)location; /** * Called when a marker is about to become selected, and provides an optional custom info window to * use for that marker if this method returns a UIView. * * If you change this view after this method is called, those changes will not necessarily be * reflected in the rendered version. * * The returned UIView must not have bounds greater than 500 points on either dimension. As there * is only one info window shown at any time, the returned view may be reused between other info * windows. * * Removing the marker from the map or changing the map's selected marker during this call results * in undefined behavior. * * @return The custom info window for the specified marker, or nil for default */ - (nullable UIView *)mapView:(GMSMapView *)mapView markerInfoWindow:(GMSMarker *)marker; /** * Called when mapView:markerInfoWindow: returns nil. If this method returns a view, it will be * placed within the default info window frame. If this method returns nil, then the default * rendering will be used instead. * * @param mapView The map view that was pressed. * @param marker The marker that was pressed. * @return The custom view to display as contents in the info window, or nil to use the default * content rendering instead */ - (nullable UIView *)mapView:(GMSMapView *)mapView markerInfoContents:(GMSMarker *)marker; /** * Called when the marker's info window is closed. */ - (void)mapView:(GMSMapView *)mapView didCloseInfoWindowOfMarker:(GMSMarker *)marker; /** * Called when dragging has been initiated on a marker. */ - (void)mapView:(GMSMapView *)mapView didBeginDraggingMarker:(GMSMarker *)marker; /** * Called after dragging of a marker ended. */ - (void)mapView:(GMSMapView *)mapView didEndDraggingMarker:(GMSMarker *)marker; /** * Called while a marker is dragged. */ - (void)mapView:(GMSMapView *)mapView didDragMarker:(GMSMarker *)marker; /** * Called when the My Location button is tapped. * * @return YES if the listener has consumed the event (i.e., the default behavior should not occur), * NO otherwise (i.e., the default behavior should occur). The default behavior is for the * camera to move such that it is centered on the user location. */ - (BOOL)didTapMyLocationButtonForMapView:(GMSMapView *)mapView; /** * Called when the My Location Dot is tapped. * * @param mapView The map view that was tapped. * @param location The location of the user when the location dot was tapped. */ - (void)mapView:(GMSMapView *)mapView didTapMyLocation:(CLLocationCoordinate2D)location; /** * Called when tiles have just been requested or labels have just started rendering. */ - (void)mapViewDidStartTileRendering:(GMSMapView *)mapView; /** * Called when all tiles have been loaded (or failed permanently) and labels have been rendered. */ - (void)mapViewDidFinishTileRendering:(GMSMapView *)mapView; /** * Called when map is stable (tiles loaded, labels rendered, camera idle) and overlay objects have * been rendered. */ - (void)mapViewSnapshotReady:(GMSMapView *)mapView; @end /** * \defgroup MapViewType GMSMapViewType * @{ */ /** * Display types for GMSMapView. */ typedef NS_ENUM(NSUInteger, GMSMapViewType) { /** Basic maps. The default. */ kGMSTypeNormal GMS_SWIFT_NAME_2_0_3_0(Normal, normal) = 1, /** Satellite maps with no labels. */ kGMSTypeSatellite GMS_SWIFT_NAME_2_0_3_0(Satellite, satellite), /** Terrain maps. */ kGMSTypeTerrain GMS_SWIFT_NAME_2_0_3_0(Terrain, terrain), /** Satellite maps with a transparent label overview. */ kGMSTypeHybrid GMS_SWIFT_NAME_2_0_3_0(Hybrid, hybrid), /** No maps, no labels. Display of traffic data is not supported. */ kGMSTypeNone GMS_SWIFT_NAME_2_0_3_0(None, none), }; /**@}*/ /** * \defgroup FrameRate GMSFrameRate * @{ */ /** * Rendering frame rates for GMSMapView. */ typedef NS_ENUM(NSUInteger, GMSFrameRate) { /** Use the minimum frame rate to conserve battery usage. */ kGMSFrameRatePowerSave, /** * Use a median frame rate to provide smoother rendering and conserve processing cycles. */ kGMSFrameRateConservative, /** * Use the maximum frame rate for a device. For low end devices this will be 30 FPS, * for high end devices 60 FPS. */ kGMSFrameRateMaximum, }; /**@}*/ /** * \defgroup MapViewPaddingAdjustmentBehavior GMSMapViewPaddingAdjustmentBehavior * @{ */ /** * Constants indicating how safe area insets are added to padding. */ typedef NS_ENUM(NSUInteger, GMSMapViewPaddingAdjustmentBehavior) { /** Always include the safe area insets in the padding. */ kGMSMapViewPaddingAdjustmentBehaviorAlways, /** * When the padding value is smaller than the safe area inset for a particular edge, use the safe * area value for layout, else use padding. */ kGMSMapViewPaddingAdjustmentBehaviorAutomatic, /** * Never include the safe area insets in the padding. This was the behavior prior to version 2.5. */ kGMSMapViewPaddingAdjustmentBehaviorNever, }; /**@}*/ /** * This is the main class of the Google Maps SDK for iOS and is the entry point for all methods * related to the map. * * The map should be instantiated via the convenience constructor [GMSMapView mapWithFrame:camera:]. * It may also be created with the default [[GMSMapView alloc] initWithFrame:] method (wherein its * camera will be set to a default location). * * GMSMapView can only be read and modified from the main thread, similar to all UIKit objects. * Calling these methods from another thread will result in an exception or undefined behavior. */ @interface GMSMapView : UIView /** GMSMapView delegate. */ @property(nonatomic, weak, nullable) IBOutlet id delegate; /** * Controls the camera, which defines how the map is oriented. Modification of this property is * instantaneous. */ @property(nonatomic, copy) GMSCameraPosition *camera; /** * Returns a GMSProjection object that you can use to convert between screen coordinates and * latitude/longitude coordinates. * * This is a snapshot of the current projection, and will not automatically update when the camera * moves. It represents either the projection of the last drawn GMSMapView frame, or; where the * camera has been explicitly set or the map just created, the upcoming frame. It will never be nil. */ @property(nonatomic, readonly) GMSProjection *projection; /** * Controls whether the My Location dot and accuracy circle is enabled. Defaults to NO. */ @property(nonatomic, getter=isMyLocationEnabled) BOOL myLocationEnabled; /** * If My Location is enabled, reveals where the user location dot is being drawn. If it is disabled, * or it is enabled but no location data is available, this will be nil. This property is * observable using KVO. */ @property(nonatomic, readonly, nullable) CLLocation *myLocation; /** * The marker that is selected. Setting this property selects a particular marker, showing an info * window on it. If this property is non-nil, setting it to nil deselects the marker, hiding the * info window. This property is observable using KVO. */ @property(nonatomic, nullable) GMSMarker *selectedMarker; /** * Controls whether the map is drawing traffic data, if available. This is subject to the * availability of traffic data. Defaults to NO. */ @property(nonatomic, getter=isTrafficEnabled) BOOL trafficEnabled; /** * Controls the type of map tiles that should be displayed. Defaults to kGMSTypeNormal. */ @property(nonatomic) GMSMapViewType mapType; /** * Controls the style of the map. * * A non-nil mapStyle will only apply if mapType is Normal. */ @property(nonatomic, nullable) GMSMapStyle *mapStyle; /** * Minimum zoom (the farthest the camera may be zoomed out). Defaults to kGMSMinZoomLevel. Modified * with -setMinZoom:maxZoom:. */ @property(nonatomic, readonly) float minZoom; /** * Maximum zoom (the closest the camera may be to the Earth). Defaults to kGMSMaxZoomLevel. Modified * with -setMinZoom:maxZoom:. */ @property(nonatomic, readonly) float maxZoom; /** * If set, 3D buildings will be shown where available. Defaults to YES. * * This may be useful when adding a custom tile layer to the map, in order to make it clearer at * high zoom levels. Changing this value will cause all tiles to be briefly invalidated. */ @property(nonatomic, getter=isBuildingsEnabled) BOOL buildingsEnabled; /** * Sets whether indoor maps are shown, where available. Defaults to YES. * * If this is set to NO, caches for indoor data may be purged and any floor currently selected by * the end-user may be reset. */ @property(nonatomic, getter=isIndoorEnabled) BOOL indoorEnabled; /** * Gets the GMSIndoorDisplay instance which allows to observe or control aspects of indoor data * display. */ @property(nonatomic, readonly) GMSIndoorDisplay *indoorDisplay; /** * Gets the GMSUISettings object, which controls user interface settings for the map. */ @property(nonatomic, readonly) GMSUISettings *settings; /** * Controls the 'visible' region of the view. By applying padding an area around the edge of the * view can be created which will contain map data but will not contain UI controls. * * If the padding is not balanced, the visual center of the view will move as appropriate. Padding * will also affect the |projection| property so the visible region will not include the padding * area. GMSCameraUpdate fitToBounds will ensure that both this padding and any padding requested * will be taken into account. * * This property may be animated within a UIView-based animation block. */ @property(nonatomic) UIEdgeInsets padding; /** * Controls how safe area insets are added to the padding values. Like padding, safe area insets * position map controls such as the compass, my location button and floor picker within the device * safe area. * * Defaults to kGMSMapViewPaddingAdjustmentBehaviorAlways. */ @property(nonatomic) GMSMapViewPaddingAdjustmentBehavior paddingAdjustmentBehavior; /** * Defaults to YES. If set to NO, GMSMapView will generate accessibility elements for overlay * objects, such as GMSMarker and GMSPolyline. * * This property is as per the informal UIAcessibility protocol, except for the default value of * YES. */ @property(nonatomic) BOOL accessibilityElementsHidden; /** * Accessor for the custom CALayer type used for the layer. */ @property(nonatomic, readonly, retain) GMSMapLayer *layer; /** * Controls the rendering frame rate. Default value is kGMSFrameRateMaximum. */ @property(nonatomic) GMSFrameRate preferredFrameRate; /** * If not nil, constrains the camera target so that gestures cannot cause it to leave the specified * bounds. */ @property(nonatomic, nullable) GMSCoordinateBounds *cameraTargetBounds; /** * Convenience initializer that builds and returns a GMSMapView, with a frame and camera target. */ - (instancetype)initWithFrame:(CGRect)frame camera:(GMSCameraPosition *)camera; /** * Builds and returns a GMSMapView, with a frame and camera target. */ + (instancetype)mapWithFrame:(CGRect)frame camera:(GMSCameraPosition *)camera; /** * Tells this map to power up its renderer. This is optional and idempotent. */ - (void)startRendering __GMS_AVAILABLE_BUT_DEPRECATED_MSG( "This method is obsolete and will be removed in a future release."); /** * Tells this map to power down its renderer. This is optional and idempotent. */ - (void)stopRendering __GMS_AVAILABLE_BUT_DEPRECATED_MSG( "This method is obsolete and will be removed in a future release."); /** * Clears all markup that has been added to the map, including markers, polylines and ground * overlays. This will not clear the visible location dot or reset the current mapType. */ - (void)clear; /** * Sets |minZoom| and |maxZoom|. This method expects the minimum to be less than or equal to the * maximum, and will throw an exception with name NSRangeException otherwise. */ - (void)setMinZoom:(float)minZoom maxZoom:(float)maxZoom; /** * Build a GMSCameraPosition that presents |bounds| with |padding|. The camera will have a zero * bearing and tilt (i.e., facing north and looking directly at the Earth). This takes the frame and * padding of this GMSMapView into account. * * If the bounds is invalid this method will return a nil camera. */ - (nullable GMSCameraPosition *)cameraForBounds:(GMSCoordinateBounds *)bounds insets:(UIEdgeInsets)insets; /** * Changes the camera according to |update|. The camera change is instantaneous (with no animation). */ - (void)moveCamera:(GMSCameraUpdate *)update; /** * Check whether the given camera positions would practically cause the camera to be rendered the * same, taking into account the level of precision and transformations used internally. */ - (BOOL)areEqualForRenderingPosition:(GMSCameraPosition *)position position:(GMSCameraPosition *)otherPosition; @end NS_ASSUME_NONNULL_END