Layer that automatically renders current user position (arrow and accuracy circle) on the map. Provides visibility and anchoring controls. Referenced from LocationView. More...

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

Public Member Functions
abstract void	setVisible (boolean visible)
	Shows or hides user location layer.

abstract boolean	isVisible ()
	Returns true if user location layer is visible.

abstract void	setAnchor (android.graphics.PointF anchor)
	Sets anchor point for user indicator in screen pixels.

abstract void	resetAnchor ()
	Resets anchor to default (center).

abstract boolean	anchorEnabled ()
	Returns true if custom anchor is enabled.

abstract void	setHeadingModeActive (boolean active)
	Enables or disables heading-up mode while the user location layer is anchored.

abstract boolean	headingModeActive ()
	Returns true if heading-up mode is enabled. Same as followMode() == HEADING.

abstract void	setFollowMode (UserLocationFollowMode mode)
	Sets how the camera follows the user. NONE stops following and keeps a previously set anchor point. POSITION, HEADING and COURSE follow even without setAnchor (screen center). setAnchor() from NONE switches to POSITION. resetAnchor() switches to NONE. setHeadingModeActive(true) switches to HEADING.

abstract UserLocationFollowMode	followMode ()
	Returns the current follow mode.

abstract void	setArrowBitmap (com.navigine.image.ImageProvider bitmap)
	Replaces the heading arrow bitmap. Null restores the built-in heading fan.

abstract void	setAccuracyColor (int color)
	Sets the accuracy-circle fill. Default is a translucent blue.

abstract boolean	isValid ()

Detailed Description

Layer that automatically renders current user position (arrow and accuracy circle) on the map. Provides visibility and anchoring controls. Referenced from LocationView.

Definition at line 17 of file UserLocationLayer.java.

Member Function Documentation

◆ anchorEnabled()

abstract boolean com.navigine.idl.java.UserLocationLayer.anchorEnabled ( )

abstract

Returns true if custom anchor is enabled.

Java code snippet:

boolean anchorEnabled = userLocationLayer.anchorEnabled();

System.out.println("Anchor enabled: " + anchorEnabled);

Kotlin code snippet:

val anchorEnabled = userLocationLayer!!.anchorEnabled

println("Anchor enabled: $anchorEnabled")

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

◆ followMode()

abstract UserLocationFollowMode com.navigine.idl.java.UserLocationLayer.followMode ( )

abstract

Returns the current follow mode.

Java code snippet:

UserLocationFollowMode followMode = userLocationLayer.followMode();

System.out.println("Follow mode: " + followMode);

Kotlin code snippet:

val followMode = userLocationLayer!!.followMode

println("Follow mode: $followMode")

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

◆ headingModeActive()

abstract boolean com.navigine.idl.java.UserLocationLayer.headingModeActive ( )

abstract

Returns true if heading-up mode is enabled. Same as followMode() == HEADING.

Java code snippet:

boolean headingModeActive = userLocationLayer.headingModeActive();

System.out.println("Heading-up mode active: " + headingModeActive);

Kotlin code snippet:

val headingModeActive = userLocationLayer!!.headingModeActive

println("Heading-up mode active: $headingModeActive")

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

◆ isValid()

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

abstract

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

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

◆ isVisible()

abstract boolean com.navigine.idl.java.UserLocationLayer.isVisible ( )

abstract

Returns true if user location layer is visible.

Java code snippet:

boolean visible = userLocationLayer.isVisible();

System.out.println("User location layer is visible: " + visible);

Kotlin code snippet:

val visible = userLocationLayer!!.isVisible

println("User location layer is visible: $visible")

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

◆ resetAnchor()

abstract void com.navigine.idl.java.UserLocationLayer.resetAnchor ( )

abstract

Resets anchor to default (center).

Java code snippet:

userLocationLayer.resetAnchor();

System.out.println("Anchor reset to default");

Kotlin code snippet:

userLocationLayer!!.resetAnchor()

println("Anchor reset to default")

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

◆ setAccuracyColor()

abstract void com.navigine.idl.java.UserLocationLayer.setAccuracyColor ( int color )

abstract

Sets the accuracy-circle fill. Default is a translucent blue.

Java code snippet:

userLocationLayer.setAccuracyColor(0x4230AAD9);

System.out.println("Accuracy circle color updated");

Kotlin code snippet:

userLocationLayer!!.setAccuracyColor(0x4230AAD9)

println("Accuracy circle color updated")

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

◆ setAnchor()

abstract void com.navigine.idl.java.UserLocationLayer.setAnchor ( android.graphics.PointF anchor )

abstract

Sets anchor point for user indicator in screen pixels.

Java code snippet:

        ScreenPoint anchor = new ScreenPoint(100.0f, 200.0f);
        userLocationLayer.setAnchor(anchor);
        System.out.println("Set user location anchor to: (" + anchor.getX() + ", " + anchor.getY() + ")");

Kotlin code snippet:

        val anchor = ScreenPoint(100.0f, 200.0f)
        userLocationLayer!!.setAnchor(anchor)
        println("Set user location anchor to: (${anchor.x}, ${anchor.y})")

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

◆ setArrowBitmap()

abstract void com.navigine.idl.java.UserLocationLayer.setArrowBitmap ( com.navigine.image.ImageProvider bitmap )

abstract

Replaces the heading arrow bitmap. Null restores the built-in heading fan.

Java code snippet:

        userLocationLayer.setArrowBitmap(ImageProvider.fromFile("/path/to/arrow.png", true));
        userLocationLayer.setArrowBitmap(null);
        System.out.println("Custom arrow bitmap cleared");

Kotlin code snippet:

        userLocationLayer!!.setArrowBitmap(ImageProvider.fromFile("/path/to/arrow.png", true))
        userLocationLayer!!.setArrowBitmap(null)
        println("Custom arrow bitmap cleared")

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

◆ setFollowMode()

abstract void com.navigine.idl.java.UserLocationLayer.setFollowMode ( UserLocationFollowMode mode )

abstract

Sets how the camera follows the user. NONE stops following and keeps a previously set anchor point. POSITION, HEADING and COURSE follow even without setAnchor (screen center). setAnchor() from NONE switches to POSITION. resetAnchor() switches to NONE. setHeadingModeActive(true) switches to HEADING.

Java code snippet:

userLocationLayer.setFollowMode(UserLocationFollowMode.HEADING);

System.out.println("Follow mode set to heading");

Kotlin code snippet:

userLocationLayer!!.setFollowMode(UserLocationFollowMode.HEADING)

println("Follow mode set to heading")

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

◆ setHeadingModeActive()

abstract void com.navigine.idl.java.UserLocationLayer.setHeadingModeActive ( boolean active )

abstract

Enables or disables heading-up mode while the user location layer is anchored.

When enabled and a location heading is available, the map camera rotates to keep the user's heading pointed toward the top of the screen. Without an anchor the location icon keeps rotating independently.

Java code snippet:

userLocationLayer.setHeadingModeActive(true);

System.out.println("Heading-up mode enabled");

Kotlin code snippet:

userLocationLayer!!.setHeadingModeActive(true)

println("Heading-up mode enabled")

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

◆ setVisible()

abstract void com.navigine.idl.java.UserLocationLayer.setVisible ( boolean visible )

abstract

Shows or hides user location layer.

Java code snippet:

userLocationLayer.setVisible(true);

System.out.println("User location layer set visible");

Kotlin code snippet:

userLocationLayer!!.setVisible(true)

println("User location layer set visible")

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

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

UserLocationLayer.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ anchorEnabled()

◆ followMode()

◆ headingModeActive()

◆ isValid()

◆ isVisible()

◆ resetAnchor()

◆ setAccuracyColor()

◆ setAnchor()

◆ setArrowBitmap()

◆ setFollowMode()

◆ setHeadingModeActive()

◆ setVisible()