HERE iOS SDK Developer's Guide

NMAStreetLevelIconBase

Class Summary

class NMAStreetLevelIconBase

Derived from: NMAStreetLevelObject

NMAStreetLevelIconBase provides a base class for rendering custom icons (NMAImage or UIImage instances) in an NMAStreetLevelView.

Include: NMAKit.framework/headers/NMAStreetLevelIconBase.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAStreetLevelIconBase

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] float  alpha

The transparency value of the NMAStreetLevelIconBase

[readable, writable, assign] CGPoint  anchorPoint

The anchor point of the NMAStreetLevelIconBase, used to position the image relative to the icon's geographical location

[readable, writable, assign] NMAStreetLevelBuilding building

The NMAStreetLevelBuilding to which the NMAStreetLevelIconBase is attached

[readable, assign] NMAStreetLevelHorizontalPlacement   horizontalPlacement

The horizontal placement behavior of the NMAStreetLevelIconBase

[readable, writable, assign] NMAImage image

The image displayed by the NMAStreetLevelIconBase

[readable, writable, assign] NMAGeoCoordinates position

The Geo position of the NMAStreetLevelIconBase

[readable, assign] NMAStreetLevelVerticalPlacement   verticalPlacement

The vertical placement behavior of the NMAStreetLevelIconBase

[readable, assign] float  verticalPlacementParameter

A parameter used to control the vertical placement behavior of the NMAStreetLevelIconBase

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(void) setHorizontalPlacement:( NMAStreetLevelHorizontalPlacement ) horizontalPlacement verticalPlacement:( NMAStreetLevelVerticalPlacement ) verticalPlacement verticalPlacementParameter:(float) verticalPlacementParameter

Sets the horizontal placement behavior, vertical placement behavior, and verticalPlacementParameter of the NMAStreetLevelIconBase

Class Details

NMAStreetLevelIconBase provides a base class for rendering custom icons ( NMAImage or UIImage instances) in an NMAStreetLevelView.

Note:

NMAStreetLevelIconBase cannot be directly instantiated. Instead, an appropriate derived class ( NMAStreetLevelIcon or NMAStreetLevelBillboard) should be used.

Public Property Details

[readable, writable, assign] float alpha

The transparency value of the NMAStreetLevelIconBase. Valid values range from 0 (fully transparent) to 1 (fully opaque).

[readable, writable, assign] CGPoint anchorPoint

The anchor point of the NMAStreetLevelIconBase, used to position the image relative to the icon's geographical location.

The anchor point specifies a fractional position inside the displayed image. When the image is rendered inside a street level view, this point will coincide with the geographical location of the NMAStreetLevelIconBase.

Note:

The default value is (0.5, 0.5).

Note:

The anchor point must be in the range ([0,1],[0,1]). Values outside this range will be clamped.

[readable, writable, assign] NMAStreetLevelBuildingbuilding

The NMAStreetLevelBuilding to which the NMAStreetLevelIconBase is attached.

[readable, assign] NMAStreetLevelHorizontalPlacement  horizontalPlacement

The horizontal placement behavior of the NMAStreetLevelIconBase.

This property is set via setHorizontalPlacement:verticalPlacement:verticalPlacementParameter:

The default value is NMAStreetLevelHorizontalPlacementDefault.

Specifying NMAStreetLevelHorizontalPlacementCentroid for NMAStreetLevelBillboard objects will result in the NMAStreetLevelBillboard failing to render.

See also:

NMAStreetLevelHorizontalPlacement

[readable, writable, assign] NMAImageimage

The image displayed by the NMAStreetLevelIconBase.

[readable, writable, assign] NMAGeoCoordinatesposition

The Geo position of the NMAStreetLevelIconBase.

[readable, assign] NMAStreetLevelVerticalPlacement  verticalPlacement

The vertical placement behavior of the NMAStreetLevelIconBase.

This property is set via setHorizontalPlacement:verticalPlacement:verticalPlacementParameter:

The default value is NMAStreetLevelVerticalPlacementDefault.

See also:

NMAStreetLevelVerticalPlacement

[readable, assign] float verticalPlacementParameter

A parameter used to control the vertical placement behavior of the NMAStreetLevelIconBase.

The exact meaning of the parameter depends on the values of the horizontalPlacement and verticalPlacement properties as follows:

If the verticalPlacement is NMAStreetLevelVerticalPlacementTerrain, this parameter is the desired height of the icon above the terrain, in meters.

If the verticalPlacement is NMAStreetLevelVerticalPlacementFacade and the horizontalPlacement is NMAStreetLevelHorizontalPlacementFacade, this parameter is the minimum height above the terrain at which the icon can be placed.

If the verticalPlacement is NMAStreetLevelVerticalPlacementFacade and the horizontalPlacement is not NMAStreetLevelHorizontalPlacementFacade, this parameter is the desired height of the icon above the terrain, in meters.

If the verticalPlacement is NMAStreetLevelVerticalPlacementAttachment, this parameter is the vertical position of the icon relative to the building it is attached to. A value of 0 will place the icon at the base of the building, and a value of 1 will place the icon at the top of the building. Values may be outside the [0, 1] range.

Note:

Set using the setHorizontalPlacement:verticalPlacement:verticalPlacementParameter: method.

Instance Method Details

-(void) setHorizontalPlacement:( NMAStreetLevelHorizontalPlacement ) horizontalPlacement verticalPlacement:( NMAStreetLevelVerticalPlacement ) verticalPlacement verticalPlacementParameter:(float) verticalPlacementParameter

Sets the horizontal placement behavior, vertical placement behavior, and verticalPlacementParameter of the NMAStreetLevelIconBase.

Note:

See the verticalPlacementParameter property of NMAStreetLevelIconBase for a description of the parameter meanings.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.