MapProvider.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. No third party distribution is allowed unless
// expressly authorized by NVIDIA.  Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2018-2019 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//

#ifndef DW_MAPS_MAP_PROVIDER_H_
#define DW_MAPS_MAP_PROVIDER_H_

#include <dw/maps/Maps.h>

#ifdef __cplusplus
extern "C" {
#endif

//#######################################################################################
// Map Provider
//#######################################################################################

typedef struct dwMapProviderObject* dwMapProviderHandle_t;
typedef struct dwMapProviderObject const* dwConstMapsProviderHandle_t;

typedef struct dwMapProviderParameters
{
    size_t numAllocatedMaps;        
    size_t totalMapAllocationBytes; 
} dwMapProviderParameters;

typedef uint64_t dwMapsRequestToken;

DW_API_PUBLIC
dwStatus dwMapProvider_initializeWithCacheFile(
    dwMapProviderHandle_t* providerHandle,
    const char* mapCacheFile,
    dwMapProviderParameters* params,
    dwContextHandle_t contextHandle);

DW_API_PUBLIC
dwStatus dwMapProvider_initializeWithDirectory(
    dwMapProviderHandle_t* providerHandle,
    const char* mapDirectory,
    dwMapProviderParameters* params,
    dwContextHandle_t contextHandle);

DW_API_PUBLIC
dwStatus dwMapProvider_getCoverageBounds(
    dwMapsBounds* bounds,
    dwMapProviderHandle_t providerHandle);

typedef struct dwMapsContentLayerObject const* dwConstMapsContentLayerHandle_t;

DW_API_PUBLIC
dwStatus dwMapProvider_getContentLayer(dwConstMapsContentLayerHandle_t* layer,
                                       const char* layerId,
                                       dwConstMapsProviderHandle_t providerHandle);

typedef struct dwMapsContentLayerBuffer
{
    dwConstMapsContentLayerHandle_t* buffer; 
    size_t maxSize;                          
    size_t size;                             
} dwMapsContentLayerBuffer;

DW_API_PUBLIC
dwStatus dwMapProvider_getContentLayers(dwMapsContentLayerBuffer* layers,            /* out */
                                        dwConstMapsProviderHandle_t providerHandle); /* in */

DW_API_PUBLIC
dwStatus dwMapProvider_release(dwMapProviderHandle_t providerHandle);

DW_API_PUBLIC
dwStatus dwMapProvider_requestMapForBounds(
    dwMapsRequestToken* requestToken,
    const dwMapsBounds* bounds,
    const dwMapsContentLayerBuffer* layers,
    dwMapProviderHandle_t providerHandle);

typedef struct dwMapsRoute
{
    dwMapsGeoPoint* waypoints; 
    size_t waypointCount;      
} dwMapsRoute;

DW_API_PUBLIC
dwStatus dwMapProvider_requestMapForRoute(
    dwMapsRequestToken* requestToken,
    const dwMapsRoute* route,
    const dwMapsContentLayerBuffer* layers,
    dwMapProviderHandle_t providerHandle);

DW_API_PUBLIC
dwStatus dwMapProvider_releaseMap(
    dwConstMapHandle_t mapHandle,
    dwMapProviderHandle_t providerHandle);

DW_API_PUBLIC
dwStatus dwMapProvider_tryGetRequestedMap(
    dwConstMapHandle_t* mapHandle,
    dwMapsRequestToken requestToken,
    dwMapProviderHandle_t providerHandle);

#ifdef __cplusplus
}
#endif

#endif // DW_MAPS_MAP_PROVIDER_H_