class is used for storing the route path between the two points on the location.
More...
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 20 of file RoutePath.java.
◆ getEvents()
| abstract ArrayList< RouteEvent > com.navigine.idl.java.RoutePath.getEvents |
( |
| ) |
|
|
abstract |
List of consecutive incoming events RouteEvent.
- Returns
◆ getLength()
| abstract float com.navigine.idl.java.RoutePath.getLength |
( |
| ) |
|
|
abstract |
Total lenth of the route path in meters.
- Returns
◆ getPoints()
| abstract ArrayList< LocationPoint > com.navigine.idl.java.RoutePath.getPoints |
( |
| ) |
|
|
abstract |
List of consecutive points. com.navigine.idl.java.LocationPoint.
- Returns
- Note
- points could be on different sublocations if target sublocation is different from the starting one
◆ head()
| abstract RoutePath com.navigine.idl.java.RoutePath.head |
( |
float | advance | ) |
|
|
abstract |
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()
| abstract RoutePath com.navigine.idl.java.RoutePath.tail |
( |
float | advance | ) |
|
|
abstract |
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.
The documentation for this class was generated from the following file:
