GMSSpriteStyle Class Reference

Public Member Functions | Static Public Member Functions | Properties
GMSSpriteStyle Class Reference

Overview

Describes the drawing style for a stamp image over a GMSStyleSpan.

Note:
Only supports transparent background. If any color is set to the GMSStyleSpan it will only be treated as a fallback.
Use of GMSSpriteStyle requires Metal rendering framework. See setMetalRendererEnabled: (GMSServices) to learn how to enable Metal. If GMSStyleSpan is added to a map without Metal being enabled, the stamp will not render and instead the polyline span will attempt to fallback to any set color. If no color is set, it will fallback to the default polyline color, [UIColor blueColor].
Use GMSMapView::mapCapabilities property to query if a GMSMapView supports GMSSpriteStyle.

Inherits GMSStampStyle.

Public Member Functions

(instancetype) - initWithImage:
 Returns an initialized sprite stamp style with the given image.

Static Public Member Functions

(instancetype) + spriteStyleWithImage:
 Returns a sprite stamp style with the given image.

Properties

UIImage * stampImage
 The image or texture that will repeated over a stroke.

Member Function Documentation

+ (instancetype) spriteStyleWithImage: (UIImage *)  image

Returns a sprite stamp style with the given image.

Parameters:
imageA UIImage object to use as the stamp image.
Returns:
An initialized sprite stamp style.
- (instancetype) initWithImage: (UIImage *)  image

Returns an initialized sprite stamp style with the given image.

Parameters:
imageA UIImage object to use as the stamp image.
Returns:
An initialized sprite stamp style.

Property Documentation

- (UIImage*) stampImage [read, assign, inherited]

The image or texture that will repeated over a stroke.

Note that this image will be compressed into a square - so for best results have a square image. The rendered stamps will be the width of the line that the GMSStrokeStyle is set on. The image will be oriented with the top of the image towards the start point, and the bottom of the image towards the end point. For example, if the underlying line has two points and the start point is directly above the endpoint, the stamp will appear in an upright orientation.