com.navigine.idl.java.GuidanceCamera Class Reference

Drives the map camera from a RouteLayer and exposes the next instruction. Does not draw the route. More...

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

Public Member Functions
abstract void	setMode (GuidanceCameraMode mode)
	Sets Free / Following / Overview.
abstract GuidanceCameraMode	mode ()
	Current mode.
abstract void	set2DMode (boolean enabled)
	Forces a top-down camera (tilt 0) in Following and Overview. When false, Following uses a fixed forward tilt.
abstract boolean	is2DMode ()
	Returns true when top-down guidance is enabled.
abstract void	setActive (boolean active)
	When false, the camera is not moved. Instructions still update.
abstract boolean	isActive ()
	Returns true when this controller may move the camera.
abstract RouteInstruction	instruction ()
	Latest next instruction, or null.
abstract void	addListener (GuidanceListener listener)
	Adds a listener for mode and instruction changes.
abstract void	removeListener (GuidanceListener listener)
	Removes a previously added listener.
abstract boolean	isValid ()

Detailed Description

Drives the map camera from a RouteLayer and exposes the next instruction. Does not draw the route.

Overview uses the window focus rect, so set LocationWindow.focusRect for chrome (floor selector, banner) before switching to OVERVIEW.

Referenced from NavigineSdk.

Definition at line 23 of file GuidanceCamera.java.

Member Function Documentation

addListener()

abstract void com.navigine.idl.java.GuidanceCamera.addListener ( GuidanceListener listener )

abstract

Adds a listener for mode and instruction changes.

Java code snippet:

            guidanceCamera.addListener(new GuidanceListener() {
                @Override
                public void onCameraModeChanged(GuidanceCameraMode mode) {
                    System.out.println("Guidance camera mode: " + mode);
                }
 
                @Override
                public void onInstructionChanged(RouteInstruction instruction) {
                    System.out.println("Next: " + (instruction == null ? "none" : instruction.getTitle()));
                }
            });

Kotlin code snippet:

                guidanceCamera?.addListener(object : GuidanceListener() {
                    override fun onCameraModeChanged(mode: GuidanceCameraMode) {
                        println("Guidance camera mode: $mode")
                    }
 
                    override fun onInstructionChanged(instruction: RouteInstruction?) {
                        println("Next: ${instruction?.title} ${instruction?.distance} m")
                    }
                })

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

instruction()

abstract RouteInstruction com.navigine.idl.java.GuidanceCamera.instruction ( )

abstract

Latest next instruction, or null.

Java code snippet:

            RouteInstruction next = guidanceCamera.instruction();
            if (next != null) {
                System.out.println("Next instruction: " + next.getTitle() + " " + next.getDistance() + " m");
            }

Kotlin code snippet:

                val next = guidanceCamera?.instruction
                println("Next instruction: ${next?.title} ${next?.distance} m")

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

is2DMode()

abstract boolean com.navigine.idl.java.GuidanceCamera.is2DMode ( )

abstract

Returns true when top-down guidance is enabled.

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

isActive()

abstract boolean com.navigine.idl.java.GuidanceCamera.isActive ( )

abstract

Returns true when this controller may move the camera.

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

isValid()

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

abstract

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

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

mode()

abstract GuidanceCameraMode com.navigine.idl.java.GuidanceCamera.mode ( )

abstract

Current mode.

Java code snippet:

            System.out.println("Guidance mode: " + guidanceCamera.mode());

Kotlin code snippet:

                println("Guidance mode: ${guidanceCamera?.mode}")

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

removeListener()

abstract void com.navigine.idl.java.GuidanceCamera.removeListener ( GuidanceListener listener )

abstract

Removes a previously added listener.

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

set2DMode()

abstract void com.navigine.idl.java.GuidanceCamera.set2DMode ( boolean enabled )

abstract

Forces a top-down camera (tilt 0) in Following and Overview. When false, Following uses a fixed forward tilt.

Java code snippet:

            guidanceCamera.set2DMode(false);

Kotlin code snippet:

                guidanceCamera?.set2DMode(false)

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

setActive()

abstract void com.navigine.idl.java.GuidanceCamera.setActive ( boolean active )

abstract

When false, the camera is not moved. Instructions still update.

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

setMode()

abstract void com.navigine.idl.java.GuidanceCamera.setMode ( GuidanceCameraMode mode )

abstract

Sets Free / Following / Overview.

Java code snippet:

            guidanceCamera.setMode(GuidanceCameraMode.FOLLOWING);

Kotlin code snippet:

                guidanceCamera?.setMode(GuidanceCameraMode.FOLLOWING)

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

---

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

• GuidanceCamera.java