HERE iOS SDK Developer's Guide

NMAVenue3dVenue

Class Summary

class NMAVenue3dVenue

Derived from: NMAVenue3dSpatialObject

NMAVenue3dVenue represents a public building or a group of public buildings in a map.

Include: NMAKit.framework/headers/NMAVenue3dVenue.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVenue3dVenue

[For complete information, see the section Class Details]

See also:

NMAVenue3dLevel

NMAVenue3dOuterArea

NMAVenue3dSpace

NMAVenue3dController

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NMAGeoBoundingBox boundingBox

The bounding box of this NMAVenue3dVenue

[readable, assign] NMAVenue3dContent content

The NMAVenues3dContent object this NMAVenue3dVenue

[readable, assign] NSInteger  floorNumber

The current floor number

[readable, assign] NMAGeoCoordinates geoCenter

The center of the NMAVenue3dVenue bounding box

[readable, assign] NSInteger  groundFloorNumber

The ground floor number

[readable, assign] NSArray< NMAVenue3dLevel * > *  levels

The array of NMAVenue3dLevel objects of this NMAVenue3dVenue

[readable, assign] NSArray< NMAVenue3dSpace * > *  spaces

The alphabetically level-wise ordered array of NMAVenue3dSpace objects for this NMAVenue3dVenue

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

-(nonnull NSArray< NMAVenue3dSpace * > *) nearbySpacesAroundSpace:(nonnull NMAVenue3dSpace *) space withinRadius:(float) radius

Returns spaces intersecting a circle with a given radius around the center of a space

-(nullable NMAVenue3dSpace *) spaceWithId:(nonnull NSString *) spaceId

Returns the space or the facility as the NMAVenue3dSpace object based on the given identifier inside this NMAVenue3dVenue

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

NMAVenue3dVenue represents a public building or a group of public buildings in a map.

Examples of public buildings are shopping malls and airports. Venues are displayed or hidden depending on map location.

A NMAVenue3dVenue object consists of one or more NMAVenue3dLevel objects. NMAVenue3dLevel, in turn, consists of one or more NMAVenue3dOuterArea objects. NMAVenue3dOuterArea represents a physical form of an outer area of certain level in the building. An NMAVenue3dOuterArea typically contains NMAVenue3dSpace objects that represent, for example, single shops inside the venue.

Note:

NMAVenue3dVenue cannot be instantiated directly. Instead, it can be obtained by calling NMAVenue3dController::venue or NMAVenue3dServiceListenerdidGetVenue:::venueService:didGetVenue: callback.

See also:

NMAVenue3dLevel

NMAVenue3dOuterArea

NMAVenue3dSpace

NMAVenue3dController

Public Property Details

[readable, assign] NMAGeoBoundingBoxboundingBox

The bounding box of this NMAVenue3dVenue.

[readable, assign] NMAVenue3dContentcontent

The NMAVenues3dContent object this NMAVenue3dVenue.

[readable, assign] NSInteger floorNumber

The current floor number. For ground floor it's 0. For underground floors: -1, -2, -3... For above ground floors: 1, 2, 3...

[readable, assign] NMAGeoCoordinatesgeoCenter

The center of the NMAVenue3dVenue bounding box.

[readable, assign] NSInteger groundFloorNumber

The ground floor number.

[readable, assign] NSArray< NMAVenue3dLevel * > * levels

The array of NMAVenue3dLevel objects of this NMAVenue3dVenue.

[readable, assign] NSArray< NMAVenue3dSpace * > * spaces

The alphabetically level-wise ordered array of NMAVenue3dSpace objects for this NMAVenue3dVenue.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

-(nonnull NSArray< NMAVenue3dSpace * > *) nearbySpacesAroundSpace:(nonnull NMAVenue3dSpace *) space withinRadius:(float) radius

Returns spaces intersecting a circle with a given radius around the center of a space.

Parameters:

  • space

    The space around the center of which to search.

  • radius

    The radius around the center of the space around which to search.

Returns:

A (possibly empty) array of nearby spaces.

-(nullable NMAVenue3dSpace *) spaceWithId:(nonnull NSString *) spaceId

Returns the space or the facility as the NMAVenue3dSpace object based on the given identifier inside this NMAVenue3dVenue.

Parameters:

Returns:

The NMAVenue3dSpace object or nil if there is no NMAVenue3dSpace with this identifier.

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly