HERE iOS SDK Developer's Guide

NMAVenue3dController

Class Summary

class NMAVenue3dController

Derived from: NSObject

NMAVenue3dController encapsulates interactions of a viewable NMAVenue3dVenue. Methods of this class allow clients to select and deselect levels and spaces.

Include: NMAKit.framework/headers/NMAVenue3dController.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVenue3dController

[For complete information, see the section Class Details]

See also:

NMAVenue3dMapLayer

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NMAVenue3dLevel groundLevel

The NMAVenue3dLevel object representing groud level

[readable, writable, weak] NMAVenue3dLevel level

Select a specific or access the selected NMAVenue3dLevel

[readable, writable, weak] NMAVenue3dSpace space

Select a specific or access the selected NMAVenue3dSpace inside NMAVenue3dVenue

[readable, writable, assign] NMAVenue3dStyleSettings styleSettings

The NMAVenue3dStyleSettings object representing styles for NMAVenue3dController

[readable, assign] NMAVenue3dVenue venue

The NMAVenue3dVenue object this NMAVenue3dController is representing

[readable, assign] BOOL  venueZoom

Returns if Venue Zoom is in use

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(void) deselectSpace

Deselect current NMAVenue3dSpace inside NMAVenue3dVenue

-(nullable NMAVenue3dBaseLocation *) getLocationAtX:(float) x Y:(float) y WithSpacePrefered:(bool) preferSpace

Returns the NMAVenue3dBaseLocation object based on the screen pixel coordinates

-(nonnull NMAGeoCoordinates *) getNormalGeoCoordinatesFromScaled:(nonnull NMAGeoCoordinates *) geoCoordinate

Returns normal geocoordinate from scaled geocoordinate used in Venue Zoom

-(nonnull NMAGeoCoordinates *) getScaledGeoCoordinatesFromNormal:(nonnull NMAGeoCoordinates *) geoCoordinate

Returns scaled geocoordinate to be used in Venue Zoom

-(nullable NMAVenue3dStyleSettings *) getStyleSettingsForSpace:(nonnull NMAVenue3dSpace *) space

Returns NMAVenue3dStyleSettings object for the specific space

-(void) setStyleSettings:(nullable NMAVenue3dStyleSettings *) settings forSpace:(nonnull NMAVenue3dSpace *) space

Sets NMAVenue3dStyleSettings object for the specific space

-(BOOL) useVenueZoom:(BOOL) venueZoomInUse

Sets Venue Zoom on or off

Class Details

NMAVenue3dController encapsulates interactions of a viewable NMAVenue3dVenue. Methods of this class allow clients to select and deselect levels and spaces.

This class can not be instantiated directly. Instead an instance of this class is returned by NMAVenue3dMapLayer::venueController or NMAVenue3dMapLayer::controllerForVenue:.

See also:

NMAVenue3dMapLayer

Public Property Details

[readable, assign] NMAVenue3dLevelgroundLevel

The NMAVenue3dLevel object representing groud level.

[readable, writable, weak] NMAVenue3dLevellevel

Select a specific or access the selected NMAVenue3dLevel. The selected level is viewed as the topmost in the venue. Levels on top of the selected level are hidden. Levels below the selected level are obscured by the level being selected.

[readable, writable, weak] NMAVenue3dSpacespace

Select a specific or access the selected NMAVenue3dSpace inside NMAVenue3dVenue. nil if no space is selected.

[readable, writable, assign] NMAVenue3dStyleSettingsstyleSettings

The NMAVenue3dStyleSettings object representing styles for NMAVenue3dController. Style settings can change visual representation of the venue, including colors for the shape and the label, the name and the icon. Default is nil (style settings are not specified).

[readable, assign] NMAVenue3dVenuevenue

The NMAVenue3dVenue object this NMAVenue3dController is representing.

[readable, assign] BOOL venueZoom

Returns if Venue Zoom is in use. Venue Zoom shows venues in enlarged mode. In Venue Zoom mode the map is not visible.

Instance Method Details

-(void) deselectSpace

Deselect current NMAVenue3dSpace inside NMAVenue3dVenue.

-(nullable NMAVenue3dBaseLocation *) getLocationAtX:(float) x Y:(float) y WithSpacePrefered:(bool) preferSpace

Returns the NMAVenue3dBaseLocation object based on the screen pixel coordinates.

Parameters:

Returns:

The NMAVenue3dLevelLocation or NMAVenue3dSpaceLocation object, if taps point is inside the venue, the NMAVenue3dOutdoorLocation object otherwise.

-(nonnull NMAGeoCoordinates *) getNormalGeoCoordinatesFromScaled:(nonnull NMAGeoCoordinates *) geoCoordinate

Returns normal geocoordinate from scaled geocoordinate used in Venue Zoom. In Venue Zoom mode coordinates need to be scaled in order to show map objects properly.

Parameters:

  • geoCoordinate

    Scaled coordinate to be converted to normal coodintate.

-(nonnull NMAGeoCoordinates *) getScaledGeoCoordinatesFromNormal:(nonnull NMAGeoCoordinates *) geoCoordinate

Returns scaled geocoordinate to be used in Venue Zoom. In Venue Zoom mode coordinates need to be scaled in order to show map objects properly.

Parameters:

  • geoCoordinate

    Coordinate to be converted to scale coodintate.

-(nullable NMAVenue3dStyleSettings *) getStyleSettingsForSpace:(nonnull NMAVenue3dSpace *) space

Returns NMAVenue3dStyleSettings object for the specific space. Style settings can change visual representation of the space, including colors for the shape and the label, the name and the icon.

Parameters:

  • space

    Space object for which style settings are applied.

Returns:

NMAVenue3dStyleSettings object for the specific space or nil if style settings are not set.

-(void) setStyleSettings:(nullable NMAVenue3dStyleSettings *) settings forSpace:(nonnull NMAVenue3dSpace *) space

Sets NMAVenue3dStyleSettings object for the specific space. Style settings can change visual representation of the space, including colors for the shape and the label, the name and the icon.

Parameters:

  • settings

    Style settings object.

  • space

    Space object for which style settings will be applied.

-(BOOL) useVenueZoom:(BOOL) venueZoomInUse

Sets Venue Zoom on or off. Venue Zoom shows venues in enlarged mode. In this mode the map is not visible but is replaced with a grey color. In order to use Venue Zoom, it must be enabled.

Parameters:

  • venueZoomInUse

    IfYES Venue Zoom is in use, otherwise not.

Returns:

boolean value indicating if transition was actually made.