ContentLayers.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) 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_CONTENTLAYERS_H_
#define DW_MAPS_CONTENTLAYERS_H_

#include <dw/maps/MapProvider.h>

#ifdef __cplusplus
extern "C" {
#endif

//#######################################################################################
// Content Layer
//#######################################################################################

#define DW_MAPS_CONTENT_LAYER_ID_MAX_LENGTH 256

typedef char dwMapsContentLayerId[DW_MAPS_CONTENT_LAYER_ID_MAX_LENGTH];

DW_API_PUBLIC
dwStatus dwMapsContentLayer_getId(dwMapsContentLayerId* id,
                                  dwConstMapsContentLayerHandle_t contentLayerHandle);

typedef enum dwMapsContentLayerType {
    DW_MAPS_CONTENT_LAYER_TYPE_UNKNOWN     = 0, 
    DW_MAPS_CONTENT_LAYER_TYPE_IMAGES      = 1, 
    DW_MAPS_CONTENT_LAYER_TYPE_POINT_CLOUD = 2, 
} dwMapsContentLayerType;

DW_API_PUBLIC
dwStatus dwMapsContentLayer_getType(dwMapsContentLayerType* contentLayerType,
                                    dwConstMapsContentLayerHandle_t contentLayerHandle);

//#######################################################################################
// Content Slice
//#######################################################################################

typedef struct dwMapsContentSliceObject* dwMapsContentSliceHandle_t;
typedef struct dwMapsContentSliceObject const* dwConstMapsContentSliceHandle_t;

DW_API_PUBLIC
dwStatus dwMapsContentSlice_initialize(dwMapsContentSliceHandle_t* contentSliceHandle,
                                       size_t memoryInBytes,
                                       size_t maxSegmentsPerLayout,
                                       dwMapProviderHandle_t providerHandle);

typedef uint64_t dwMapsContentUpdateToken;

typedef struct dwMapsImageLayerViewObject const* dwConstMapsImageLayerViewHandle_t;
typedef struct dwMapsPointCloudLayerViewObject const* dwConstMapsPointCloudLayerViewHandle_t;
typedef struct dwMapsJunctionLayerViewObject* dwMapsJunctionLayerViewHandle_t;
typedef struct dwMapsLaneDividerLayerViewObject const* dwConstMapsLaneDividerLayerViewHandle_t;
typedef struct dwMapsLaneChannelLayerViewObject const* dwConstMapsLaneChannelLayerViewHandle_t;
typedef struct dwMapsRoadMarkingLayerViewObject const* dwConstMapsRoadMarkingLayerViewHandle_t;
typedef struct dwMapsPoleLayerViewObject const* dwConstMapsPoleLayerViewHandle_t;

DW_API_PUBLIC
dwStatus dwMapsContentSlice_initializeImageLayerView(dwConstMapsImageLayerViewHandle_t* imageLayerViewHandle,
                                                     dwConstMapsContentLayerHandle_t imageLayerHandle,
                                                     dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_initializePointCloudLayerView(dwConstMapsPointCloudLayerViewHandle_t* pointCloudLayerViewHandle,
                                                          dwConstMapsContentLayerHandle_t pointCloudLayer,
                                                          dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_initializeJunctionLayerView(dwMapsJunctionLayerViewHandle_t* junctionLayerViewHandle,
                                                        dwConstMapsContentLayerHandle_t junctionLayerHandle,
                                                        dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_initializeLaneDividerLayerView(dwConstMapsLaneDividerLayerViewHandle_t* laneDividerLayerViewHandle,
                                                           dwConstMapsContentLayerHandle_t laneDividerLayerHandle,
                                                           dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_initializeLaneChannelLayerView(dwConstMapsLaneChannelLayerViewHandle_t* laneChannelLayerViewHandle,
                                                           dwConstMapsContentLayerHandle_t laneChannelLayerHandle,
                                                           dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_initializeRoadMarkingLayerView(dwConstMapsRoadMarkingLayerViewHandle_t* roadMarkingLayerViewHandle,
                                                           dwConstMapsContentLayerHandle_t roadMarkingLayerHandle,
                                                           dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_initializePoleLayerView(dwConstMapsPoleLayerViewHandle_t* poleLayerViewHandle,
                                                    dwConstMapsContentLayerHandle_t poleLayerHandle,
                                                    dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_updateAsync(dwMapsContentUpdateToken* updateToken,
                                        dwConstMapsLocalLayoutHandle_t localLayoutHandle,
                                        uint32_t componentId,
                                        dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_tryCompleteUpdate(dwMapsContentUpdateToken updateToken,
                                              dwMapsContentSliceHandle_t contentSliceHandle);

DW_API_PUBLIC
dwStatus dwMapsContentSlice_release(dwMapsContentSliceHandle_t contentSliceHandle);

#ifdef __cplusplus
}
#endif

#endif // DW_MAPS_CONTENTLAYERS_H_