Package 

Class PathManagerConfiguration

    • Constructor Detail

    • Method Detail

      • getAllowedHeadingChangeWithoutDirectionUpdate

         float getAllowedHeadingChangeWithoutDirectionUpdate()

        Get allowedHeadingChangeWithoutDirectionUpdate. Allowed user heading change before triggering a path directions update (in radians) Default is 0.5235987755982988

      • getArrivalThreshold

         float getArrivalThreshold()

        Get arrivalThreshold. Distance threshold for path session arrival at a destination (in meters) Default is 4.0

      • getArrivalThresholdInMeters

         float getArrivalThresholdInMeters()

        Get arrivalThresholdInMeters. Distance threshold for path session arrival at a destination (in meters) Default is 4.0

      • getArrivalThresholdInMetres

         float getArrivalThresholdInMetres()

        Get arrivalThresholdInMetres. Distance threshold for path session arrival at a destination (in meters) Default is 4.0

      • getClosestPathCalculationLimit

         int getClosestPathCalculationLimit()

        Get closestPathCalculationLimit. The number of nearest destinations to consider for multiple destinations pathfinding Default is 3

      • getDirectionOffset

         float getDirectionOffset()

        Get directionOffset. Distance of the directions from the path (in meters) Default is 1.0

      • getDirectionalNodesSimplificationEpsilon

         float getDirectionalNodesSimplificationEpsilon()

        Get directionalNodesSimplificationEpsilon. The epsilon parameter of the Ramer-Douglas-Peucker algorithm used to simplify the path before calculating turn-by-turn directions (in meters) Default is 1.0

      • getDirectionsUpdateIntervalInSeconds

         float getDirectionsUpdateIntervalInSeconds()

        Get directionsUpdateIntervalInSeconds. Path directions update period (in seconds) (overridden in case of a major path update) Default is 1.0

      • getNodeConnectionGridCellCountInRadius

         int getNodeConnectionGridCellCountInRadius()

        Get nodeConnectionGridCellCountInRadius. The number of grid cells along the radius of the circular grid Default is 20

      • getNodeConnectionGridRadius

         float getNodeConnectionGridRadius()

        Get nodeConnectionGridRadius. The radius of the circular grid constructed around the node to be connected (in meters) Default is 10.0

      • getNodeConnectionMaximumEdgeCount

         int getNodeConnectionMaximumEdgeCount()

        Get nodeConnectionMaximumEdgeCount. The maximum number of edges that will be considered for connecting a node to the graph Default is 10

      • getNodeConnectionMaximumObstacleDifferenceForAlternatives

         float getNodeConnectionMaximumObstacleDifferenceForAlternatives()

        Get nodeConnectionMaximumObstacleDifferenceForAlternatives. The alternative connection paths are considered only if their trip lengths inside obstacles are less than this value compared to the shortest connection path Default is 2.0

      • getNodeConnectionMaximumWallDifferenceForAlternatives

         float getNodeConnectionMaximumWallDifferenceForAlternatives()

        Get nodeConnectionMaximumWallDifferenceForAlternatives. The alternative connection paths are considered only if their trip lengths inside obstacles are less than this value compared to the shortest connection path Default is 2.0

      • getNodeConnectionObstaclePenaltyMultiplier

         float getNodeConnectionObstaclePenaltyMultiplier()

        Get nodeConnectionObstaclePenaltyMultiplier. The multiplicative penalty for distance covered inside obstacles while computing the connection path Default is 10.0

      • getNodeConnectionObstaclePenetrationPenalty

         float getNodeConnectionObstaclePenetrationPenalty()

        Get nodeConnectionObstaclePenetrationPenalty. The additive penalty for obstacle penetrations while computing the connection path (in meters) Default is 100.0

      • getNodeConnectionWallPenaltyMultiplier

         float getNodeConnectionWallPenaltyMultiplier()

        Get nodeConnectionWallPenaltyMultiplier. The multiplicative penalty for distance covered inside obstacles while computing the connection path Default is 10.0

      • getNodeConnectionWallPenetrationPenalty

         float getNodeConnectionWallPenetrationPenalty()

        Get nodeConnectionWallPenetrationPenalty. The additive penalty for obstacle penetrations while computing the connection path (in meters) Default is 100.0

      • getObstacleAvoidanceOffsetGradualStartDistance

         float getObstacleAvoidanceOffsetGradualStartDistance()

        Get obstacleAvoidanceOffsetGradualStartDistance. Obstacle avoidance offset will gradually increase from 0 to its final value for this initial distance Default is 10.0

      • getObstacleAvoidanceOffsetInMeters

         float getObstacleAvoidanceOffsetInMeters()

        Get obstacleAvoidanceOffsetInMeters. Distance to preserve between the smoothed path and the obstacles (in meters) Default is 2.0

      • getObstaclePreprocessingOffset

         float getObstaclePreprocessingOffset()

        Get obstaclePreprocessingOffset. As a preprocessing step, obstacle polygons are inflated and then deflated by this amount to get rid of narrow gaps that are unlikely to be walkable. This helps dynamic node-to-graph connection algorithm to avoid taking unlikely shortcuts and be more robust overall. Set to 0 to disable, so that original obstacles are preserved as is. (in meters) Default is 0.0

      • getPathCalculationFailureTolerance

         float getPathCalculationFailureTolerance()

        Get pathCalculationFailureTolerance. Time required to pass after last successful path calculation to fail a path session (in seconds) Default is 600.0

      • getPathCalculationFailureToleranceInSeconds

         float getPathCalculationFailureToleranceInSeconds()

        Get pathCalculationFailureToleranceInSeconds. Time required to pass after last successful path calculation to fail a path session (in seconds) Default is 600.0

      • getPathSmoothingCrossProductThreshold

         float getPathSmoothingCrossProductThreshold()

        Get pathSmoothingCrossProductThreshold. Cross product threshold below which an inflection is considered straight (in m^2). Lower values result in more accurate obstacle offset avoidance, however may cause slower operation and more nodes. Default is 0.01

      • getPathSmoothingDualIterationCount

         int getPathSmoothingDualIterationCount()

        Get pathSmoothingDualIterationCount. Number of iterations for the inner dual operation Default is 5

      • getPathSmoothingWallAvoidanceOffsetInMeters

         float getPathSmoothingWallAvoidanceOffsetInMeters()

        Get pathSmoothingWallAvoidanceOffsetInMeters. Distance to preserve between the smoothed path and the obstacles (in meters) Default is 2.0

      • getPathfindingPeriod

         float getPathfindingPeriod()

        Get pathfindingPeriod. Path session path update period (in seconds) Default is 0.25

      • getPathfindingPeriodInSeconds

         float getPathfindingPeriodInSeconds()

        Get pathfindingPeriodInSeconds. Path session path update period (in seconds) Default is 0.25

      • getPathfindingTypicalWalkingSpeed

         float getPathfindingTypicalWalkingSpeed()

        Get pathfindingTypicalWalkingSpeed. Typical walking speed in meters per minutes, to be used for path analytics calculation Default is 60.0

      • getPortalDirectionSensitivity

         float getPortalDirectionSensitivity()

        Get portalDirectionSensitivity. If the path remaining until a portal is shorter than this threshold, the portal direction is shown as the first direction, ignoring all other rotations/turns in-between (in meters) Default is 5.0

      • getRotationAngle

         float getRotationAngle()

        Get rotationAngle. Angle to decide if the user needs to rotate (in radians) Default is 1.5707963267948966

      • getShouldConsiderArrivalThresholdForPolygons

         boolean getShouldConsiderArrivalThresholdForPolygons()

        Get shouldConsiderArrivalThresholdForPolygons. Whether to also consider arrival threshold for polygon destinations. When this is enabled, arrival is triggered if the path remaining until the polygon entry is shorter than arrivalThresholdInMetres parameter. This is useful to make arrival easier, especially for small destination polygons. Default is true

      • getSlightTurnThresholdInDegrees

         float getSlightTurnThresholdInDegrees()

        Get slightTurnThresholdInDegrees. A turn is assumed to be slight up to this angle of inflection (in radians) Default is 1.0471975511965976

      • getStraightDirectionAngle

         float getStraightDirectionAngle()

        Get straightDirectionAngle. Angle to decide if the user needs to follow a straight direction (in radians) Default is 1.0471975511965976

      • getStraightInflectionThresholdInDegrees

         float getStraightInflectionThresholdInDegrees()

        Get straightInflectionThresholdInDegrees. A path between 3 nodes is assumed straight up to this angle of inflection (in radians) Default is 0.5235987755982988

      • getTypicalFacilityTransitionTime

         float getTypicalFacilityTransitionTime()

        Get typicalFacilityTransitionTime. Default building transition time in minutes Default is 15.0

      • getTypicalLevelTransitionTime

         float getTypicalLevelTransitionTime()

        Get typicalLevelTransitionTime. Default level transition time in minutes Default is 1.0

      • getTypicalWalkingSpeed

         float getTypicalWalkingSpeed()

        Get typicalWalkingSpeed. Typical walking speed in meters per minutes, to be used for path analytics calculation Default is 60.0

      • getWallAvoidanceOffset

         float getWallAvoidanceOffset()

        Get wallAvoidanceOffset. Distance to preserve between the smoothed path and the obstacles (in meters) Default is 2.0

      • getWallAvoidanceOffsetGradualStartDistance

         float getWallAvoidanceOffsetGradualStartDistance()

        Get wallAvoidanceOffsetGradualStartDistance. Obstacle avoidance offset will gradually increase from 0 to its final value for this initial distance Default is 10.0

      • getWallAvoidanceOffsetInMeters

         float getWallAvoidanceOffsetInMeters()

        Get wallAvoidanceOffsetInMeters. Distance to preserve between the smoothed path and the obstacles (in meters) Default is 2.0