RouteSimulator Class Reference

Walks a polyline at a constant speed for demos and guidance QA. More...

Inherits Finalizable.

Public Member Functions
bool	setGeometry (List< LocationPolyline > polylines)
	Geometry in walk order. A later polyline may be on another floor.
void	setSpeed (double metersPerSecond)
	Walking speed in meters per second. Default is 1.4. Zero pauses motion.
double	speed ()
	Current speed in meters per second.
bool	start ()
	Starts from the beginning, or continues when already active.
void	stop ()
	Stops and rewinds to the start. Does not emit onFinished.
bool	active ()
	True while a walk is in progress.
RouteSimulatorSample	sample ()
	Latest sample, or null before the first tick.
void	addListener (RouteSimulatorListener listener)
void	removeListener (RouteSimulatorListener listener)
bool	isValid ()

Detailed Description

Walks a polyline at a constant speed for demos and guidance QA.

Distinct from MeasurementManager signal generators. Does not publish a navigation position and does not move the user-location layer. Hosts apply sample to an icon or other preview.

Created with NavigineSdk getRouteSimulator.

Definition at line 33 of file route_simulator.dart.

Member Function Documentation

active()

bool RouteSimulator.active

(

)

True while a walk is in progress.

addListener()

void RouteSimulator.addListener

(

RouteSimulatorListener

listener

)

isValid()

bool RouteSimulator.isValid

(

)

removeListener()

void RouteSimulator.removeListener

(

RouteSimulatorListener

listener

)

sample()

RouteSimulatorSample RouteSimulator.sample

(

)

Latest sample, or null before the first tick.

Dart code snippet:

      final sample = routeSimulator?.sample();
      print('Walk advance: ${sample?.advance} m');

setGeometry()

bool RouteSimulator.setGeometry

(

List< LocationPolyline >

polylines

)

Geometry in walk order. A later polyline may be on another floor.

Returns

false when fewer than two distinct points were given.

Dart code snippet:

      final walk = LocationPolyline(
        [GlobalPoint(55.751, 37.618), GlobalPoint(55.752, 37.618)],
        null,
      );
      routeSimulator?.setGeometry([walk]);

setSpeed()

void RouteSimulator.setSpeed

(

double

metersPerSecond

)

Walking speed in meters per second. Default is 1.4. Zero pauses motion.

Dart code snippet:

      routeSimulator?.setSpeed(1.4);

speed()

double RouteSimulator.speed

(

)

Current speed in meters per second.

start()

bool RouteSimulator.start

(

)

Starts from the beginning, or continues when already active.

Returns

false when geometry is missing.

Dart code snippet:

      final started = routeSimulator?.start() ?? false;
      print('Route walk started: $started');

stop()

void RouteSimulator.stop

(

)

Stops and rewinds to the start. Does not emit onFinished.

---

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

• route_simulator.dart