API reference
MapCore is one API — the C++ IMc* interface contract — mirrored into C#, Java and
JavaScript/TypeScript. The per-symbol documentation lives with the code, so this section tells you which
generated reference to read and how to move between them; the narrative that connects the symbols
is in Concepts and Guides.
Which reference to read
The C++ reference is canonical. It is generated from the public headers, which carry the documentation comments for every interface, method, parameter and enumerator — around 29,000 lines of them across 1,863 pure-virtual methods. Whatever language you write in, this is where a method's contract, its error codes and its threading requirements are stated.
The TypeScript reference is generated from MapCore.d.ts, the declaration file shipped in
every @mapcore/wasm-* package. Read it for the shapes the web surface actually presents —
particularly which methods return a value directly and which use .Value output objects.
C# and Java have no generated site of their own. Their names follow mechanical rules from the C++ ones, so the C++ reference plus the name map covers them. Where a wrapper genuinely behaves differently rather than merely looking different, Language surfaces records it.
Reading a C++ entry as another language
Three things change between surfaces, and none of them changes what a method does:
| C++ | C# | Java | JS/TS | |
|---|---|---|---|---|
| The type name | IMcMapDevice | IDNMcMapDevice | IMcMapDevice | MapCore.IMcMapDevice |
Where Create() lives | IMcMapDevice::Create() | DNMcMapDevice.Create() | IMcMapDevice.Static.Create() | MapCore.IMcMapDevice.Create() |
| How failure arrives | returns IMcErrors::ECode | throws | throws | throws |
Method names never change. So a C++ entry reading
virtual IMcErrors::ECode GetCameraScale(float *pfScale) = 0;
is, in JavaScript/TypeScript, a method called GetCameraScale that takes nothing and returns the scale —
because the error is an exception, which leaves the return value free for the result.
The two traps that catch every first port are C#'s enum members gaining a leading underscore
(ELS_SOLID becomes _ELS_SOLID) and Java putting its statics one level deeper, in a nested
Static class. Both are in Language surfaces, with the
memory rules that differ per surface.
The API as data
The documentation bundle also carries api/model.json: every public type and the members it
declares, with their documentation comments, as JSON. It exists for consumers that are not
people — a search index, a retrieval system, a coding agent — and it is generated from the same
headers as the C++ reference, so the two cannot disagree.
What is not here yet
Interface families are documented as each one is reviewed against its implementation, and a page
is withheld until then rather than published unverified. The error-code reference is the notable
gap: IMcErrors carries every code the API can return, and its page waits on that review.
Meanwhile, the C++ reference documents each method's own error returns, which is the more useful
form when you are looking at one call. The error codes named across these pages —
IMcErrors::SUCCESS, IMcErrors::INVALID_PARAMETERS, IMcErrors::LOCAL_CACHE_NOT_INIT and the
rest — are all real and all in the headers.