HERE iOS SDK Developer's Guide

NMAARObject

Class Summary

class NMAARObject

Derived from: NSObject

Base class for all LiveSight objects that can be added to an NMAARController.

Include: NMAKit.framework/headers/NMAARObject.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAARObject

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] NMAImage backPlaneIcon

The back plane icon of the object

[readable, writable, assign] NMAGeoCoordinates coordinates

The geo coordinates of the NMAARObject

[readable, assign] CGRect  frame

The frame of the object relative to the NMACompositeView in which it is rendered

[readable, writable, assign] NMAImage frontPlaneIcon

The front plane icon of the object

[readable, writable, strong] NMAImage infoImage

The info image of the object

[readable, writable, assign] CGFloat  infoImageMaximumHeight

The maximum height, in points, of the info image

[readable, writable, assign] CGFloat  infoImageMaximumWidth

The maximum width, in points, of the info image

[readable, assign] BOOL  infoImageVisible

Controls the visibility of the info image

[readable, writable, assign] float  opacity

The opacity of the object

[readable, writable, assign] NMAARProjectionType   projectionType

The projection type used to display the NMAARObject in a camera view

[readable, assign] NSUInteger  uniqueId

The unique ID of the NMAARObject

Class Details

Base class for all LiveSight objects that can be added to an NMAARController.

This class serves as a generalization (or abstract base) for more specific object types (such as NMAARIconObject), bundling their common properties. Do not attempt to create an NMAARObject instance directly.

By default objects have a projection type of NMAARProjectionTypeNearFar which means NMAARObjects are rendered in the Camera view using front plane or back plane icons.

Objects appearing in the back plane are rendered with reduced opacity.

Objects appearing in the front plane render their info image to the right of the front icon.

The front/back plane concept is only relevant to the NMAARProjectionTypeNearFar projection type.

Public Property Details

[readable, writable, assign] NMAImagebackPlaneIcon

The back plane icon of the object.

Rendered when the object appears in the back plane of the camera view

Note:

Attempts to replace an existing NMAImage with nil will be ignored.

[readable, writable, assign] NMAGeoCoordinatescoordinates

The geo coordinates of the NMAARObject.

[readable, assign] CGRect frame

The frame of the object relative to the NMACompositeView in which it is rendered.

[readable, writable, assign] NMAImagefrontPlaneIcon

The front plane icon of the object.

Rendered when the object appears in the front plane of the camera view.

Note:

Attempts to replace an existing NMAImage with nil will be ignored.

[readable, writable, strong] NMAImageinfoImage

The info image of the object.

By default the info image is displayed when the object appears in the front plane of the camera view.

Note:

Attempts to replace an existing NMAImage with nil will be ignored.

[readable, writable, assign] CGFloat infoImageMaximumHeight

The maximum height, in points, of the info image.

If a maximum height is set LiveSight will not scale the info image larger than this height.

By default this property has a negative value which means no maximum height.

[readable, writable, assign] CGFloat infoImageMaximumWidth

The maximum width, in points, of the info image.

If a maximum width is set LiveSight will not scale the info image larger than this width.

By default this property has a negative value which means no maximum width.

[readable, assign] BOOL infoImageVisible

Controls the visibility of the info image.

[readable, writable, assign] float opacity

The opacity of the object.

By default the opacity has a negative value, which means LiveSight adjusts the opacity based on a number of factors including the proximity of the object to the user and the presence of buildings between the camera and the object.

If this value is overridden, the object will be displayed with a fixed opacity. Valid values range from 0 (fully transparent) to 1 (fully opaque).

[readable, writable, assign] NMAARProjectionType  projectionType

The projection type used to display the NMAARObject in a camera view.

The default value is NMAARProjectionTypeGlobal.

[readable, assign] NSUInteger uniqueId

The unique ID of the NMAARObject.

Note:

This value will be consistent for the lifetime of the object.

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.