List of location view elements for Navigine iOS SDK. More...

Topics
	ObjectiveC Default Navigation View
	NCDefaultNavigationView and its built-in widgets (zoom, floor selector, follow me)

Classes
class	NCAttributionAlignment
	Screen placement of the OSM attribution overlay. More...

class	NCBuilding
	Interface for a building with multiple floors (Sublocations). Allows selecting the active floor directly via setActiveSublocationId. More...

protocol	<NCBuildingListener>
	Listener for outdoor scenario when camera focuses on a building or leaves it. More...

class	NCCamera
	Class describing position of the camera. More...

protocol	<NCCameraListener>
	Class is used to listen for camera updates. More...

class	NCCircleMapObject
	Represents a circle on the location view. More...

class	NCClusterMapObject
	Runtime snapshot of a visible icon cluster on the location view. More...

class	NCClusterMapObjectController
	Groups IconMapObject instances into clusters depending on zoom and proximity. More...

protocol	<NCClusterMapObjectControllerListener>
	Listener for cluster lifecycle events on ClusterMapObjectController. More...

protocol	<NCClusterMapObjectListener>
	Listener for updates of a single ClusterMapObject. More...

class	NCDefaultNavigationView
	Ready-to-use navigation view with built-in UI: “follow me” toggle and user location layer. zoom controls, floor selector, follow me toggle and user location layer. Automatically wires SDK listeners (location, sublocation, camera) and keeps widgets in sync. Use NCDefaultNavigationViewConfig to customize; config can be updated at runtime via the config property. More...

class	NCDottedPolylineMapObject
	Represents a polyline object with points placed along it on the location view. More...

class	NCGeoJsonImport
	Polygons and polylines created from one GeoJSON document. More...

class	NCGuidanceCamera
	Drives the map camera from a RouteLayer and exposes the next instruction. Does not draw the route. More...

protocol	<NCGuidanceListener>
	Guidance camera and next-instruction updates. More...

class	NCHttpTileSource
	HTTP XYZ source for outdoor vector tiles. More...

class	NCIconMapObject
	Represents an icon object on the location view. More...

class	NCImage
	class described image data in SDK More...

protocol	<NCInputListener>
	Class is used to listen for interactions with location view. More...

class	NCLocationView
	Class is used to display a Navigine location via iOS UIView. More...

class	NCLocationWindow
	Interface for interacting with the location view. More...

class	NCMapFilterCondition
	A single filter condition: property must match one of the given values. More...

class	NCMapObject
	Base interface for handling objects on the location view. More...

class	NCMapObjectPickResult
	Class is used to handle information in PickListener. More...

class	NCMbtilesTileSource
	Local MBTiles pack of outdoor vector tiles (`format=pbf` or `mvt`). More...

class	NCModelMapObject
	A 3D model map object (Wavefront OBJ) placed on the location view. More...

protocol	<NCPickListener>
	Class is used to handle for picking objects on the location view. More...

class	NCPointBatch
	One object for a cloud of screen-space arrows. More...

class	NCPointSprite
	One arrow in a point batch. Heading is degrees clockwise from north. `size` is pixels (the same unit as a symbol icon). More...

class	NCPolygonMapObject
	Represents a polygon object on the location view. More...

class	NCPolylineMapObject
	Represents a polyline object on the location view. More...

class	NCRouteEndpoint
	Route endpoint in WGS84 coordinates. More...

class	NCRouteInstruction
	Next instruction for a guidance banner. More...

class	NCRouteLayer
	Layer that renders a route on the map as traveled and remaining polylines. More...

class	NCRouteSimulator
	Walks a polyline at a constant speed for demos and guidance QA. More...

protocol	<NCRouteSimulatorListener>
	Walk progress. `onFinished` follows the last sample. More...

class	NCRouteSimulatorSample
	One sample while walking a polyline. More...

class	NCScreenRect
	Rectangle on the device screen, in screen pixels (same units as ScreenPoint). More...

protocol	<NCSublocationChangeListener>
	Class is used to listen for sublocation change events. More...

class	NCTileProvider
	Outdoor tile source: vector MVT or raster imagery. More...

class	NCTitleStyle
	Style parameters for a map object title. More...

class	NCUserLocationLayer
	Layer that automatically renders current user position (arrow and accuracy circle) on the map. Provides visibility and anchoring controls. Referenced from LocationView. More...

class	NCVisibleRegion
	Trapezoid of the current viewport on the ground, in WGS84. More...

Typedefs
typedef void(^	NCCameraCallback) (BOOL completed)
	Callback specified after the camera movement is stopped.

Enumerations
enum	NCAnimationType { NCAnimationTypeNone , NCAnimationTypeLinear , NCAnimationTypeCubic , NCAnimationTypeQuint , NCAnimationTypeSine }
	Enum described animation functions. More...

enum	NCAttributionHorizontalAlignment { NCAttributionHorizontalAlignmentLEFT , NCAttributionHorizontalAlignmentCENTER , NCAttributionHorizontalAlignmentRIGHT }
	Horizontal placement of the OSM attribution overlay. More...

enum	NCAttributionVerticalAlignment { NCAttributionVerticalAlignmentTOP , NCAttributionVerticalAlignmentBOTTOM }
	Vertical placement of the OSM attribution overlay. More...

enum	NCCameraUpdateReason { NCCameraUpdateReasonGestures , NCCameraUpdateReasonApplication }
	Reason of the camera update. More...

enum	NCCapType { NCCapTypeBUTT , NCCapTypeSQUARE , NCCapTypeROUND }
	Enum defining the type of cap for polyline ends. More...

enum	NCDebugFlag { NCDebugFlagNone , NCDebugFlagInfos , NCDebugFlagStats , NCDebugFlagLabels , NCDebugFlagDrawAllLabels , NCDebugFlagSelectionBuffer }
	Debug visualization flags for the map view LocationWindow. More...

enum	NCGuidanceCameraMode { NCGuidanceCameraModeFREE , NCGuidanceCameraModeFOLLOWING , NCGuidanceCameraModeOVERVIEW }
	Camera behavior while a route is shown. More...

enum	NCImageType { NCImageTypePNG , NCImageTypeSVG , NCImageTypeJPG }
	Enum described supported image types. More...

enum	NCJoinType { NCJoinTypeMITER , NCJoinTypeBEVEL , NCJoinTypeROUND }
	Enum defining the type of join for polyline segments. More...

enum	NCMapObjectType { NCMapObjectTypeICON , NCMapObjectTypePOLYGON , NCMapObjectTypePOLYLINE , NCMapObjectTypeDOTTEDPOLYLINE , NCMapObjectTypeCIRCLE , NCMapObjectTypeMODEL , NCMapObjectTypeCLUSTERMAPOBJECT , NCMapObjectTypePOINTBATCH }
	Enum defining the type of map object. More...

enum	NCMapTheme { NCMapThemeLight , NCMapThemeDark }
	Color theme of the outdoor vector basemap. More...

enum	NCOperatingMode { NCOperatingModeIndoorOnly , NCOperatingModeOutdoor , NCOperatingModeOutdoorIndoor }
	Operating mode of the location view. More...

enum	NCPlacement { NCPlacementVERTEX , NCPlacementMIDPOINT , NCPlacementSPACED }
	Enum defining the placement mode for points along a polyline. More...

enum	NCRouteRemainingStyle { NCRouteRemainingStyleSOLID , NCRouteRemainingStyleDASHED , NCRouteRemainingStyleDOTTED }
	Rendering style for the remaining (not yet traveled) part of the route. More...

enum	NCTileKind { NCTileKindVector , NCTileKindRaster }
	Payload of a TileProvider. More...

enum	NCTileSchema { NCTileSchemaShortbread , NCTileSchemaOpenMapTiles , NCTileSchemaMapboxStreets }
	Vector tile schema of the outdoor basemap. More...

enum	NCTitleAnchor { NCTitleAnchorCENTER , NCTitleAnchorTOP , NCTitleAnchorBOTTOM , NCTitleAnchorLEFT , NCTitleAnchorRIGHT , NCTitleAnchorTOPLEFT , NCTitleAnchorTOPRIGHT , NCTitleAnchorBOTTOMLEFT , NCTitleAnchorBOTTOMRIGHT }
	Anchor position of a map object title relative to its placement point. More...

enum	NCUserLocationFollowMode { NCUserLocationFollowModeNONE , NCUserLocationFollowModePOSITION , NCUserLocationFollowModeHEADING , NCUserLocationFollowModeCOURSE }
	How the user-location layer moves the camera. Reduced to pedestrian follow: none, position, compass heading, course over ground. A map gesture returns the mode to NONE. More...

Detailed Description

List of location view elements for Navigine iOS SDK.

Typedef Documentation

◆ NCCameraCallback

typedef void(^ NCCameraCallback) (BOOL completed)

Callback specified after the camera movement is stopped.

Referenced from: LocationWindow.

Called when the move if finished.

Parameters

completed determine whether the movement is finished or cancelled

Swift code snippet:

    func onMoveFinished(completed: Bool) {
        if completed {
            print("Camera movement completed successfully")
        } else {
            print("Camera movement was cancelled")
        }
    }

Objective C code snippet:

- (void)onMoveFinishedWithCompleted:(BOOL)completed {
    NSLog(@"Camera move animation %@", completed ? @"completed" : @"cancelled");
}

Definition at line 32 of file NCCameraCallback.h.

Enumeration Type Documentation

◆ NCAnimationType

enum NCAnimationType

Enum described animation functions.

Referenced from CircleMapObject, IconMapObject, LocationWindow.

Swift code snippet:

        let animationTypes: [NCAnimationType] = [
            .linear,
            .cubic,
            .quint,
            .sine,
            .none,
        ]

Objective C code snippet:

    NSArray *animationTypes = @[
        @(NCAnimationTypeLinear),
        @(NCAnimationTypeCubic),
        @(NCAnimationTypeQuint),
        @(NCAnimationTypeSine),
        @(NCAnimationTypeNone),
    ];

Enumerator
NCAnimationTypeNone	disable animation
NCAnimationTypeLinear	animation according to formula `f(t) = t`.
NCAnimationTypeCubic	animation according to formula `f(t) = (-2 * t + 3) * t * t`.
NCAnimationTypeQuint	animation according to formula `f(t) = (6 * t * t - 15 * t + 10) * t * t * t`.
NCAnimationTypeSine	animation according to formula `f(t) = 0.5 - 0.5 * cos(PI * t)`.

Definition at line 25 of file NCAnimationType.h.

◆ NCAttributionHorizontalAlignment

enum NCAttributionHorizontalAlignment

Horizontal placement of the OSM attribution overlay.

Used with AttributionAlignment.

Enumerator
NCAttributionHorizontalAlignmentLEFT	Align to the left edge of the map.
NCAttributionHorizontalAlignmentCENTER	Center horizontally.
NCAttributionHorizontalAlignmentRIGHT	Align to the right edge of the map.

Definition at line 16 of file NCAttributionHorizontalAlignment.h.

◆ NCAttributionVerticalAlignment

enum NCAttributionVerticalAlignment

Vertical placement of the OSM attribution overlay.

Used with AttributionAlignment.

Enumerator
NCAttributionVerticalAlignmentTOP	Align to the top edge of the map.
NCAttributionVerticalAlignmentBOTTOM	Align to the bottom edge of the map.

Definition at line 16 of file NCAttributionVerticalAlignment.h.

◆ NCCameraUpdateReason

enum NCCameraUpdateReason

Reason of the camera update.

Referenced from CameraListener.

Enumerator

NCCameraUpdateReasonGestures

user manipulation.

For example: zoom, scroll, rotate, fling.

NCCameraUpdateReasonApplication

Application.

By calling the LocationView::move methods.

Definition at line 15 of file NCCameraUpdateReason.h.

◆ NCCapType

enum NCCapType

Enum defining the type of cap for polyline ends.

Referenced from PolylineMapObject.

Enumerator
NCCapTypeBUTT	No points added to the end of the line.
NCCapTypeSQUARE	Two points added to make a square extension.
NCCapTypeROUND	Six points added in a fan to make a round cap.

Definition at line 16 of file NCCapType.h.

◆ NCDebugFlag

enum NCDebugFlag

Debug visualization flags for the map view LocationWindow.

Swift code snippet:

let allFlags: [NCDebugFlag] = [.none, .infos, .stats, .labels, .drawAllLabels, .selectionBuffer]

print("Debug flag enum values: \‍(allFlags.count)")

Objective C code snippet:

    NSArray<NSNumber *> *allFlags = @[
        @(NCDebugFlagNone),
        @(NCDebugFlagInfos),
        @(NCDebugFlagStats),
        @(NCDebugFlagLabels),
        @(NCDebugFlagDrawAllLabels),
        @(NCDebugFlagSelectionBuffer)
    ];
    NSLog(@"Debug flag enum values: %lu", (unsigned long)allFlags.count);

Enumerator
NCDebugFlagNone
NCDebugFlagInfos
NCDebugFlagStats
NCDebugFlagLabels
NCDebugFlagDrawAllLabels
NCDebugFlagSelectionBuffer

Definition at line 23 of file NCDebugFlag.h.

◆ NCGuidanceCameraMode

enum NCGuidanceCameraMode

Camera behavior while a route is shown.

FREE leaves the camera alone (also entered when the user pans or pinches). FOLLOWING looks along the route at the current progress. OVERVIEW fits the whole route into LocationWindow.focusRect (or the full view when focus rect is null).

Modes: Free / Following / Overview. A user gesture drops tracking.

Enumerator
NCGuidanceCameraModeFREE
NCGuidanceCameraModeFOLLOWING
NCGuidanceCameraModeOVERVIEW

Definition at line 21 of file NCGuidanceCameraMode.h.

◆ NCImageType

enum NCImageType

Enum described supported image types.

Referenced from Image.

Enumerator
NCImageTypePNG	PNG format.
NCImageTypeSVG	SVG format.
NCImageTypeJPG	JPG format.

Definition at line 15 of file NCImageType.h.

◆ NCJoinType

enum NCJoinType

Enum defining the type of join for polyline segments.

Referenced from PolylineMapObject.

Enumerator
NCJoinTypeMITER	No points added at the line join.
NCJoinTypeBEVEL	One point added to flatten the corner of a join.
NCJoinTypeROUND	Five points added in a fan to make a round outer join.

Definition at line 16 of file NCJoinType.h.

◆ NCMapObjectType

enum NCMapObjectType

Enum defining the type of map object.

Referenced from MapObject.

Enumerator
NCMapObjectTypeICON	Icon. IconMapObject.
NCMapObjectTypePOLYGON	Polygon. PolygonMapObject.
NCMapObjectTypePOLYLINE	Polyline. PolylineMapObject.
NCMapObjectTypeDOTTEDPOLYLINE	DottedPolyline. DottedPolylineMapObject.
NCMapObjectTypeCIRCLE	Circle. CircleMapObject.
NCMapObjectTypeMODEL	Model. ModelMapObject.
NCMapObjectTypeCLUSTERMAPOBJECT	Icon cluster. ClusterMapObject.
NCMapObjectTypePOINTBATCH	Screen-space arrow cloud. PointBatch.

Definition at line 16 of file NCMapObjectType.h.

◆ NCMapTheme

enum NCMapTheme

Color theme of the outdoor vector basemap.

Indoor floor rasters, venue icons, and user map objects are unchanged.

Enumerator

NCMapThemeLight

Light outdoor basemap (default).

Swift code snippet:

let themes: [NCMapTheme] = [.light, .dark]

print("Map themes: \‍(themes.count)")

Objective C code snippet:

NSArray<NSNumber *> *themes = @[@(NCMapThemeLight), @(NCMapThemeDark)];

NSLog(@"Map themes: %lu", (unsigned long)themes.count);

NCMapThemeDark

Dark outdoor basemap (versatiles-shadow palette).

Definition at line 16 of file NCMapTheme.h.

◆ NCOperatingMode

enum NCOperatingMode

Operating mode of the location view.

Controls whether the view shows indoor floors only, an outdoor vector basemap, or outdoor basemap with indoor building overlays.

Enumerator

NCOperatingModeIndoorOnly

Indoor floors only (no outdoor vector basemap). Camera stick-to-border / centering apply to the active floor plan.

Swift code snippet:

let modes: [NCOperatingMode] = [.indoorOnly, .outdoor, .outdoorIndoor]

print("Operating modes: \‍(modes.count)")

Objective C code snippet:

NSArray<NSNumber *> *modes = @[@(NCOperatingModeIndoorOnly), @(NCOperatingModeOutdoor), @(NCOperatingModeOutdoorIndoor)];

NSLog(@"Operating modes: %lu", (unsigned long)modes.count);

NCOperatingModeOutdoor

Outdoor vector basemap only (OSM MVT).

NCOperatingModeOutdoorIndoor

Outdoor vector basemap plus indoor building floor overlays.

Definition at line 17 of file NCOperatingMode.h.

◆ NCPlacement

enum NCPlacement

Enum defining the placement mode for points along a polyline.

Referenced from DottedPolylineMapObject.

Enumerator
NCPlacementVERTEX	Places points at each vertex of the polyline.
NCPlacementMIDPOINT	Places points at the midpoint of each polyline segment.
NCPlacementSPACED	Places points at regular intervals along the polyline, controlled by spacing parameters.

Definition at line 16 of file NCPlacement.h.

◆ NCRouteRemainingStyle

enum NCRouteRemainingStyle

Rendering style for the remaining (not yet traveled) part of the route.

Referenced from RouteLayer.

Enumerator
NCRouteRemainingStyleSOLID	Continuous solid polyline.
NCRouteRemainingStyleDASHED	Dashed polyline (see setRemainingDashLength / setRemainingGapLength).
NCRouteRemainingStyleDOTTED	Points placed along the route (DottedPolylineMapObject).

Definition at line 16 of file NCRouteRemainingStyle.h.

◆ NCTileKind

enum NCTileKind

Payload of a TileProvider.

vector is MVT and uses schema. raster is PNG, JPEG, or WebP imagery on LocationWindow.tileProvider; schema is ignored and outdoor vector geometry and labels are hidden. Indoor floors stay on top.

Enumerator

NCTileKindVector

Vector tiles (MVT). Default.

Swift code snippet:

let kinds: [NCTileKind] = [.vector, .raster]

print("Tile kinds: \‍(kinds.count)")

Objective C code snippet:

NSArray<NSNumber *> *kinds = @[@(NCTileKindVector), @(NCTileKindRaster)];

NSLog(@"Tile kinds: %lu", (unsigned long)kinds.count);

NCTileKindRaster

Raster imagery tiles.

Definition at line 18 of file NCTileKind.h.

◆ NCTileSchema

enum NCTileSchema

Vector tile schema of the outdoor basemap.

The built-in stylesheet covers Shortbread fully. OpenMapTiles and Mapbox Streets share the same programmatic rules with schema-aware filters (source layers, site/transit partition, extrude keys, admin levels). Verify new tile sets visually; see TILE_SCHEMA_FOLLOWUP.md.

Enumerator

NCTileSchemaShortbread

OSM Shortbread (versatiles / vector.openstreetmap.org). Default.

Swift code snippet:

let schemas: [NCTileSchema] = [.shortbread, .openMapTiles, .mapboxStreets]

print("Tile schemas: \‍(schemas.count)")

Objective C code snippet:

NSArray<NSNumber *> *schemas = @[@(NCTileSchemaShortbread), @(NCTileSchemaOpenMapTiles), @(NCTileSchemaMapboxStreets)];

NSLog(@"Tile schemas: %lu", (unsigned long)schemas.count);

NCTileSchemaOpenMapTiles

OpenMapTiles (MapTiler / Planetiler self-host). Schema-aware filters.

NCTileSchemaMapboxStreets

Mapbox Streets v8 (mapbox.mapbox-streets-v8). Schema-aware filters.

Definition at line 19 of file NCTileSchema.h.

◆ NCTitleAnchor

enum NCTitleAnchor

Anchor position of a map object title relative to its placement point.

Referenced from TitleStyle, MapObject.

Enumerator
NCTitleAnchorCENTER	Center of the text.
NCTitleAnchorTOP	Top edge of the text.
NCTitleAnchorBOTTOM	Bottom edge of the text.
NCTitleAnchorLEFT	Left edge of the text.
NCTitleAnchorRIGHT	Right edge of the text.
NCTitleAnchorTOPLEFT	Top-left corner of the text.
NCTitleAnchorTOPRIGHT	Top-right corner of the text.
NCTitleAnchorBOTTOMLEFT	Bottom-left corner of the text.
NCTitleAnchorBOTTOMRIGHT	Bottom-right corner of the text.

Definition at line 16 of file NCTitleAnchor.h.

◆ NCUserLocationFollowMode

enum NCUserLocationFollowMode

How the user-location layer moves the camera. Reduced to pedestrian follow: none, position, compass heading, course over ground. A map gesture returns the mode to NONE.

Referenced from UserLocationLayer.

Enumerator
NCUserLocationFollowModeNONE	Camera stays where the user left it. The arrow still rotates to heading.
NCUserLocationFollowModePOSITION	Camera follows the position and keeps its current rotation.
NCUserLocationFollowModeHEADING	Camera follows and rotates to the compass heading.
NCUserLocationFollowModeCOURSE	Camera follows and rotates to the direction of travel. Falls back to compass heading until the user has moved.

Definition at line 19 of file NCUserLocationFollowMode.h.

Topics

Classes

Typedefs

Enumerations

Detailed Description

Typedef Documentation

◆ NCCameraCallback

Enumeration Type Documentation

◆ NCAnimationType

◆ NCAttributionHorizontalAlignment

◆ NCAttributionVerticalAlignment

◆ NCCameraUpdateReason

◆ NCCapType

◆ NCDebugFlag

◆ NCGuidanceCameraMode

◆ NCImageType

◆ NCJoinType

◆ NCMapObjectType

◆ NCMapTheme

◆ NCOperatingMode

◆ NCPlacement

◆ NCRouteRemainingStyle

◆ NCTileKind

◆ NCTileSchema

◆ NCTitleAnchor

◆ NCUserLocationFollowMode