@magiclane/maps-sdk
    Preparing search index...

    Class RouteTerrainProfile

    Route terrain profile

    This class should not be instantiated directly. Instead, use the RouteBase.terrainProfile getter to obtain an instance. Note that the RoutePreferences.buildTerrainProfile setting should be configured correctly when calling the RoutingService.calculateRoute method for the RouteBase.terrainProfile getter to return a valid object.

    Hierarchy

    • GemAutoreleaseObject
      • RouteTerrainProfile
    Index

    Accessors

    • get climbSections(): ClimbSection[]

      Get list of route climb sections.

      Climb sections are the difficult climbing parts of a route. The climb categories are defined in Grade.

      If none of the climbing parts of a route are at least Grade.grade4, the list will be empty.

      Returns ClimbSection[]

      The climb sections list

      An exception if it fails.

    • get mapId(): number

      Returns number

    • get maxElevation(): number

      Get terrain maximum elevation.

      Returns number

      Terrain maximum elevation

      An exception if it fails.

    • get maxElevationDistance(): number

      Get the distance (from route start) where the elevation is maximum.

      Returns number

      Terrain maximum elevation distance in meters

      An exception if it fails.

    • get minElevation(): number

      Get terrain minimum elevation.

      Returns number

      Terrain minimum elevation

      An exception if it fails.

    • get minElevationDistance(): number

      Get the distance (from route start) where the elevation is minimum.

      Returns number

      Terrain minimum elevation distance

      An exception if it fails.

    • get pointerId(): number

      Returns number

    • get roadTypeSections(): RoadTypeSection[]

      Get list of route type sections.

      Each section has the start distance from route start and the road type (see RoadType).

      The end of the section is the distance from start of the next section or route total length (for the last section)

      Returns RoadTypeSection[]

      The road type sections list

      An exception if it fails.

    • get surfaceSections(): SurfaceSection[]

      Get list of route surface sections.

      Each section has the start distance from route start and the surface type (see SurfaceType).

      The end of the section is the distance from start of the next section or route total length (for the last section)

      Returns SurfaceSection[]

      The surface sections list

      An exception if it fails.

    • get totalDown(): number

      Get total terrain elevation down.

      Returns number

      Total terrain elevation down

      An exception if it fails

    • get totalUp(): number

      Get total terrain elevation up.

      Returns number

      Total terrain elevation up

      An exception if it fails

    Methods

    • Returns void

    • Get elevation at the given distance in meters from departure point/start of route.

      Parameters

      • distance: number

        Distance in meters from start of route

      Returns number

      The elevation in meters

      An exception if it fails.

    • Get elevation samples list.

      Parameters

      • countSamples: number

        Number of samples.

      • distBegin: number

        Begin distance on route for sample interval.

      • distEnd: number

        End distance on route for sample interval.

      Returns Pair<number[], number>

      Pair(samples, resolution)

      An exception if it fails.

    • Get list of route sections which are abrupt, that is, they have a significant elevation change.

      Parameters

      • categs: number[]

        The user list of steep categories. Each entry contains the max slope for the steep category as diffX / diffY.

      Returns SteepSection[]

      The steep sections list

      An exception if it fails.

    • Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.

      Parameters

      • pointerId: any

        The pointer ID to register

      Returns void