DriveWorks SDK Reference
3.5.78 Release
For Test and Development only

Content Layer Interface

Detailed Description

Definition of interface to access layered map content.

Content Layer is defined to be a homogenous collection of map elements which are "additional" or "optional" in contrast to the core map, e.g. road segments and lanes.

Supported content types include features, images, point clouds, etc. In the future more complex objects may be stored here, in some cases including references to data across layers.

Content layers are accessed via the content slice interface, using an instance of local layout as the "key" to load and transform local content.

Note
SW Release Applicability: These APIs are available in NVIDIA DRIVE Software releases.

Macros

#define DW_MAPS_CONTENT_LAYER_ID_MAX_LENGTH   256
 Maximum length of a content layer name including NULL terminator. More...
 

Typedefs

typedef char dwMapsContentLayerId[DW_MAPS_CONTENT_LAYER_ID_MAX_LENGTH]
 Human-readable identifier for a content layer. More...
 

Enumerations

enum  dwMapsContentLayerType {
  DW_MAPS_CONTENT_LAYER_TYPE_UNKNOWN = 0,
  DW_MAPS_CONTENT_LAYER_TYPE_IMAGES = 1,
  DW_MAPS_CONTENT_LAYER_TYPE_POINT_CLOUD = 2
}
 Types of content layers which may be available in a map. More...
 

Functions

DW_API_PUBLIC dwStatus dwMapsContentLayer_getId (dwMapsContentLayerId *id, dwConstMapsContentLayerHandle_t contentLayerHandle)
 Get the human-readable identifier for the layer. More...
 
DW_API_PUBLIC dwStatus dwMapsContentLayer_getType (dwMapsContentLayerType *contentLayerType, dwConstMapsContentLayerHandle_t contentLayerHandle)
 Get the type of the content layer. More...
 

Macro Definition Documentation

◆ DW_MAPS_CONTENT_LAYER_ID_MAX_LENGTH

#define DW_MAPS_CONTENT_LAYER_ID_MAX_LENGTH   256

Maximum length of a content layer name including NULL terminator.

Definition at line 67 of file ContentLayers.h.

Typedef Documentation

◆ dwMapsContentLayerId

typedef char dwMapsContentLayerId[DW_MAPS_CONTENT_LAYER_ID_MAX_LENGTH]

Human-readable identifier for a content layer.

This identifier must be unique per map provider.

Definition at line 73 of file ContentLayers.h.

Enumeration Type Documentation

◆ dwMapsContentLayerType

Types of content layers which may be available in a map.

Deprecated:
Future layers will not encode their type. Refer to Map documentation to determine which view should be constructed for a given layer
Enumerator
DW_MAPS_CONTENT_LAYER_TYPE_UNKNOWN 

Content layer has unknown type.

DW_MAPS_CONTENT_LAYER_TYPE_IMAGES 

Defined by layers/ImageLayer.h.

DW_MAPS_CONTENT_LAYER_TYPE_POINT_CLOUD 

Defined by layers/PointCloudLayer.h.

Definition at line 96 of file ContentLayers.h.

Function Documentation

◆ dwMapsContentLayer_getId()

DW_API_PUBLIC dwStatus dwMapsContentLayer_getId ( dwMapsContentLayerId id,
dwConstMapsContentLayerHandle_t  contentLayerHandle 
)

Get the human-readable identifier for the layer.

Parameters
[out]idHuman-readable identifier for the layer.
[in]contentLayerHandleHandle to the content layer object.
Returns
DW_SUCCESS Successfully returned number of points.
DW_INVALID_ARGUMENT Indicates imageCount is nullptr.
DW_NOT_AVAILABLE Indicates specified layer does not contain images.
DW_BAD_CAST Could not successfully cast handle to content slice object.

◆ dwMapsContentLayer_getType()

DW_API_PUBLIC dwStatus dwMapsContentLayer_getType ( dwMapsContentLayerType contentLayerType,
dwConstMapsContentLayerHandle_t  contentLayerHandle 
)

Get the type of the content layer.

Parameters
[out]contentLayerTypeType of the content layer.
[in]contentLayerHandleContent layer object.
Returns
DW_SUCCESS Successfully returned contentLayerType.
DW_INVALID_ARGUMENT Indicates contentLayerType is nullptr.
DW_BAD_CAST Could not successfully cast handle to content layer object.
Deprecated:
Future layers will not encode their type. Refer to Map documentation to determine which view should be constructed for a given layer