Release-20240730

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.2](https://github.com/Navigine/navigine_ios_framework/releases/tag/v.2.5.2) / 2024-07-30
+* Fixed ZoneManager behavior
+* Added ZoneEvent class
+* Changed ZoneListener api
+
 ## [2.5.1](https://github.com/Navigine/navigine_ios_framework/releases/tag/v.2.5.1) / 2024-05-21
 * Fixed camera behavior
 * Improved navigation algorithms

Frameworks/Navigine.xcframework/Info.plist

@@ -5,31 +5,35 @@
 	<key>AvailableLibraries</key>
 	<array>
 		<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>
 		<dict>
+			<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>
 	</array>
 	<key>CFBundlePackageType</key>

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

@@ -1,13 +1,16 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from animation_type.djinni
-
 #import <Foundation/Foundation.h>
 
+/** Describe animation functions */
 typedef NS_ENUM(NSInteger, NCAnimationType)
 {
+    /** Disable animation */
     NCAnimationTypeNone,
+    /** Animation according to formula `f(t) = t`. */
     NCAnimationTypeLinear,
+    /** 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`. */
     NCAnimationTypeQuint,
+    /** Animation according to formula `f(t) = 0.5 - 0.5 * cos(PI * t)`. */
     NCAnimationTypeSine,
 };

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

@@ -1,17 +1,31 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from route_session.djinni
-
 #import "NCExport.h"
 #import "NCLocationPoint.h"
 #import <Foundation/Foundation.h>
 @class NCRoutePath;
 
 
+/**
+ * Class is used to handle events coming from routing session (@see RouteSession)
+ * Methods invoked in UI
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @protocol NCAsyncRouteListener <NSObject>
 
+/**
+ * @method onRouteChanged - called when new route was built or
+ *     old route was rebuilt after missing previouse one.
+ *
+ * @parameter currentPath - path from current postion to destination point
+ */
 - (void)onRouteChanged:(nullable NCRoutePath *)currentPath;
 
+/**
+ * @method onRouteAdvanced - 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
+ */
 - (void)onRouteAdvanced:(float)distance
                   point:(nonnull NCLocationPoint *)point;
 

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

@@ -1,19 +1,23 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from async_route_manager.djinni
-
 #import "NCExport.h"
 #import "NCLocationPoint.h"
 #import "NCRouteOptions.h"
 #import <Foundation/Foundation.h>
 @class NCRouteSession;
 
 
+/** Class is used to manage routing sessions */
 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)
+ */
 - (nullable NCRouteSession *)createRouteSession:(nonnull NCLocationPoint *)wayPoint
                                    routeOptions:(nonnull NCRouteOptions *)routeOptions;
 
+/** Method is used to cancel routing session */
 - (void)cancelRouteSession:(nullable NCRouteSession *)session;
 
 @end

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

@@ -1,31 +1,42 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from beacon.djinni
-
 #import "NCExport.h"
 #import "NCPoint.h"
 #import "NCTransmitterStatus.h"
 #import <Foundation/Foundation.h>
 
 
+/**
+ *
+ * Object describing iBeacon transmitter.
+ *
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCBeacon : NSObject
 
+/** Metrics coordinate of iBeacon position (@see Point). */
 @property (nonatomic, nonnull, readonly) NCPoint * point;
 
+/** Unique location identifier of iBeacon position. */
 @property (nonatomic, readonly) int32_t locationId;
 
+/** Unique sublocation identifier of iBeacon position. */
 @property (nonatomic, readonly) int32_t sublocationId;
 
+/** iBeacon name. */
 @property (nonatomic, nonnull, readonly) NSString * name;
 
+/** iBeacon major. Values [1-65535] */
 @property (nonatomic, readonly) int32_t major;
 
+/** iBeacon minor. Values [1-65535] */
 @property (nonatomic, readonly) int32_t minor;
 
+/** iBeacon uuid. Format [XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX] */
 @property (nonatomic, nonnull, readonly) NSString * uuid;
 
+/** iBeacon power. If exsists. */
 @property (nonatomic, nullable, readonly) NSNumber * power;
 
+/** iBeacon status. (@see TransmitterStatus) */
 @property (nonatomic, readonly) NCTransmitterStatus status;
 
 @end

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

@@ -1,6 +1,3 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from beacon_proximity_estimator.djinni
-
 #import "NCExport.h"
 #import <Foundation/Foundation.h>
 

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

@@ -1,6 +1,3 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from beacon_proximity_estimator.djinni
-
 #import "NCExport.h"
 #import <Foundation/Foundation.h>
 @protocol NCBeaconProximityEstimatorListener;

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

@@ -1,6 +1,3 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from beacon_proximity_estimator.djinni
-
 #import "NCBeaconProximityEntry.h"
 #import "NCExport.h"
 #import <Foundation/Foundation.h>

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

@@ -1,6 +1,3 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from bitmap_region_decoder.djinni
-
 #import "NCExport.h"
 #import "NCRectangle.h"
 #import <Foundation/Foundation.h>

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

@@ -1,10 +1,8 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from camera.djinni
-
 #import "NCExport.h"
 #import "NCPoint.h"
 #import <Foundation/Foundation.h>
 
+/** Class describing position of the camera. */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCCamera : NSObject
 - (nonnull instancetype)initWithPoint:(nonnull NCPoint *)point
@@ -14,10 +12,13 @@ DEFAULT_EXPORT_ATTRIBUTE
                                    zoom:(float)zoom
                                rotation:(float)rotation;
 
+/** Point the camera is looking at. */
 @property (nonatomic, readonly, nonnull) NCPoint * point;
 
+/** Zoom level. */
 @property (nonatomic, readonly) float zoom;
 
+/** Angle between `Location North` (top of the image) and the direction of interest on the view plane, in degrees in the range [0, 360). */
 @property (nonatomic, readonly) float rotation;
 
 @end

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

@@ -1,10 +1,8 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from location_window.djinni
-
 #import "NCExport.h"
 #import <Foundation/Foundation.h>
 
 
 
+/** Called when the move if finished. */
 typedef void (^NCCameraCallback)(BOOL completed);
 

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

@@ -1,14 +1,20 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from camera_listener.djinni
-
 #import "NCCameraUpdateReason.h"
 #import "NCExport.h"
 #import <Foundation/Foundation.h>
 
 
+/** Class is used to listen for camera updates (@see LocationView) */
 DEFAULT_EXPORT_ATTRIBUTE
 @protocol NCCameraListener <NSObject>
 
+/**
+ *
+ * Triggered when the camera position changed.
+ * @param reason - reason of camera update.
+ * @param finished - true if the camera finished moving, false otherwise.
+ *      If a movement is cancelled then reason represents initiator of cancellation.
+ *
+ */
 - (void)onCameraPositionChanged:(NCCameraUpdateReason)reason
                        finished:(BOOL)finished;
 

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

@@ -1,10 +1,10 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from camera_listener.djinni
-
 #import <Foundation/Foundation.h>
 
+/** Reason of the camera update. */
 typedef NS_ENUM(NSInteger, NCCameraUpdateReason)
 {
+    /** User manipulation, for example: zoom, scroll, rotate, fling. */
     NCCameraUpdateReasonGestures,
+    /** Application, by calling the LocationLiew::move methods. */
     NCCameraUpdateReasonApplication,
 };

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

@@ -1,9 +1,11 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from category.djinni
-
 #import "NCExport.h"
 #import <Foundation/Foundation.h>
 
+/**
+ *
+ * Object describing category in CMS
+ *
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCCategory : NSObject
 - (nonnull instancetype)initWithId:(int32_t)id
@@ -13,10 +15,13 @@ DEFAULT_EXPORT_ATTRIBUTE
                                   name:(nonnull NSString *)name
                               imageUrl:(nullable NSString *)imageUrl;
 
+/** Category unique identifier */
 @property (nonatomic, readonly) int32_t id;
 
+/** Category name */
 @property (nonatomic, readonly, nonnull) NSString * name;
 
+/** Category image source. If presented. */
 @property (nonatomic, readonly, nullable) NSString * imageUrl;
 
 @end

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

@@ -1,27 +1,57 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from circle_map_object.djinni
-
 #import "NCAnimationType.h"
 #import "NCExport.h"
 #import "NCLocationPoint.h"
 #import "NCMapObject.h"
 #import <Foundation/Foundation.h>
 
 
+/**
+ *
+ * Object represents circle on location view.
+ *
+ */
 DEFAULT_EXPORT_ATTRIBUTE
 @interface NCCircleMapObject : NCMapObject
 
+/**
+ *
+ * Method is used to specify center of object.
+ * @param point - metrics coordinate of center (@see LocationPoint).
+ *
+ */
 - (BOOL)setPosition:(nonnull NCLocationPoint *)point;
 
+/**
+ *
+ * Method is used to move center of object with specified animation (@see LocationPoint).
+ * @param point - metrics coordinate of center (@see LocationPoint).
+ * @param duration - animation duration in seconds.
+ * @param type - animation type (@see AnimationType).
+ *
+ */
 - (BOOL)setPositionAnimated:(nonnull NCLocationPoint *)point
                    duration:(float)duration
                        type:(NCAnimationType)type;
 
+/**
+ *
+ * Method is used to specify color of object.
+ * @param red - red RGBA component.
+ * @param green - green RGBA component.
+ * @param blue - blue RGBA component.
+ * @param alpha - Opacity multiplicator. Values below 0 will be set to 0. Default: 1.
+ */
 - (BOOL)setColor:(float)red
            green:(float)green
             blue:(float)blue
            alpha:(float)alpha;
 
+/**
+ *
+ * Method is used to specify size of object.
+ * @param radius - metrics radius of circle.
+ *
+ */
 - (BOOL)setRadius:(float)radius;
 
 @end

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

@@ -1,6 +1,3 @@
-// AUTOGENERATED FILE - DO NOT MODIFY!
-// This file was generated by Djinni from debug_flag.djinni
-
 #import <Foundation/Foundation.h>
 
 typedef NS_ENUM(NSInteger, NCDebugFlag)