class is used for storing the route path between the two points on the location. More...

Inherits Finalizable.

Public Member Functions
RoutePath	head (double advance)
	Returns the leading segment of the route.

RoutePath	tail (double advance)
	Returns the remaining segment of the route.

Public Attributes
double get	length
	Total lenth of the route path in meters.

List< RouteEvent > get	events
	List of consecutive incoming events RouteEvent.

List< LocationPoint > get	points
	List of consecutive points. LocationPoint.

Detailed Description

class is used for storing the route path between the two points on the location.

Referenced from: AsyncRouteListener, AsyncRouteManager, Location, RouteListener, RouteManager

Definition at line 23 of file route_path.dart.

Member Function Documentation

◆ head()

RoutePath RoutePath.head ( double advance )

Returns the leading segment of the route.

Returns the portion of the route from the start up to the specified advance distance along the route. If advance exceeds the total route length, the entire route is returned.

Parameters

advance Distance along the route (in meters).

Returns: The covered (passed) segment of the route (from start to advance), or nil if the segment is empty.

◆ tail()

RoutePath RoutePath.tail ( double advance )

Returns the remaining segment of the route.

Returns the portion of the route starting from the specified advance distance to the end of the route. If advance is less than or equal to zero, the entire route is returned.

Parameters

advance Distance along the route (in meters).

Returns: The remaining segment of the route (from advance to end), or nil if the segment is empty.

Member Data Documentation

◆ events

List<RouteEvent> get RoutePath.events

List of consecutive incoming events RouteEvent.

Definition at line 58 of file route_path.dart.

◆ length

double get RoutePath.length

Total lenth of the route path in meters.

Definition at line 54 of file route_path.dart.

◆ points

List<LocationPoint> get RoutePath.points

List of consecutive points. LocationPoint.

Note: points could be on different sublocations if target sublocation is different from the starting one

Definition at line 64 of file route_path.dart.

The documentation for this class was generated from the following file:

route_path.dart

Public Member Functions

Public Attributes