Interface UserLocationLayer

Package world.mappable.mapkit.user_location

interface UserLocationLayer

Use the UserLocationLayer interface to manage the location icon: its appearance, following mode, data source and so on.

SummarySummary

MethodsMethods

Type and modifiers	Method and Description
void	setVisible(boolean on) Sets user location visibility.
boolean	isVisible() Checks if user location is visible.
boolean	isHeadingModeActive() Enables/disables heading mode.
void	setHeadingModeActive(boolean headingModeActive)
void	setAnchor(@NonNull android.graphics.PointF anchorNormal,           @NonNull android.graphics.PointF anchorCourse) Sets the anchor to the specified position in pixels and enables Anchor mode.
void	resetAnchor() Resets anchor mode.
boolean	isAnchorEnabled() Returns true if anchor mode is set, and false otherwise.
boolean	isAutoZoomEnabled() Enables/disables auto zoom.
void	setAutoZoomEnabled(boolean autoZoomEnabled)
CameraPosition	cameraPosition() Calculates the camera position that projects the current location into view.
void	setSource(@Nullable LocationViewSource source) Sets/gets the data source.
void	setDefaultSource() Sets the data source with the global location manager
void	setTapListener(@Nullable UserLocationTapListener tapListener) Sets/resets the tap listener.
void	setObjectListener(@Nullable UserLocationObjectListener objectListener) Sets/resets the object listener.
boolean	isValid() Tells if this UserLocationLayer is valid or not.

MethodsMethods

setVisiblesetVisible

void setVisible(boolean on)

Sets user location visibility.

isVisibleisVisible

boolean isVisible()

Checks if user location is visible.

isHeadingModeActiveisHeadingModeActive

boolean isHeadingModeActive()

Enables/disables heading mode.

If heading mode is enabled, the map is rotated. If heading mode is disabled, the location icon is rotated.

setHeadingModeActivesetHeadingModeActive

void setHeadingModeActive(boolean headingModeActive)

setAnchorsetAnchor

void setAnchor(@NonNull android.graphics.PointF anchorNormal,                @NonNull android.graphics.PointF anchorCourse)

Sets the anchor to the specified position in pixels and enables Anchor mode.

(0, 0) denotes the top-left corner of the screen.

Parameters
anchorNormal	The anchor position when the app is not on a steady course; usually, the center of the screen.
anchorCourse	An anchor position near the bottom line for steady course mode.

resetAnchorresetAnchor

void resetAnchor()

Resets anchor mode.

isAnchorEnabledisAnchorEnabled

boolean isAnchorEnabled()

Returns true if anchor mode is set, and false otherwise.

isAutoZoomEnabledisAutoZoomEnabled

boolean isAutoZoomEnabled()

Enables/disables auto zoom.

setAutoZoomEnabledsetAutoZoomEnabled

void setAutoZoomEnabled(boolean autoZoomEnabled)

cameraPositioncameraPosition

@Nullable CameraPosition cameraPosition()

Calculates the camera position that projects the current location into view.

If the current location is unknown, returns none. If the current location is known, returns the camera position that displays the location position.

setSourcesetSource

void setSource(@Nullable LocationViewSource source)

Sets/gets the data source.

setDefaultSourcesetDefaultSource

void setDefaultSource()

Sets the data source with the global location manager

setTapListenersetTapListener

void setTapListener(@Nullable UserLocationTapListener tapListener)

Sets/resets the tap listener.

The class does not retain the object in the 'tapListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.

setObjectListenersetObjectListener

void setObjectListener(@Nullable UserLocationObjectListener objectListener)

Sets/resets the object listener.

The class does not retain the object in the 'objectListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.

isValidisValid

boolean isValid()

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. An instance becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now. Please refer to general docs about the interface for details on its invalidation.