HERE iOS SDK Developer's Guide

NMAMapCircle

Class Summary

class NMAMapCircle

Derived from: NMAMapObject

Represents a NMAMapObject in the shape of a circle.

Include: NMAKit.framework/headers/NMAMapCircle.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAMapCircle

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, strong] NMAGeoCoordinates center

The NMAGeoCoordinates representing the center of the NMAMapCircle

[readable, writable, assign] BOOL  depthTestEnabled

Indicates whether to render the NMAMapCircle with depth test

[readable, writable, strong] UIColor *  fillColor

The fill color for the NMAMapCircle

[readable, writable, strong] UIColor *  lineColor

The line color for the NMAMapCircle

[readable, writable, assign] NSUInteger  lineWidth

The line width, in pixels, for the NMAMapCircle border

[readable, writable, assign] double  radius

The radius of the NMAMapCircle, in meters

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) initWithGeoCoordinates:(nullable NMAGeoCoordinates *) coordinates

Initializes a NMAMapCircle instance with the specified NMAGeoCoordinates as the center and a radius of 1 meter

-(nonnull instancetype) initWithGeoCoordinates:(nullable NMAGeoCoordinates *) coordinates radius:(double) radius

Initializes a NMAMapCircle instance with the specified NMAGeoCoordinates as the center and the specified double as the radius (in meters)

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) mapCircleWithGeoCoordinates:(nullable NMAGeoCoordinates *) coordinates

A convenience method to construct a NMAMapCircle at specified coordinates

+(nonnull instancetype) mapCircleWithGeoCoordinates:(nullable NMAGeoCoordinates *) coordinates radius:(double) radius

A convenience method to construct a NMAMapCircle at specified coordinates and with a given radius

Class Details

Represents a NMAMapObject in the shape of a circle. NMAMapCircle is helper class for creating and updating a NMAMapPolygon representing a circle.

Public Property Details

[readable, writable, strong] NMAGeoCoordinatescenter

The NMAGeoCoordinates representing the center of the NMAMapCircle.

Note:

The NMAViewObject location property will return the same coordinates.

[readable, writable, assign] BOOL depthTestEnabled

Indicates whether to render the NMAMapCircle with depth test.

Note:

Rendering with depth test should be used if map object altitude is relevant in your application. Rendering objects with different heights while disabling depth test may cause object occlusion.

[readable, writable, strong] UIColor * fillColor

The fill color for the NMAMapCircle.

Note:

The default value (in RGBA) is 0x00498A55

[readable, writable, strong] UIColor * lineColor

The line color for the NMAMapCircle.

Note:

The default value (in RGBA) is 0xC00066AA

[readable, writable, assign] NSUInteger lineWidth

The line width, in pixels, for the NMAMapCircle border. The supported value range is [1..100].

Note:

The default value is 0 pixels

[readable, writable, assign] double radius

The radius of the NMAMapCircle, in meters.

Note:

The default value is 1 meter

Instance Method Details

-(nonnull instancetype) initWithGeoCoordinates:(nullable NMAGeoCoordinates *) coordinates

Initializes a NMAMapCircle instance with the specified NMAGeoCoordinates as the center and a radius of 1 meter.

Parameters:

  • coordinates

    A NMAGeoCoordinates representing the NMAMapCircle center

Returns:

The NMAMapCircle

-(nonnull instancetype) initWithGeoCoordinates:(nullable NMAGeoCoordinates *) coordinates radius:(double) radius

Initializes a NMAMapCircle instance with the specified NMAGeoCoordinates as the center and the specified double as the radius (in meters).

Parameters:

  • coordinates

    A NMAGeoCoordinates representing the NMAMapCircle center

  • radius

    The radius of the circle

Returns:

The NMAMapCircle

Class Method Details

+(nonnull instancetype) mapCircleWithGeoCoordinates:(nullable NMAGeoCoordinates *) coordinates

A convenience method to construct a NMAMapCircle at specified coordinates.

Parameters:

  • coordinates

    The location of the map circle center

+(nonnull instancetype) mapCircleWithGeoCoordinates:(nullable NMAGeoCoordinates *) coordinates radius:(double) radius

A convenience method to construct a NMAMapCircle at specified coordinates and with a given radius.

Parameters:

  • coordinates

    The location of the map circle center

  • radius

    The radius (in meters) of the map circle