Release 20250825

Author: Pavel Tychinin

CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 `navigine.framework` adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.6.0](https://github.com/Navigine/navigine_ios_framework/releases/tag/v.2.6.0) / 2025-08-25
+* Adaptive image rendering
+* Improved onRouteChanged method
+
 ## [2.5.7](https://github.com/Navigine/navigine_ios_framework/releases/tag/v.2.5.7) / 2025-05-27
 * Added NCPolygonMapObject
 * Added selectMapFeature/deselectMapFeature/deselectAllMapFeatures/getSelectedMapFeatures

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCAnimationType.h

@@ -9,7 +9,7 @@
  * @ingroup navigine_objc_location_view
  * @brief Enum described animation functions.
  *
- * Referenced from @see CircleMapObject "CircleMapObject", @see IconMapObject "IconMapObject", @see FlatIconMapObject "FlatIconMapObject", @see LocationWindow "LocationWindow".
+ * Referenced from @see CircleMapObject "CircleMapObject", @see IconMapObject "IconMapObject", @see LocationWindow "LocationWindow".
  *
  */
 typedef NS_ENUM(NSInteger, NCAnimationType)

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCAsyncRouteListener.h

@@ -1,5 +1,6 @@
 #import "NCExport.h"
 #import "NCLocationPoint.h"
+#import "NCRouteStatus.h"
 #import <Foundation/Foundation.h>
 @class NCRoutePath;
 
@@ -24,10 +25,20 @@ DEFAULT_EXPORT_ATTRIBUTE
  * @brief Called when new route was built or
  *     old route was rebuilt after missing previouse one.
  *
- * @param currentPath @see RoutePath "RoutePath" from current postion to destination point
+ * @param status @see RouteStatus "RouteStatus" indicating the current router state
+ * @param currentPath @see RoutePath "RoutePath" from current postion to destination point (null if status is not new_route)
+ *
+ *
+ * Swift code snippet:
+ * @snippet AsyncRouteManagerExample.swift swift_AsyncRouteListener_onRouteChanged
+ *
+ * Objective C code snippet:
+ * @snippet AsyncRouteManagerExample.m objc_AsyncRouteListener_onRouteChanged
+ *
  *
  */
-- (void)onRouteChanged:(nullable NCRoutePath *)currentPath;
+- (void)onRouteChanged:(NCRouteStatus)status
+           currentPath:(nullable NCRoutePath *)currentPath;
 
 /**
  * @brief Called when user has progressed along the route
@@ -36,6 +47,14 @@ DEFAULT_EXPORT_ATTRIBUTE
  * @param distance distance from the beginning or the route (unit meters)
  * @param point current location point on the route
  *
+ *
+ * Swift code snippet:
+ * @snippet AsyncRouteManagerExample.swift swift_AsyncRouteListener_onRouteAdvanced
+ *
+ * Objective C code snippet:
+ * @snippet AsyncRouteManagerExample.m objc_AsyncRouteListener_onRouteAdvanced
+ *
+ *
  */
 - (void)onRouteAdvanced:(float)distance
                   point:(nonnull NCLocationPoint *)point;

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCAsyncRouteManager.h

@@ -20,17 +20,61 @@ DEFAULT_EXPORT_ATTRIBUTE
 @interface NCAsyncRouteManager : NSObject
 
 /**
- * @brief Method is used to create routing session
+ * @brief Method is used to create routing session with 'default' graph tag
  * @param wayPoint destination point.
  * @param routeOptions params of @see RouteSession "RouteSession".
  * @return @see RouteSession "RouteSession" instance.
+ *
+ *
+ * Swift code snippet:
+ * @snippet AsyncRouteManagerExample.swift swift_AsyncRouteManager_createRouteSession
+ *
+ * Objective C code snippet:
+ * @snippet AsyncRouteManagerExample.m objc_AsyncRouteManager_createRouteSession
+ *
+ *
  */
 - (nullable NCRouteSession *)createRouteSession:(nonnull NCLocationPoint *)wayPoint
                                    routeOptions:(nonnull NCRouteOptions *)routeOptions;
 
+/**
+ * @brief Creates a routing session using a specific graph tag.
+ *
+ * Initializes a @see RouteSession "RouteSession" for building a route to the given waypoint using the specified routing options and graph tag.
+ * If the specified tag is not present in the current location (i.e., the corresponding sublocation graph is not yet available),
+ * the returned @see RouteSession "RouteSession" will produce an empty route and will not trigger any listeners until the location data
+ * for that tag becomes available (e.g., after a location update).
+ *
+ * @param wayPoint Destination point for the route.
+ * @param routeOptions Routing parameters @see RouteSession "RouteSession" used to build the route.
+ * @param tag Graph tag identifying which sublocation graph to use. @see Sublocation "Sublocation"
+ * @return A RouteSession instance, which may initially be empty if the tag is not available. @see RouteSession "RouteSession"
+ *
+ *
+ * Swift code snippet:
+ * @snippet AsyncRouteManagerExample.swift swift_AsyncRouteManager_createRouteSessionWithTag
+ *
+ * Objective C code snippet:
+ * @snippet AsyncRouteManagerExample.m objc_AsyncRouteManager_createRouteSessionWithTag
+ *
+ *
+ */
+- (nullable NCRouteSession *)createRouteSessionWithTag:(nonnull NCLocationPoint *)wayPoint
+                                          routeOptions:(nonnull NCRouteOptions *)routeOptions
+                                                   tag:(nonnull NSString *)tag;
+
 /**
  * @brief Method is used to cancel routing session
  * @param session @see RouteSession "RouteSession" object to cancel.
+ *
+ *
+ * Swift code snippet:
+ * @snippet AsyncRouteManagerExample.swift swift_AsyncRouteManager_cancelRouteSession
+ *
+ * Objective C code snippet:
+ * @snippet AsyncRouteManagerExample.m objc_AsyncRouteManager_cancelRouteSession
+ *
+ *
  */
 - (void)cancelRouteSession:(nullable NCRouteSession *)session;
 

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCBeacon.h

@@ -22,47 +22,127 @@ DEFAULT_EXPORT_ATTRIBUTE
 
 /**
  * @brief beacon's X and Y coordinates in meters as @see Point "Point" (within the sublocation).
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getPoint
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getPoint
+ *
+ *
  */
 @property (nonatomic, nonnull, readonly) NCPoint * point;
 
 /**
  * @brief beacon's location identifier.
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getLocationId
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getLocationId
+ *
+ *
  */
 @property (nonatomic, readonly) int32_t locationId;
 
 /**
  * @brief beacon's sublocation identifier.
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getSublocationId
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getSublocationId
+ *
+ *
  */
 @property (nonatomic, readonly) int32_t sublocationId;
 
 /**
  * @brief beacon's name.
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getName
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getName
+ *
+ *
  */
 @property (nonatomic, nonnull, readonly) NSString * name;
 
 /**
  * @brief beacon's major. Values [1-65535]
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getMajor
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getMajor
+ *
+ *
  */
 @property (nonatomic, readonly) int32_t major;
 
 /**
  * @brief beacon's minor. Values [1-65535]
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getMinor
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getMinor
+ *
+ *
  */
 @property (nonatomic, readonly) int32_t minor;
 
 /**
  * @brief beacon's uuid. Format [XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX]
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getUuid
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getUuid
+ *
+ *
  */
 @property (nonatomic, nonnull, readonly) NSString * uuid;
 
 /**
- * iBeacon power. If exsists.
  * @brief beacon's power.
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getPower
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getPower
+ *
+ *
  */
 @property (nonatomic, nullable, readonly) NSNumber * power;
 
 /**
  * @brief iBeacon status. @see TransmitterStatus "TransmitterStatus"
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Beacon_getStatus
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Beacon_getStatus
+ *
+ *
  */
 @property (nonatomic, readonly) NCTransmitterStatus status;
 

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCBitmapRegionDecoder.h

@@ -23,6 +23,14 @@ DEFAULT_EXPORT_ATTRIBUTE
  * @param data raw image data (could be raw svg string)
  * @return nstance of decoder, which could be used for decoding byte array to bitmap.
  *
+ *
+ * Swift code snippet:
+ * @snippet BitmapRegionDecoderExample.swift swift_BitmapRegionDecoder_newInstance
+ *
+ * Objective C code snippet:
+ * @snippet BitmapRegionDecoderExample.m objc_BitmapRegionDecoder_newInstance
+ *
+ *
  */
 + (nullable NCBitmapRegionDecoder *)newInstance:(nonnull NSData *)data;
 
@@ -33,8 +41,16 @@ DEFAULT_EXPORT_ATTRIBUTE
  * @param sampleSize if set to a value > 1, requests the decoder to subsample the original image, returning a smaller image to save memory.
  * @return constructed bitmap
  *
+ *
+ * Swift code snippet:
+ * @snippet BitmapRegionDecoderExample.swift swift_BitmapRegionDecoder_decodeRegion
+ *
+ * Objective C code snippet:
+ * @snippet BitmapRegionDecoderExample.m objc_BitmapRegionDecoder_decodeRegion
+ *
+ *
  */
 - (nullable UIImage *)decodeRegion:(nonnull NCRectangle *)rect
-                        sampleSize:(int32_t)sampleSize;
+                        sampleSize:(float)sampleSize;
 
 @end

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCCamera.h

@@ -12,6 +12,15 @@
  * @brief Class describing position of the camera.
  *
  * Referenced from @see LocationWindow "LocationWindow".
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationWindowCameraExample.swift swift_Camera_constructor
+ *
+ * Objective C code snippet:
+ * @snippet LocationWindowCameraExample.m objc_Camera_constructor
+ *
+ *
  */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCCamera : NSObject

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCCameraListener.h

@@ -26,6 +26,14 @@ DEFAULT_EXPORT_ATTRIBUTE
  * @param finished true if the camera finished moving, false otherwise.
  *      If a movement is cancelled then reason represents initiator of cancellation.
  *
+ *
+ * Swift code snippet:
+ * @snippet LocationWindowCameraExample.swift swift_CameraListener_onCameraPositionChanged
+ *
+ * Objective C code snippet:
+ * @snippet LocationWindowCameraExample.m objc_CameraListener_onCameraPositionChanged
+ *
+ *
  */
 - (void)onCameraPositionChanged:(NCCameraUpdateReason)reason
                        finished:(BOOL)finished;

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCCapType.h

@@ -0,0 +1,30 @@
+#import <Foundation/Foundation.h>
+
+/**
+ * @file NCCapType.h
+ * @brief @copybrief NCCapType
+ */
+/**
+ * @ingroup navigine_objc_classes
+ * @ingroup navigine_objc_location_view
+ *
+ * @brief Enum defining the type of cap for polyline ends.
+ *
+ * Referenced from @see PolylineMapObject "PolylineMapObject".
+ *
+ */
+typedef NS_ENUM(NSInteger, NCCapType)
+{
+    /**
+     * @brief No points added to the end of the line.
+     */
+    NCCapTypeBUTT,
+    /**
+     * @brief Two points added to make a square extension.
+     */
+    NCCapTypeSQUARE,
+    /**
+     * @brief Six points added in a fan to make a round cap.
+     */
+    NCCapTypeROUND,
+};

Frameworks/Navigine.xcframework/ios-arm64/Navigine.framework/Headers/NCCategory.h

@@ -31,16 +31,43 @@ DEFAULT_EXPORT_ATTRIBUTE
 
 /**
  * @brief category identifier.
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Category_getId
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Category_getId
+ *
+ *
  */
 @property (nonatomic, readonly) int32_t id;
 
 /**
  * @brief category name.
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Category_getName
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Category_getName
+ *
+ *
  */
 @property (nonatomic, readonly, nonnull) NSString * name;
 
 /**
  * @brief image source. If presented.
+ *
+ *
+ * Swift code snippet:
+ * @snippet LocationManagerExample.swift swift_Category_getImageUrl
+ *
+ * Objective C code snippet:
+ * @snippet LocationManagerExample.m objc_Category_getImageUrl
+ *
+ *
  */
 @property (nonatomic, readonly, nullable) NSString * imageUrl;