Class NCSublocation - Navigine/Indoor-Navigation-iOS-Mobile-SDK-2.0 GitHub Wiki

NCSublocation class is used for storing sublocation parameters: identifier, name, width, heigth, etc. The list of sublocations for the current location can be obtained from NCLocation class using public method NCLocation.getSublocations.

Referenced from: NCLocation.

@interface NCSublocation : NSObject

- (nonnull NCLocationPoint *)globalToLocal:(nonnull NCGlobalPoint *)globalPoint;

- (nonnull NCGlobalPoint *)localToGlobal:(nonnull NCLocationPoint *)localPoint;

- (nullable NCGraph *)getGraph:(nonnull NSString *)tag;

- (nullable NCVenue *)getVenueById:(int32_t)id;

- (nullable NCZone *)getZoneById:(int32_t)id;

@property (nonatomic, readonly) int32_t id;

@property (nonatomic, readonly) int32_t location;

@property (nonatomic, nonnull, readonly) NSString * name;

@property (nonatomic, nonnull, readonly) NSString * imageId;

@property (nonatomic, readonly) float width;

@property (nonatomic, readonly) float height;

@property (nonatomic, readonly) float azimuth;

@property (nonatomic, nonnull, readonly) NSArray<NCBeacon *> * beacons;

@property (nonatomic, nonnull, readonly) NSArray<NCEddystone *> * eddystones;

@property (nonatomic, nonnull, readonly) NSArray<NCWifi *> * wifis;

@property (nonatomic, nonnull, readonly) NSArray<NCVenue *> * venues;

@property (nonatomic, nonnull, readonly) NSArray<NCZone *> * zones;

@end

Public fields

  • id - sublocation's id in personal account
  • location - location's id
  • name - sublocation's name in personal account
  • imageId - image id, which could be used for getting NCImage using NCResourceManager
  • width - sublocation's width (in meters)
  • height - sublocation's height (in meters)
  • azimuth - sublocation's azimuth angle (in degrees, clockwise)
  • beacons - list of beacons, attached to this sublocation (see NCBeacon class)
  • eddystones - list of eddystones, attached to this sublocation (see NCEddystone class)
  • wifis - list of wifis, attached to this sublocation (see NCWifi class)
  • venues - list of venues, attached to this sublocation (see NCVenue class)
  • zones - list of zones from this sublocation (see NCZone class)

Public methods

Function localToGlobal

- (nonnull NCGlobalPoint *)localToGlobal:(nonnull NCLocationPoint *)localPoint;

Function is used for converting the local sublocation coordinates to the global geographic coordinates (latitude and longitude) using the geographic binding of the sublocation.

Parameters
  • localPoint — the sublocation's local point.
Return value

Global point — the geographical latitude and longitude, corresponding to the specified position within the sublocation.

Function globalToLocal

- (nonnull NCLocationPoint *)globalToLocal:(nonnull NCGlobalPoint *)globalPoint;

Function is used for converting the global geographic coordinates (latitude and longitude) to the local sublocation coordinates (x and y) using the geographic binding of the sublocation.

Parameters
  • globalPoint — the sublocation's global point.
Return value

The location point within the sublocation corresponding to the specified global point.

Function getGraph

- (nullable NCGraph *)getGraph:(nonnull NSString *)tag;

Function is used for getting graph of the sublimation by tag.

Parameters
  • tag — the graph's tag.
Return value

The NCGraph element of the sublocation.

Function getVenueById

- (nullable NCVenue *)getVenueById:(int32_t)id;
Parameters
  • id — the identifier of the venue.
Return value

Function returns the venue (within the current sublocation) with the specified identifier or nil if no such venue exists.

Function getZoneById

- (nullable NCZone *)getZoneById:(int32_t)id;
Parameters
  • id — the identifier of the zone.
Return value

Function returns the zone (within the current sublocation) with the specified identifier or nil if no such zone exists.

⚠️ **GitHub.com Fallback** ⚠️