Dynamic settings of the map. More...

#import <NMSMapSettings.h>

Inheritance diagram for NMSMapSettings:

Class Methods
(instancetype)	+ mapSettings
	Builds and returns the default `NMSSettings`. More...

Properties
NMSMapSettingsType	type
	The map settings type `NMSMapSettingsTypeAdvanced` when the logged user has at least one valid subcription, `NMSMapSettingsTypeStandard` otherwise. More...

NMSMapMode	mapMode
	The map mode. More...

NMSDepthUnit	depthUnit
	The depth unit. `NMSDepthUnitMeters` by default. More...

NMSSpeedUnit	speedUnit
	The speed unit. `NMSSpeedUnitKPH` by default. More...

NMSDistanceUnit	distanceUnit
	The distance unit. `NMSDistanceUnitKilometers` by default. More...

NMSDepthContoursDensity	depthContoursDensity
	The density of the depth contours. Very High by default. More...

BOOL	easyViewEnabled
	Enable the easy view. All the labels and icons will be drawn bigger. NO by default. More...

int	depthContours
	The depth contours visibility threshold in the current depth unit. Will be ignored when `depthContoursAll` is enabled Can't be lower then `depthAreas` or `fishingAreaRangeLowerMin`. It is automatically aligned when `depthAreas` or `fishingAreaRangeLowerMin` change. More...

int	depthContoursMin
	The current min valid value for `depthContours` It is automatically aligned when `depthAreas` or `fishingAreaRangeLowerMin` change. More...

int	depthContoursMax
	The current max valid value for `depthContours`. More...

BOOL	depthContoursAll
	Enable all the depth contours. When enabled `depthContours` will be ignored. YES by default. More...

int	depthAreas
	The depth areas visibility threshold in the current depth unit. 20 by default (in the default depth unit) Can't be lower then `shallowDepthLimit`. It is automatically aligned when `shallowDepthLimit` change. More...

int	depthAreasMin
	The current min valid value for `depthAreas` It is automatically aligned when `shallowDepthLimit` change. More...

int	depthAreasMax
	The current max valid value for `depthAreas`. More...

int	poolWaterLevel
	The water level in the current depth unit. 0 by default. More...

int	poolWaterLevelMin
	The current min valid value for `poolWaterLevel`. More...

int	poolWaterLevelMax
	The current max valid value for `poolWaterLevel`. More...

int	shallowDepthLimit
	The shallow areas visibility threshold in the current depth unit. 0 by default Advanced map setting. Can be modified only if a `type` is `NMSMapSettingsTypeAdvanced`. Will affect `depthAreasMin`, `fishingAreaRangeLowerMin` and `fishingAreaRangeUpperMin`. More...

int	shallowDepthLimitMin
	The current min valid value for `shallowDepthLimit`. More...

int	shallowDepthLimitMax
	The current max valid value for `shallowDepthLimit`. More...

BOOL	seabedAreaEnabled
	Enable the couloured Seabed Area. NO by default Advanced map setting. Can be modified only if a `type` is `NMSMapSettingsTypeAdvanced`. More...

BOOL	fishingModeEnabled
	Enable the Fishing Mode. NO by default Advanced map setting. Can be modified only if a `type` is `NMSMapSettingsTypeAdvanced`. More...

int	fishingAreaRangeLower
	The lower depth value of the fishing area range. Needs Fishing Mode enabled. 0 by default Advanced map setting. Can be modified only if a `type` is `NMSMapSettingsTypeAdvanced`. Can't be lower then `shallowDepthLimit`. It is automatically aligned when `shallowDepthLimit` change. More...

int	fishingAreaRangeLowerMin
	The current min valid value for `fishingAreaRangeLower` It is automatically aligned when `shallowDepthLimit` change. More...

int	fishingAreaRangeLowerMax
	The current max valid value for `fishingAreaRangeLower`. More...

int	fishingAreaRangeUpper
	The upper depth value of the fishing area range. Needs Fishing Mode enabled. 0 by default Advanced map setting. Can be modified only if a `type` is `NMSMapSettingsTypeAdvanced`. More...

int	fishingAreaRangeUpperMin
	The current min valid value for `fishingAreaRangeUpper`. More...

int	fishingAreaRangeUpperMax
	The current max valid value for `fishingAreaRangeUpper`. More...

Detailed Description

Dynamic settings of the map.

Definition at line 12 of file NMSMapSettings.h.

Method Documentation

◆ mapSettings()

+ (instancetype) mapSettings

Builds and returns the default NMSSettings.

Returns: the NMSSettings object, nil if NavionicsMobileServices is not initialized.

Property Documentation

◆ depthAreas

- (int) depthAreas

readnonatomicassign

The depth areas visibility threshold in the current depth unit. 20 by default (in the default depth unit) Can't be lower then shallowDepthLimit. It is automatically aligned when shallowDepthLimit change.

Definition at line 64 of file NMSMapSettings.h.

◆ depthAreasMax

- (int) depthAreasMax

readnonatomicassign

The current max valid value for depthAreas.

Definition at line 72 of file NMSMapSettings.h.

◆ depthAreasMin

- (int) depthAreasMin

readnonatomicassign

The current min valid value for depthAreas It is automatically aligned when shallowDepthLimit change.

Definition at line 69 of file NMSMapSettings.h.

◆ depthContours

- (int) depthContours

readnonatomicassign

The depth contours visibility threshold in the current depth unit. Will be ignored when depthContoursAll is enabled Can't be lower then depthAreas or fishingAreaRangeLowerMin. It is automatically aligned when depthAreas or fishingAreaRangeLowerMin change.

Definition at line 47 of file NMSMapSettings.h.

◆ depthContoursAll

- (BOOL) depthContoursAll

readnonatomicassign

Enable all the depth contours. When enabled depthContours will be ignored. YES by default.

Definition at line 58 of file NMSMapSettings.h.

◆ depthContoursDensity

- (NMSDepthContoursDensity) depthContoursDensity

readnonatomicassign

The density of the depth contours. Very High by default.

Definition at line 38 of file NMSMapSettings.h.

◆ depthContoursMax

- (int) depthContoursMax

readnonatomicassign

The current max valid value for depthContours.

Definition at line 55 of file NMSMapSettings.h.

◆ depthContoursMin

- (int) depthContoursMin

readnonatomicassign

The current min valid value for depthContours It is automatically aligned when depthAreas or fishingAreaRangeLowerMin change.

Definition at line 52 of file NMSMapSettings.h.

◆ depthUnit

- (NMSDepthUnit) depthUnit

readnonatomicassign

The depth unit. NMSDepthUnitMeters by default.

Definition at line 29 of file NMSMapSettings.h.

◆ distanceUnit

- (NMSDistanceUnit) distanceUnit

readnonatomicassign

The distance unit. NMSDistanceUnitKilometers by default.

Definition at line 35 of file NMSMapSettings.h.

◆ easyViewEnabled

- (BOOL) easyViewEnabled

readnonatomicassign

Enable the easy view. All the labels and icons will be drawn bigger. NO by default.

Definition at line 41 of file NMSMapSettings.h.

◆ fishingAreaRangeLower

- (int) fishingAreaRangeLower

readnonatomicassign

The lower depth value of the fishing area range. Needs Fishing Mode enabled. 0 by default Advanced map setting. Can be modified only if a type is NMSMapSettingsTypeAdvanced. Can't be lower then shallowDepthLimit. It is automatically aligned when shallowDepthLimit change.

Definition at line 110 of file NMSMapSettings.h.

◆ fishingAreaRangeLowerMax

- (int) fishingAreaRangeLowerMax

readnonatomicassign

The current max valid value for fishingAreaRangeLower.

Definition at line 118 of file NMSMapSettings.h.

◆ fishingAreaRangeLowerMin

- (int) fishingAreaRangeLowerMin

readnonatomicassign

The current min valid value for fishingAreaRangeLower It is automatically aligned when shallowDepthLimit change.

Definition at line 115 of file NMSMapSettings.h.

◆ fishingAreaRangeUpper

- (int) fishingAreaRangeUpper

readnonatomicassign

The upper depth value of the fishing area range. Needs Fishing Mode enabled. 0 by default Advanced map setting. Can be modified only if a type is NMSMapSettingsTypeAdvanced.

Definition at line 123 of file NMSMapSettings.h.

◆ fishingAreaRangeUpperMax

- (int) fishingAreaRangeUpperMax

readnonatomicassign

The current max valid value for fishingAreaRangeUpper.

Definition at line 129 of file NMSMapSettings.h.

◆ fishingAreaRangeUpperMin

- (int) fishingAreaRangeUpperMin

readnonatomicassign

The current min valid value for fishingAreaRangeUpper.

Definition at line 126 of file NMSMapSettings.h.

◆ fishingModeEnabled

- (BOOL) fishingModeEnabled

readnonatomicassign

Enable the Fishing Mode. NO by default Advanced map setting. Can be modified only if a type is NMSMapSettingsTypeAdvanced.

Definition at line 103 of file NMSMapSettings.h.

◆ mapMode

- (NMSMapMode) mapMode

readnonatomicassign

The map mode.

Definition at line 26 of file NMSMapSettings.h.

◆ poolWaterLevel

- (int) poolWaterLevel

readnonatomicassign

The water level in the current depth unit. 0 by default.

Definition at line 75 of file NMSMapSettings.h.

◆ poolWaterLevelMax

- (int) poolWaterLevelMax

readnonatomicassign

The current max valid value for poolWaterLevel.

Definition at line 81 of file NMSMapSettings.h.

◆ poolWaterLevelMin

- (int) poolWaterLevelMin

readnonatomicassign

The current min valid value for poolWaterLevel.

Definition at line 78 of file NMSMapSettings.h.

◆ seabedAreaEnabled

- (BOOL) seabedAreaEnabled

readnonatomicassign

Enable the couloured Seabed Area. NO by default Advanced map setting. Can be modified only if a type is NMSMapSettingsTypeAdvanced.

Definition at line 98 of file NMSMapSettings.h.

◆ shallowDepthLimit

- (int) shallowDepthLimit

readnonatomicassign

The shallow areas visibility threshold in the current depth unit. 0 by default Advanced map setting. Can be modified only if a type is NMSMapSettingsTypeAdvanced. Will affect depthAreasMin, fishingAreaRangeLowerMin and fishingAreaRangeUpperMin.

Definition at line 87 of file NMSMapSettings.h.

◆ shallowDepthLimitMax

- (int) shallowDepthLimitMax

readnonatomicassign

The current max valid value for shallowDepthLimit.

Definition at line 93 of file NMSMapSettings.h.

◆ shallowDepthLimitMin

- (int) shallowDepthLimitMin

readnonatomicassign

The current min valid value for shallowDepthLimit.

Definition at line 90 of file NMSMapSettings.h.

◆ speedUnit

- (NMSSpeedUnit) speedUnit

readnonatomicassign

The speed unit. NMSSpeedUnitKPH by default.

Definition at line 32 of file NMSMapSettings.h.

◆ type

- (NMSMapSettingsType) type

readnonatomicassign

The map settings type NMSMapSettingsTypeAdvanced when the logged user has at least one valid subcription, NMSMapSettingsTypeStandard otherwise.

Definition at line 23 of file NMSMapSettings.h.

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

/Users/jenkins/workspace/mobilesdk-ios/iOS/Deployment/NavionicsMobileSDK.framework/Headers/NMSMapSettings.h

Class Methods

Properties

Detailed Description

Method Documentation

◆ mapSettings()

Property Documentation

◆ depthAreas

◆ depthAreasMax

◆ depthAreasMin

◆ depthContours

◆ depthContoursAll

◆ depthContoursDensity

◆ depthContoursMax

◆ depthContoursMin

◆ depthUnit

◆ distanceUnit

◆ easyViewEnabled

◆ fishingAreaRangeLower

◆ fishingAreaRangeLowerMax

◆ fishingAreaRangeLowerMin

◆ fishingAreaRangeUpper

◆ fishingAreaRangeUpperMax

◆ fishingAreaRangeUpperMin

◆ fishingModeEnabled

◆ mapMode

◆ poolWaterLevel

◆ poolWaterLevelMax

◆ poolWaterLevelMin

◆ seabedAreaEnabled

◆ shallowDepthLimit

◆ shallowDepthLimitMax

◆ shallowDepthLimitMin

◆ speedUnit

◆ type