Loading...
Searching...
No Matches

Class is used for storing sublocation parameters: identifier, name, width, heigth, etc. More...

#include <com/navigine/idl/objc/NCSublocation.h>

Inherits NSObject.

Instance Methods

(nullable UIImage *) - getImage:
 Method is used to obtain origin sublocation image with specified maxTextureSize.
 
(nonnull NCLocationPoint *) - globalToLocal:
 
(nonnull NCGlobalPoint *) - localToGlobal:
 Method is used for converting the local sublocation coordinates to the global geographic coordinates (latitude and longitude) using the geographic binding of the sublocation.
 
(nullable NCGraph *) - getGraph:
 Method is used to obtain graph (within the current sublocation) with the specified identifier or null if no such graph.
 
(nullable NCVenue *) - getVenueById:
 Method returns the venue (within the current sublocation) with the specified identifier or null if no such venue exists.
 
(nullable NCZone *) - getZoneById:
 Method returns the zone (within the current sublocation) with the specified identifier or null if no such zone exists.
 

Properties

int32_t id
 sublocation's identifier.
 
int32_t location
 location's identifier to which the sublocation belongs.
 
NSString * name
 sublocation's name.
 
float width
 sublocation's width in meters.
 
float height
 sublocation's height in meters.
 
NSNumber * altitude
 sublocation's altitude in meters if specified.
 
float azimuth
 sublocation's azimuth in degrees clockwise.
 
NCGlobalPointoriginPoint
 sublocation's center point in WGS84 coordinates GlobalPoint.
 
NSString * levelId
 sublocation's levelId.
 
NSString * externalId
 sublocation's externalId.
 
NSArray< NCBeacon * > * beacons
 List of beacons, attached to this sublocation Beacon.
 
NSArray< NCEddystone * > * eddystones
 List of eddystones, attached to this sublocation Eddystone.
 
NSArray< NCWifi * > * wifis
 List of wifis, attached to this sublocation Wifi.
 
NSArray< NCVenue * > * venues
 List of venues, attached to this sublocation Venue.
 
NSArray< NCZone * > * zones
 List of zones, attached to this sublocation Zone.
 

Detailed Description

Class is used for storing sublocation parameters: identifier, name, width, heigth, etc.

The list of sublocations for the current location can be obtained from Location class using public method getSublocations.

Referenced from Location.

Definition at line 29 of file NCSublocation.h.

Method Documentation

◆ getGraph:

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

Method is used to obtain graph (within the current sublocation) with the specified identifier or null if no such graph.

Parameters
taggraph tag.
Returns
found graph or null Graph.

◆ getImage:

- (nullable UIImage *) getImage: (nullable NSNumber *) maxTextureSize

Method is used to obtain origin sublocation image with specified maxTextureSize.

Parameters
maxTextureSizemaximum texure size to render.
Returns
platform image.

◆ getVenueById:

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

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

Parameters
idvenue unique identifier.
Returns
found venue object or null Venue.

◆ getZoneById:

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

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

Parameters
idzone unique identifier.
Returns
found zone object or null Zone.

◆ globalToLocal:

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

Method 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
globalPointpoint in WGS84 coordinates GlobalPoint
Returns
point in metrics coordinates LocationPoint.

◆ localToGlobal:

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

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

Parameters
localPointpoint in metrics coordinates LocationPoint
Returns
point in WGS84 coordinates GlobalPoint.

Property Documentation

◆ altitude

- (NSNumber*) altitude
readnonatomicassign

sublocation's altitude in meters if specified.

Definition at line 106 of file NCSublocation.h.

◆ azimuth

- (float) azimuth
readnonatomicassign

sublocation's azimuth in degrees clockwise.

Definition at line 111 of file NCSublocation.h.

◆ beacons

- (NSArray<NCBeacon *>*) beacons
readnonatomicassign

List of beacons, attached to this sublocation Beacon.

Definition at line 131 of file NCSublocation.h.

◆ eddystones

- (NSArray<NCEddystone *>*) eddystones
readnonatomicassign

List of eddystones, attached to this sublocation Eddystone.

Definition at line 136 of file NCSublocation.h.

◆ externalId

- (NSString*) externalId
readnonatomicassign

sublocation's externalId.

Definition at line 126 of file NCSublocation.h.

◆ height

- (float) height
readnonatomicassign

sublocation's height in meters.

Definition at line 101 of file NCSublocation.h.

◆ id

- (int32_t) id
readnonatomicassign

sublocation's identifier.

Definition at line 81 of file NCSublocation.h.

◆ levelId

- (NSString*) levelId
readnonatomicassign

sublocation's levelId.

Definition at line 121 of file NCSublocation.h.

◆ location

- (int32_t) location
readnonatomicassign

location's identifier to which the sublocation belongs.

Definition at line 86 of file NCSublocation.h.

◆ name

- (NSString*) name
readnonatomicassign

sublocation's name.

Definition at line 91 of file NCSublocation.h.

◆ originPoint

- (NCGlobalPoint*) originPoint
readnonatomicassign

sublocation's center point in WGS84 coordinates GlobalPoint.

Definition at line 116 of file NCSublocation.h.

◆ venues

- (NSArray<NCVenue *>*) venues
readnonatomicassign

List of venues, attached to this sublocation Venue.

Definition at line 152 of file NCSublocation.h.

◆ width

- (float) width
readnonatomicassign

sublocation's width in meters.

Definition at line 96 of file NCSublocation.h.

◆ wifis

- (NSArray<NCWifi *>*) wifis
readnonatomicassign

List of wifis, attached to this sublocation Wifi.

Definition at line 141 of file NCSublocation.h.

◆ zones

- (NSArray<NCZone *>*) zones
readnonatomicassign

List of zones, attached to this sublocation Zone.

Definition at line 157 of file NCSublocation.h.


The documentation for this class was generated from the following file: