R/RcppExports.R

In flexpolyline: Flexible Polyline Encoding

# Generated by using Rcpp::compileAttributes() -> do not edit by hand
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

#' Decode a flexible polyline encoded string
#'
#' This function calls \code{hf::polyline_decode} and
#' \code{hf::get_third_dimension} of the C++ implementation of the flexible
#' polyline encoding by HERE. Depending on the dimensions of the encoded line,
#' a two or three dimensional line is decoded.
#'
#' @param encoded character, encoded flexible polyline string.
#'
#' @return
#' A matrix containing the coordinates of the decoded line.
#'
#' @export
#'
#' @examples
#' # 2d line
#' decode("BFoz5xJ67i1B1B7PzIhaxL7Y")
#'
#' # 3d line
#' decode("BlBoz5xJ67i1BU1B7PUzIhaUxL7YU")
decode <- function(encoded) {
    .Call(`_flexpolyline_decode`, encoded)
}

#' Encode a line in the flexible polyline encoding format
#'
#' This function calls \code{hf::polyline_encode} of the C++ implementation of
#' the flexible polyline encoding by HERE. Depending on the dimensions of the
#' input coordinates, a two or three dimensional line is encoded.
#'
#' @param line matrix, coordinates of the line in 2d or 3d (column order: LNG,
#' LAT, DIM3).
#' @param precision integer, precision to use in encoding (between 0 and 15,
#' \code{default=5}).
#' @param third_dim integer, type of the third dimension (0: ABSENT, 1: LEVEL,
#' 2: ALTITUDE, 3: ELEVATION, 4, 6: CUSTOM1, 7: CUSTOM2, \code{default=3}).
#' @param third_dim_precision integer, precision to use in encoding for the
#' third dimension (between 1 and 15, \code{default=5}).
#'
#' @return
#' The line as string in the flexible polyline encoding format.
#'
#' @export
#'
#' @examples
#' # 2D
#' line2d <- matrix(
#'   c(8.69821, 50.10228,
#'     8.69567, 50.10201,
#'     8.69150, 50.10063,
#'     8.68752, 50.09878),
#'   ncol = 2, byrow = TRUE
#' )
#' encode(line2d)
#'
#' # 3D
#' line3d <- matrix(
#'   c(8.69821, 50.10228, 10,
#'     8.69567, 50.10201, 20,
#'     8.69150, 50.10063, 30,
#'     8.68752, 50.09878, 40),
#'   ncol = 3, byrow = TRUE
#' )
#' encode(line3d)
encode <- function(line, precision = 5L, third_dim = 3L, third_dim_precision = 5L) {
    .Call(`_flexpolyline_encode`, line, precision, third_dim, third_dim_precision)
}

#' Get third dimension of a flexible polyline encoded string
#'
#' This function calls \code{hf::get_third_dimension} of the C++ implementation
#' of the flexible polyline encoding by HERE and return the type of the third
#' dimension.
#'
#' @param encoded character, encoded flexible polyline string.
#'
#' @return
#' A string describing the third dimension.
#'
#' @export
#'
#' @examples
#' # 2d line
#' get_third_dimension("BFoz5xJ67i1B1B7PzIhaxL7Y")
#'
#' # 3d line
#' get_third_dimension("BlBoz5xJ67i1BU1B7PUzIhaUxL7YU")
get_third_dimension <- function(encoded) {
    .Call(`_flexpolyline_get_third_dimension`, encoded)
}

#' Set third dimension of a flexible polyline encoded string
#'
#' This function decodes the flexible polyline encoded line, changes the third
#' dimension and encodes the line again.
#'
#' @note
#' The precision is not read from the header of the encoded line. Therefore it
#' must be provided as a parameter for re-encoding.
#'
#' @param encoded character, encoded flexible polyline string.
#' @param third_dim_name character, name of the third dimension to set (ABSENT,
#' LEVEL, ALTITUDE, ELEVATION, CUSTOM1, CUSTOM2).
#' @param precision integer, precision to use in encoding (between 0 and 15,
#' \code{default=5}).
#' @param third_dim_precision integer, precision to use in encoding for the
#' third dimension (between 1 and 15, \code{default=5}).
#'
#' @return
#' The line with the new third dimension as string in the flexible polyline
#' encoding format.
#'
#' @export
#'
#' @examples
#' # 2d line (nothing happens...)
#' set_third_dimension("BFoz5xJ67i1B1B7PzIhaxL7Y", "ELEVATION")
#'
#' # 3d line
#' set_third_dimension("BlBoz5xJ67i1BU1B7PUzIhaUxL7YU", "ELEVATION")
set_third_dimension <- function(encoded, third_dim_name, precision = 5L, third_dim_precision = 5L) {
    .Call(`_flexpolyline_set_third_dimension`, encoded, third_dim_name, precision, third_dim_precision)
}