Release-19032025 (#19)

Co-authored-by: Pavel Tychinin <ptychinin@Pavels-MacBook-Pro.local>

Author: PavelTychinin

CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 `navigine.framework` adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.5.4](https://github.com/Navigine/navigine_ios_framework/releases/tag/v.2.5.4) / 2025-03-19
+* Fixed Metal DEPTH_TEST
+* Fixed navigation algorighms
+* Improved ssl certificate verification
+
 ## [2.5.3](https://github.com/Navigine/navigine_ios_framework/releases/tag/v.2.5.3) / 2024-11-06
 * Migrated to Metal
 * Improved geolib

Frameworks/Navigine.xcframework/Info.plist

@@ -8,32 +8,32 @@
 			<key>BinaryPath</key>
 			<string>Navigine.framework/Navigine</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>Navigine.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
-				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
 		</dict>
 		<dict>
 			<key>BinaryPath</key>
 			<string>Navigine.framework/Navigine</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>Navigine.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
+				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>

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

@@ -1,16 +1,37 @@
 #import <Foundation/Foundation.h>
 
-/** Describe animation functions */
+/**
+ * @file NCAnimationType.h
+ * @brief @copybrief NCAnimationType
+ */
+/**
+ * @ingroup navigine_objc_classes
+ * @ingroup navigine_objc_location_view
+ * @brief Enum described animation functions.
+ *
+ * Referenced from @see CircleMapObject "CircleMapObject", @see IconMapObject "IconMapObject", @see FlatIconMapObject "FlatIconMapObject", @see LocationWindow "LocationWindow".
+ *
+ */
 typedef NS_ENUM(NSInteger, NCAnimationType)
 {
-    /** Disable animation */
+    /**
+     * @brief disable animation
+     */
     NCAnimationTypeNone,
-    /** Animation according to formula `f(t) = t`. */
+    /**
+     * @brief animation according to formula `f(t) = t`.
+     */
     NCAnimationTypeLinear,
-    /** Animation according to formula `f(t) = (-2 * t + 3) * t * t`. */
+    /**
+     * @brief animation according to formula `f(t) = (-2 * t + 3) * t * t`.
+     */
     NCAnimationTypeCubic,
-    /** Animation according to formula `f(t) = (6 * t * t - 15 * t + 10) * t * t * t`. */
+    /**
+     * @brief animation according to formula `f(t) = (6 * t * t - 15 * t + 10) * t * t * t`.
+     */
     NCAnimationTypeQuint,
-    /** Animation according to formula `f(t) = 0.5 - 0.5 * cos(PI * t)`. */
+    /**
+     * @brief animation according to formula `f(t) = 0.5 - 0.5 * cos(PI * t)`.
+     */
     NCAnimationTypeSine,
 };

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

@@ -5,26 +5,37 @@
 
 
 /**
- * Class is used to handle events coming from routing session (@see RouteSession)
- * Methods invoked in UI
+ * @file NCAsyncRouteListener.h
+ * @brief @copybrief NCAsyncRouteListener-p
+ */
+/**
+ * @ingroup navigine_objc_classes
+ * @ingroup navigine_objc_listeners
+ * @brief Class provides a callback to be invoked when @see RouteSession "RouteSession"
+ * handle changed/advanced events.
+ *
+ * Referenced from @see AsyncRouteManager "AsyncRouteManager" @see RouteSession "RouteSession".
+ * @note The callback is invoked in the UI thread.
  */
 DEFAULT_EXPORT_ATTRIBUTE
 @protocol NCAsyncRouteListener <NSObject>
 
 /**
- * @method onRouteChanged - called when new route was built or
+ * @brief Called when new route was built or
  *     old route was rebuilt after missing previouse one.
  *
- * @parameter currentPath - path from current postion to destination point
+ * @param currentPath @see RoutePath "RoutePath" from current postion to destination point
+ *
  */
 - (void)onRouteChanged:(nullable NCRoutePath *)currentPath;
 
 /**
- * @method onRouteAdvanced - called when user has progressed along the route
+ * @brief Called when user has progressed along the route
  *     that was built in the method `onRouteChanged`
  *
- * @parameter distance - distance from the beginning or the route (unit meters)
- * @parameter point - current location point on the route
+ * @param distance distance from the beginning or the route (unit meters)
+ * @param point current location point on the route
+ *
  */
 - (void)onRouteAdvanced:(float)distance
                   point:(nonnull NCLocationPoint *)point;

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

@@ -5,19 +5,33 @@
 @class NCRouteSession;
 
 
-/** Class is used to manage routing sessions */
+/**
+ * @file NCAsyncRouteManager.h
+ * @brief @copybrief NCAsyncRouteManager
+ */
+/**
+ * @ingroup navigine_objc_classes
+ * @ingroup navigine_objc_managers
+ * @brief Class is used for managing @see RouteSession "RouteSession"s
+ *
+ * Referenced from @see NavigineSdk "NavigineSdk".
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCAsyncRouteManager : NSObject
 
 /**
- * Method is used to create routing session
- * @param wayPoint - destination point
- * @param routeOptions - params of routing session (@see RouteSession class)
+ * @brief Method is used to create routing session
+ * @param wayPoint destination point.
+ * @param routeOptions params of @see RouteSession "RouteSession".
+ * @return @see RouteSession "RouteSession" instance.
  */
 - (nullable NCRouteSession *)createRouteSession:(nonnull NCLocationPoint *)wayPoint
                                    routeOptions:(nonnull NCRouteOptions *)routeOptions;
 
-/** Method is used to cancel routing session */
+/**
+ * @brief Method is used to cancel routing session
+ * @param session @see RouteSession "RouteSession" object to cancel.
+ */
 - (void)cancelRouteSession:(nullable NCRouteSession *)session;
 
 @end

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

@@ -5,38 +5,65 @@
 
 
 /**
+ * @file NCBeacon.h
+ * @brief @copybrief NCBeacon
+ */
+/**
+ * @ingroup navigine_objc_classes
+ * @ingroup navigine_objc_location_elements
+ * @ingroup navigine_objc_transmitters
+ * @brief Class is used for storing <a href="https://en.wikipedia.org/wiki/IBeacon">iBeacon</a>.
  *
- * Object describing iBeacon transmitter.
+ * Referenced from @see Sublocation "Sublocation".
  *
  */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCBeacon : NSObject
 
-/** Metrics coordinate of iBeacon position (@see Point). */
+/**
+ * @brief beacon's X and Y coordinates in meters as @see Point "Point" (within the sublocation).
+ */
 @property (nonatomic, nonnull, readonly) NCPoint * point;
 
-/** Unique location identifier of iBeacon position. */
+/**
+ * @brief beacon's location identifier.
+ */
 @property (nonatomic, readonly) int32_t locationId;
 
-/** Unique sublocation identifier of iBeacon position. */
+/**
+ * @brief beacon's sublocation identifier.
+ */
 @property (nonatomic, readonly) int32_t sublocationId;
 
-/** iBeacon name. */
+/**
+ * @brief beacon's name.
+ */
 @property (nonatomic, nonnull, readonly) NSString * name;
 
-/** iBeacon major. Values [1-65535] */
+/**
+ * @brief beacon's major. Values [1-65535]
+ */
 @property (nonatomic, readonly) int32_t major;
 
-/** iBeacon minor. Values [1-65535] */
+/**
+ * @brief beacon's minor. Values [1-65535]
+ */
 @property (nonatomic, readonly) int32_t minor;
 
-/** iBeacon uuid. Format [XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX] */
+/**
+ * @brief beacon's uuid. Format [XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX]
+ */
 @property (nonatomic, nonnull, readonly) NSString * uuid;
 
-/** iBeacon power. If exsists. */
+/**
+ * iBeacon power. If exsists.
+ * @brief beacon's power.
+ */
 @property (nonatomic, nullable, readonly) NSNumber * power;
 
-/** iBeacon status. (@see TransmitterStatus) */
+/**
+ * @brief iBeacon status. @see TransmitterStatus "TransmitterStatus"
+ */
 @property (nonatomic, readonly) NCTransmitterStatus status;
 
 @end

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

@@ -1,15 +1,27 @@
 #import "NCExport.h"
 #import <Foundation/Foundation.h>
 
+/**
+ * @file NCBeaconProximityEntry.h
+ * @brief @copybrief NCBeaconProximityEntry
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCBeaconProximityEntry : NSObject
+
+/** 
+ * @brief Default constructor for class NCBeaconProximityEntry 
+ */
 - (nonnull instancetype)initWithMajor:(int32_t)major
                                 minor:(int32_t)minor
                                  uuid:(nonnull NSString *)uuid
                                  rssi:(float)rssi
                             frequency:(float)frequency
                               quality:(float)quality
                              distance:(nullable NSNumber *)distance;
+
+/** 
+ * @brief Factory method for class NCBeaconProximityEntry 
+ */
 + (nonnull instancetype)beaconProximityEntryWithMajor:(int32_t)major
                                                 minor:(int32_t)minor
                                                  uuid:(nonnull NSString *)uuid

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

@@ -3,6 +3,10 @@
 @protocol NCBeaconProximityEstimatorListener;
 
 
+/**
+ * @file NCBeaconProximityEstimator.h
+ * @brief @copybrief NCBeaconProximityEstimator
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCBeaconProximityEstimator : NSObject
 

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

@@ -3,6 +3,10 @@
 #import <Foundation/Foundation.h>
 
 
+/**
+ * @file NCBeaconProximityEstimatorListener.h
+ * @brief @copybrief NCBeaconProximityEstimatorListener-p
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @protocol NCBeaconProximityEstimatorListener <NSObject>
 

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

@@ -5,11 +5,35 @@
 @class NCBitmapRegionDecoder;
 
 
+/**
+ * @file NCBitmapRegionDecoder.h
+ * @brief @copybrief NCBitmapRegionDecoder
+ */
+/**
+ * @ingroup navigine_objc_classes
+ * @ingroup navigine_objc_secondary_classes
+ * @brief Сlass is used for getting bitmaps (png, jpg, svg) from byte array.
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCBitmapRegionDecoder : NSObject
 
+/**
+ *
+ * @brief Method is used to create instance of BitmapRegionDecoder
+ * @param data raw image data (could be raw svg string)
+ * @return nstance of decoder, which could be used for decoding byte array to bitmap.
+ *
+ */
 + (nullable NCBitmapRegionDecoder *)newInstance:(nonnull NSData *)data;
 
+/**
+ *
+ * @brief Method is used to decode rectangle region in the image specified by rect.
+ * @param rect area to render @see Rectangle "Rectangle"
+ * @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
+ *
+ */
 - (nullable UIImage *)decodeRegion:(nonnull NCRectangle *)rect
                         sampleSize:(int32_t)sampleSize;