HERE iOS SDK Developer's Guide

NMAARBillboardObject

Class Summary

class NMAARBillboardObject

Derived from: NMAARModelObject

3D LiveSight billboard object that users can add to a NMAARController.

Include: NMAKit.framework/headers/NMAARBillboardObject.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAARBillboardObject

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] NMAGeoCoordinates geoPosition

The geo coordinates of the billboard center

[readable, writable, assign] NMAVector3d   localPosition

The local position of the billboard center relative to the camera, in meters

[readable, writable, assign] NMAARBillboardObjectOrientation   orientation

The orientation mode of the billboard

[readable, writable, assign] CGSize  size

The spatial size of the billboard in meters

[readable, writable, assign] NMAVector3d   surfaceNormal

The surface normal vector of the billboard

[readable, writable, assign] NMAVector3d   upDirection

The up direction vector of the billboard

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(id) initWithGeoCoordinates:( NMAGeoCoordinates *) geoPosition texture:( NMAImage *) texture

Creates a billboard object with a geo position and texture

-(id) initWithLocalPosition:( NMAVector3d ) localPosition texture:( NMAImage *) texture

Creates a billboard object with a local position and texture

Class Details

3D LiveSight billboard object that users can add to a NMAARController.

Note:

There are two type types of billboard objects supported:

  • Locally positioned billboard.
  • Geo positioned billboard.

In a locally positioned billboard, the object has a fixed relative distance to the camera In a geo positioned billboard, the object is fixed at the specified geo coordinates.

Public Property Details

[readable, writable, assign] NMAGeoCoordinatesgeoPosition

The geo coordinates of the billboard center.

Note:

Valid only if the object is initialized with a geo position.

[readable, writable, assign] NMAVector3d  localPosition

The local position of the billboard center relative to the camera, in meters.

Note:

Valid only if the object is initialized with a local position.

[readable, writable, assign] NMAARBillboardObjectOrientation  orientation

The orientation mode of the billboard.

Note:

The default value is NMAARBillboardObjectOrientationBillboard.

See also:

NMAARBillboardObjectOrientation

[readable, writable, assign] CGSize size

The spatial size of the billboard in meters.

Note:

The default value is (1.0, 1.0).

[readable, writable, assign] NMAVector3d  surfaceNormal

The surface normal vector of the billboard.

The normal vector defines the direction that the billboard is facing.

Note:

Valid only with NMAARBillboardObjectOrientationFixed orientation mode.

[readable, writable, assign] NMAVector3d  upDirection

The up direction vector of the billboard.

The up vector defines the direction of the top of the billboard.

Note:

Valid only with NMAARBillboardObjectOrientationFixed orientation mode.

Instance Method Details

-(id) initWithGeoCoordinates:( NMAGeoCoordinates *) geoPosition texture:( NMAImage *) texture

Creates a billboard object with a geo position and texture.

Parameters:

  • geoPosition

    The center of the billboard, represented as geo coordinates.

  • texture

    An optional texture image to display on the billboard.

-(id) initWithLocalPosition:( NMAVector3d ) localPosition texture:( NMAImage *) texture

Creates a billboard object with a local position and texture.

Parameters:

  • localPosition

    The center of the billboard, represented as a distance vector in meters relative to the camera origin.

  • texture

    An optional texture image to display on the billboard.