LandmarkTypes.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-2020 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_WORLD_LANDMARK_TYPES_H_
#define DW_WORLD_LANDMARK_TYPES_H_

#include <dw/core/Exports.h>

/*
 * @note SW Release Applicability: These APIs are available in <b>NVIDIA DRIVE Software</b> releases.
 */

// Top level road mark state bits.
#define DW_ROADMARK_TYPE_ARROWMARK (1 << 16)
#define DW_ROADMARK_TYPE_SPEEDLIMITMARK (1 << 17)
#define DW_ROADMARK_TYPE_TEXTMARK (1 << 18)
#define DW_ROADMARK_TYPE_SPECIAL (1 << 19)

typedef enum {
    DW_LANDMARK_TYPE_UNDEFINED     = 0,
    DW_LANDMARK_TYPE_LANE_MARKINGS = 1,
    DW_LANDMARK_TYPE_POLES         = 2,
    DW_LANDMARK_TYPE_INTERSECTIONS = 3,
    DW_LANDMARK_TYPE_ROADMARK      = 4,
    DW_LANDMARK_TYPE_COUNT         = 5,
} dwLandmarkType;

typedef enum {
    DW_LANEMARK_TYPE_UNDEFINED = 0,

    // Single
    DW_LANEMARK_TYPE_SOLID                                                                                          = 1,
    DW_LANEMARK_TYPE_LONG_DASHED                                                                                    = 2,
    DW_LANEMARK_TYPE_SHORT_DASHED                                                                                   = 3,
    DW_LANEMARK_TYPE_DASHED DW_DEPRECATED_ENUM("The value is deprecated, use DW_LANEMARK_TYPE_LONG_DASHED instead") = DW_LANEMARK_TYPE_LONG_DASHED,

    // Double
    DW_LANEMARK_TYPE_DOUBLE_SOLID  = 4,
    DW_LANEMARK_TYPE_DOUBLE_DASHED = 5,
    DW_LANEMARK_TYPE_SOLID_DASHED  = 6,
    DW_LANEMARK_TYPE_DASHED_SOLID  = 7,

    // Triple
    DW_LANEMARK_TYPE_TRIPLE_SOLID        = 8,
    DW_LANEMARK_TYPE_TRIPLE_DASHED       = 9,
    DW_LANEMARK_TYPE_SOLID_DASHED_SOLID  = 10,
    DW_LANEMARK_TYPE_DASHED_SOLID_DASHED = 11,

    // Botts dots
    DW_LANEMARK_TYPE_BOTTS_DOTS_SOLID         = 12,
    DW_LANEMARK_TYPE_BOTTS_DOTS_DASHED        = 13,
    DW_LANEMARK_TYPE_BOTTS_DOTS_DOUBLE_SOLID  = 14,
    DW_LANEMARK_TYPE_BOTTS_DOTS_DOUBLE_DASHED = 15,
    DW_LANEMARK_TYPE_BOTTS_DOTS_SOLID_DASHED  = 16,
    DW_LANEMARK_TYPE_BOTTS_DOTS_DASHED_SOLID  = 17,

    // Other lane markings
    DW_LANEMARK_TYPE_ZIGZAG       = 18,
    DW_LANEMARK_TYPE_RUMBLE_STRIP = 19,

    // Road boundary
    DW_LANEMARK_TYPE_SEAM                                                                                              = 20,
    DW_LANEMARK_TYPE_CURB                                                                                              = 21,
    DW_LANEMARK_TYPE_BARRIER                                                                                           = 22,
    DW_LANEMARK_TYPE_TEMPORARY_BARRIER                                                                                 = 23,
    DW_LANEMARK_TYPE_ROAD_BOUNDARY DW_DEPRECATED_ENUM("The value is deprecated, use DW_LANEMARK_TYPE_BARRIER instead") = DW_LANEMARK_TYPE_BARRIER,

    // Other
    DW_LANEMARK_TYPE_VIRTUAL = 24,
    DW_LANEMARK_TYPE_COUNT   = 25
} dwLaneMarkType;

typedef enum {
    DW_LANEMARK_COLOR_UNDEFINED = 0,
    DW_LANEMARK_COLOR_WHITE     = 1,
    DW_LANEMARK_COLOR_YELLOW    = 2,
    DW_LANEMARK_COLOR_OTHER     = 3,
    DW_LANEMARK_COLOR_COUNT     = 4
} dwLaneMarkColor;

typedef enum {
    DW_POLE_TYPE_UNDEFINED = 0,
    DW_POLE_TYPE_OTHER     = 1,
    DW_POLE_TYPE_ROADSIGN  = 2,
    DW_POLE_TYPE_LIGHT     = 3,
    DW_POLE_TYPE_UTILITY   = 4,
    DW_POLE_TYPE_TREE      = 5,
    DW_POLE_TYPE_COUNT     = 6,
} dwPoleType;

typedef enum {
    DW_LANDMARK_INTERSECTION_TYPE_UNDEFINED            = 0,
    DW_LANDMARK_INTERSECTION_TYPE_CROSSWALK            = 1,
    DW_LANDMARK_INTERSECTION_TYPE_INTERSECTION         = 2,
    DW_LANDMARK_INTERSECTION_TYPE_CROSSINGINTERSECTION = 3,
    DW_LANDMARK_INTERSECTION_TYPE_GOREAREA             = 4,
    DW_LANDMARK_INTERSECTION_TYPE_YIELD                = 5,
    DW_LANDMARK_INTERSECTION_TYPE_RAILROAD             = 6,
    DW_LANDMARK_INTERSECTION_TYPE_BUMP                 = 7,
    DW_LANDMARK_INTERSECTION_TYPE_COUNT                = 8,
} dwLandmarkIntersectionType;

typedef enum {
    DW_ROADMARK_TYPE_INVALID = 0,

    // Arrow mark types.
    DW_ROADMARK_TYPE_ARROWMARK_UNKNOWN             = 0 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_STRAIGHT            = 1 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_STRAIGHT_LEFT       = 2 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_STRAIGHT_RIGHT      = 3 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_STRAIGHT_LEFT_RIGHT = 4 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_LEFT                = 5 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_RIGHT               = 6 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_LEFT_RIGHT          = 7 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_MERGE               = 8 + DW_ROADMARK_TYPE_ARROWMARK,
    DW_ROADMARK_TYPE_ARROWMARK_UTURN               = 9 + DW_ROADMARK_TYPE_ARROWMARK,

    // Speed limit mark types.
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_UNKNOWN = 0 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_5MPH    = 1 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_10MPH   = 2 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_15MPH   = 3 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_20MPH   = 4 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_25MPH   = 5 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_30MPH   = 6 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_35MPH   = 7 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_40MPH   = 8 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_45MPH   = 9 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_50MPH   = 10 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_55MPH   = 11 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_60MPH   = 12 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_65MPH   = 13 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_70MPH   = 14 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_75MPH   = 15 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,
    DW_ROADMARK_TYPE_SPEEDLIMITMARK_80MPH   = 16 + DW_ROADMARK_TYPE_SPEEDLIMITMARK,

    // Text mark types.
    DW_ROADMARK_TYPE_TEXTMARK_UNKNOWN = 0 + DW_ROADMARK_TYPE_TEXTMARK,
    DW_ROADMARK_TYPE_TEXTMARK_BIKE    = 1 + DW_ROADMARK_TYPE_TEXTMARK,
    DW_ROADMARK_TYPE_TEXTMARK_SCHOOL  = 2 + DW_ROADMARK_TYPE_TEXTMARK,
    DW_ROADMARK_TYPE_TEXTMARK_STOP    = 3 + DW_ROADMARK_TYPE_TEXTMARK,
    DW_ROADMARK_TYPE_TEXTMARK_AHEAD   = 4 + DW_ROADMARK_TYPE_TEXTMARK,
    DW_ROADMARK_TYPE_TEXTMARK_HUMP    = 5 + DW_ROADMARK_TYPE_TEXTMARK,
    DW_ROADMARK_TYPE_TEXTMARK_BUMP    = 6 + DW_ROADMARK_TYPE_TEXTMARK,

    // Other road mark types.
    DW_ROADMARK_TYPE_SPECIAL_UNKNOWN = 0 + DW_ROADMARK_TYPE_SPECIAL,
    DW_ROADMARK_TYPE_HOVMARK         = 1 + DW_ROADMARK_TYPE_SPECIAL,
    DW_ROADMARK_TYPE_BIKEMARK        = 2 + DW_ROADMARK_TYPE_SPECIAL,
    DW_ROADMARK_TYPE_HUMPMARK        = 3 + DW_ROADMARK_TYPE_SPECIAL,
    DW_ROADMARK_TYPE_BACKGROUND      = 4 + DW_ROADMARK_TYPE_SPECIAL
} dwRoadmarkType;

typedef struct
{
    dwLandmarkType landmarkType;
    dwLaneMarkType laneMarkAttribute;
    dwPoleType poleAttribute;
    dwLandmarkIntersectionType intersectionAttribute;
} dwLandmarkAttribute;

#define DW_LANDMARK_TYPE_MAX_COUNT (DW_LANEMARK_TYPE_COUNT + DW_LANDMARK_INTERSECTION_TYPE_COUNT + DW_POLE_TYPE_COUNT)

#endif // DW_WORLD_LANDMARK_TYPES_H_