GMSGroundOverlay specifies the available options for a ground overlay that exists on the Earth's surface.
Unlike a marker, the position of a ground overlay is specified explicitly and it does not face the camera.
|Convenience constructor for GMSGroundOverlay for a particular |
|Constructs a GMSGroundOverlay that renders the given |
|The position of this GMSGroundOverlay, or more specifically, the physical position of its anchor. |
|The anchor specifies where this GMSGroundOverlay is anchored to the Earth in relation to |
|Icon to render within |
|Sets the opacity of the ground overlay, between 0 (completely transparent) and 1 (default) inclusive. |
|Bearing of this ground overlay, in degrees. |
|The 2D bounds on the Earth in which |
|Title, a short description of the overlay. |
|The map this overlay is on. |
|If this overlay should cause tap notifications. |
Member Function Documentation
|+ (instancetype) groundOverlayWithBounds:||(GMSCoordinateBounds *_Nullable)||bounds|
Convenience constructor for GMSGroundOverlay for a particular
|+ (instancetype) groundOverlayWithPosition:||(CLLocationCoordinate2D)||position|
Constructs a GMSGroundOverlay that renders the given
position, as if the image's actual size matches camera pixels at
|- (CLLocationCoordinate2D) position
The position of this GMSGroundOverlay, or more specifically, the physical position of its anchor.
If this is changed,
bounds will be moved around the new position.
|- (CGPoint) anchor
The anchor specifies where this GMSGroundOverlay is anchored to the Earth in relation to
If this is modified,
position will be set to the corresponding new position within
|- (UIImage* _Nullable) icon
Icon to render within
bounds on the Earth.
If this is nil, the overlay will not be visible (unlike GMSMarker which has a default image).
|- (float) opacity
Sets the opacity of the ground overlay, between 0 (completely transparent) and 1 (default) inclusive.
|- (CLLocationDirection) bearing
Bearing of this ground overlay, in degrees.
The default value, zero, points this ground overlay up/down along the normal Y axis of the earth.
The 2D bounds on the Earth in which
icon is drawn.
Changing this value will adjust
|- (NSString* _Nullable) title
Title, a short description of the overlay.
Some overlays, such as markers, will display the title on the map. The title is also the default accessibility text.
The map this overlay is on.
Setting this property will add the overlay to the map. Setting it to nil removes this overlay from the map. An overlay may be active on at most one map at any given time.
|- (BOOL) tappable
If this overlay should cause tap notifications.
Some overlays, such as markers, will default to being tappable.
|- (int) zIndex
zIndex value overlays will be drawn on top of lower
zIndex value tile layers and overlays.
Equal values result in undefined draw ordering. Markers are an exception that regardless of
zIndex, they will always be drawn above tile layers and other non-marker overlays; they are effectively considered to be in a separate z-index group compared to other overlays.