Skip to content

MapConductor/ios-for-mapkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MapConductor MapKit Module

MapConductor MapKit Module provides the MapKit–specific implementation of the MapConductor unified API for iOS.

This module contains both the SwiftUI-based unified API bindings and the driver logic required to translate provider-agnostic map semantics into concrete behavior using the MapKit API for iOS.


Overview

The MapKit module is responsible for connecting the MapConductor conceptual API to the MapKit API.

While the unified API of MapConductor is conceptually shared across all map providers, its SwiftUI bindings and runtime behavior must be implemented in a provider-specific manner to account for differences in rendering, lifecycle management, and interaction models.

This module fulfills that role for MapKit.

Role in the architecture

┌────────────────────────────────────────────┐
│ Application / App Logic                    │
├────────────────────────────────────────────┤
│ MapConductor Unified API (SwiftUI)         │
│  (provider-specific implementation)        │
│  - Unified API (SwiftUI bindings)          │
│  - Internal controllers                    │
├────────────────────────────────────────────┤
│ MapConductor iOS Core                      │
│  - Domain models                           │
│  - State & behavior                        │
│  - Provider-agnostic logic                 │
├────────────────────────────────────────────┤
│ MapKit Module                              │
│  - Internal renderers                      │
├────────────────────────────────────────────┤
│ MapKit API
└────────────────────────────────────────────┘

In this architecture:

  • The unified API defines what a map operation means

  • The core module defines provider-agnostic semantics and state

  • This MapKit module defines how those semantics are realized using the MapKit API

What this module does

This module is responsible for:

  • Providing the MapKit–specific implementation of the MapConductor unified API (SwiftUI)

  • Translating provider-agnostic domain models and state into MapKit API operations

  • Managing provider-specific controllers for camera, overlays, gestures, and interactions

  • Implementing MapKit–specific rendering logic and workarounds where required

In short, this module answers the question:

“How should this unified map operation behave on MapKit?”

What this module does NOT do

Internally, this module typically consists of:

  • SwiftUI unified API bindings Provider-specific implementations of the unified API surface

  • Controllers Components that manage state synchronization and event handling between SwiftUI, the core module, and the MapKit API

  • Renderers Low-level components that create and update MapKit API objects such as markers, overlays, and camera updates

These components are considered implementation details and are not part of the public API.

Design philosophy

This module follows these design principles:

  • Conceptually unified, operationally specialized The meaning of map operations is shared across providers, while implementation details remain provider-specific.

  • Isolation of provider-specific behavior MapKit quirks and limitations should not leak into the core module or unified API definitions.

  • No lowest common denominator APIs Differences in provider capabilities are handled through adaptation, not by reducing the expressive power of the unified API.

Who should use or modify this module

This module is primarily intended for:

  • Contributors implementing or maintaining MapKit support

  • Developers debugging provider-specific map behavior

  • Contributors extending MapConductor with new MapKit features

If you are using MapConductor via the unified API in an application, you typically do not need to interact with this module directly.

Relationship to other modules

About

MapKit module for MapConductor

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages