com.navigine.idl.java.RouteSimulator Class Reference

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

Inheritance diagram for com.navigine.idl.java.RouteSimulator:

Public Member Functions
abstract boolean	setGeometry (ArrayList< LocationPolyline > polylines)
	Geometry in walk order. A later polyline may be on another floor.
abstract void	setSpeed (float metersPerSecond)
	Walking speed in meters per second. Default is 1.4. Zero pauses motion.
abstract float	speed ()
	Current speed in meters per second.
abstract boolean	start ()
	Starts from the beginning, or continues when already active.
abstract void	stop ()
	Stops and rewinds to the start. Does not emit onFinished.
abstract boolean	active ()
	True while a walk is in progress.
abstract RouteSimulatorSample	sample ()
	Latest sample, or null before the first tick.
abstract void	addListener (RouteSimulatorListener listener)
abstract void	removeListener (RouteSimulatorListener listener)
abstract boolean	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 24 of file RouteSimulator.java.

Member Function Documentation

active()

abstract boolean com.navigine.idl.java.RouteSimulator.active ( )

abstract

True while a walk is in progress.

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

addListener()

abstract void com.navigine.idl.java.RouteSimulator.addListener ( RouteSimulatorListener listener )

abstract

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

isValid()

abstract boolean com.navigine.idl.java.RouteSimulator.isValid ( )

abstract

Tells if this RouteSimulator is valid or not. Any other method (except for this one) called on an invalid RouteSimulator will throw java.lang.RuntimeException.

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

removeListener()

abstract void com.navigine.idl.java.RouteSimulator.removeListener ( RouteSimulatorListener listener )

abstract

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

sample()

abstract RouteSimulatorSample com.navigine.idl.java.RouteSimulator.sample ( )

abstract

Latest sample, or null before the first tick.

Java code snippet:

            RouteSimulatorSample sample = routeSimulator.sample();
            if (sample != null) {
                System.out.println("Walk advance: " + sample.getAdvance() + " m");
            }

Kotlin code snippet:

                val sample = routeSimulator.sample
                println("Walk advance: ${sample?.advance} m")

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

setGeometry()

abstract boolean com.navigine.idl.java.RouteSimulator.setGeometry ( ArrayList< LocationPolyline > polylines )

abstract

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

Returns

false when fewer than two distinct points were given.

Java code snippet:

            List<GlobalPoint> walkPoints = new ArrayList<>();
            walkPoints.add(new GlobalPoint(55.751, 37.618));
            walkPoints.add(new GlobalPoint(55.752, 37.618));
            routeSimulator.setGeometry(Collections.singletonList(new LocationPolyline(walkPoints, null)));

Kotlin code snippet:

                val walk = LocationPolyline(
                    listOf(GlobalPoint(55.751, 37.618), GlobalPoint(55.752, 37.618)),
                    null,
                )
                routeSimulator.setGeometry(listOf(walk))

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

setSpeed()

abstract void com.navigine.idl.java.RouteSimulator.setSpeed ( float metersPerSecond )

abstract

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

Java code snippet:

            routeSimulator.setSpeed(1.4f);

Kotlin code snippet:

                routeSimulator.setSpeed(1.4f)

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

speed()

abstract float com.navigine.idl.java.RouteSimulator.speed ( )

abstract

Current speed in meters per second.

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

start()

abstract boolean com.navigine.idl.java.RouteSimulator.start ( )

abstract

Starts from the beginning, or continues when already active.

Returns

false when geometry is missing.

Java code snippet:

            boolean started = routeSimulator.start();
            System.out.println("Route walk started: " + started);

Kotlin code snippet:

                val started = routeSimulator.start()
                println("Route walk started: $started")

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

stop()

abstract void com.navigine.idl.java.RouteSimulator.stop ( )

abstract

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

Reimplemented in com.navigine.idl.java.internal.RouteSimulatorBinding.

---

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

• RouteSimulator.java