Groups IconMapObject instances into clusters depending on zoom and proximity. More...

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

Public Member Functions
abstract boolean	addIconMapObject (IconMapObject iconMapObject)
	Adds an icon map object to the cluster controller.

abstract boolean	removeIconMapObject (IconMapObject iconMapObject)
	Removes an icon map object from the cluster controller.

abstract void	clear ()
	Removes all icon map objects from the controller and destroys visible cluster markers.

abstract void	setEnabled (boolean enabled)
	Enables or disables clustering. Default: true.

abstract boolean	isEnabled ()
	Returns whether clustering is enabled.

abstract void	setRadius (float radius)
	Cluster radius in density-independent pixels. Default: 40.

abstract float	getRadius ()
	Returns cluster radius in density-independent pixels.

abstract boolean	setInteractive (boolean interactive)
	Specifies whether cluster markers can be picked. Default: true.

abstract boolean	setClusterSize (float width, float height)
	Specifies the size of the default cluster icon in pixels.

abstract void	addListener (ClusterMapObjectControllerListener listener)
	Adds a listener for cluster lifecycle events ClusterMapObjectControllerListener.

abstract void	removeListener (ClusterMapObjectControllerListener listener)
	Removes a previously added listener.

abstract ArrayList< ClusterMapObject >	getClusters ()
	Returns a snapshot of currently visible clusters.

abstract boolean	isValid ()

Detailed Description

Groups IconMapObject instances into clusters depending on zoom and proximity.

Referenced from LocationWindow.

Register icons with addIconMapObject, then optionally customize cluster appearance in ClusterMapObjectControllerListener (onClusterCreated) and ClusterMapObjectListener (onClusterChanged).

Definition at line 24 of file ClusterMapObjectController.java.

Member Function Documentation

◆ addIconMapObject()

abstract boolean com.navigine.idl.java.ClusterMapObjectController.addIconMapObject ( IconMapObject iconMapObject )

abstract

Adds an icon map object to the cluster controller.

Parameters

iconMapObject Icon to cluster IconMapObject. Must be added to the same LocationWindow via addIconMapObject.

Returns: true if the icon was added, false otherwise.

Java code snippet:

        boolean added1 = clusterMapObjectController.addIconMapObject(clusterIcon1);
        boolean added2 = clusterMapObjectController.addIconMapObject(clusterIcon2);
        System.out.println("Registered icons for clustering: " + added1 + ", " + added2);

Kotlin code snippet:

        val added1 = controller.addIconMapObject(clusterIcon1)
        val added2 = controller.addIconMapObject(clusterIcon2)
        println("Registered icons for clustering: $added1, $added2")

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

◆ addListener()

abstract void com.navigine.idl.java.ClusterMapObjectController.addListener ( ClusterMapObjectControllerListener listener )

abstract

Adds a listener for cluster lifecycle events ClusterMapObjectControllerListener.

Parameters

listener Listener instance.

Java code snippet:

clusterMapObjectController.addListener(clusterMapObjectControllerListener);

System.out.println("Added cluster map object controller listener");

Kotlin code snippet:

controller.addListener(clusterMapObjectControllerListener!!)

println("Added cluster map object listener")

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

◆ clear()

abstract void com.navigine.idl.java.ClusterMapObjectController.clear ( )

abstract

Removes all icon map objects from the controller and destroys visible cluster markers.

Java code snippet:

clusterMapObjectController.clear();

System.out.println("Cleared cluster controller");

Kotlin code snippet:

controller.clear()

println("Cleared cluster controller")

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

◆ getClusters()

abstract ArrayList< ClusterMapObject > com.navigine.idl.java.ClusterMapObjectController.getClusters ( )

abstract

Returns a snapshot of currently visible clusters.

Java code snippet:

List<ClusterMapObject> clusters = clusterMapObjectController.getClusters();

System.out.println("Visible clusters: " + clusters.size());

Kotlin code snippet:

val clusters = controller.getClusters()

println("Visible clusters: ${clusters.size}")

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

◆ getRadius()

abstract float com.navigine.idl.java.ClusterMapObjectController.getRadius ( )

abstract

Returns cluster radius in density-independent pixels.

Java code snippet:

float clusterRadius = clusterMapObjectController.getRadius();

System.out.println("Cluster radius: " + clusterRadius);

Kotlin code snippet:

val clusterRadius = controller.getRadius()

println("Cluster radius: $clusterRadius")

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

◆ isEnabled()

abstract boolean com.navigine.idl.java.ClusterMapObjectController.isEnabled ( )

abstract

Returns whether clustering is enabled.

Java code snippet:

boolean clusteringEnabled = clusterMapObjectController.isEnabled();

System.out.println("Clustering is enabled: " + clusteringEnabled);

Kotlin code snippet:

val clusteringEnabled = controller.isEnabled

println("Clustering is enabled: $clusteringEnabled")

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

◆ isValid()

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

abstract

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

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

◆ removeIconMapObject()

abstract boolean com.navigine.idl.java.ClusterMapObjectController.removeIconMapObject ( IconMapObject iconMapObject )

abstract

Removes an icon map object from the cluster controller.

Parameters

iconMapObject Icon to remove.

Returns: true if the icon was removed, false otherwise.

Java code snippet:

boolean removed = clusterMapObjectController.removeIconMapObject(clusterIcon1);

System.out.println("Removed icon from cluster controller: " + removed);

Kotlin code snippet:

val removed = controller.removeIconMapObject(it)

println("Removed icon from cluster controller: $removed")

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

◆ removeListener()

abstract void com.navigine.idl.java.ClusterMapObjectController.removeListener ( ClusterMapObjectControllerListener listener )

abstract

Removes a previously added listener.

Parameters

listener Listener instance to remove.

Java code snippet:

clusterMapObjectController.removeListener(clusterMapObjectControllerListener);

System.out.println("Removed cluster map object controller listener");

Kotlin code snippet:

controller.removeListener(clusterMapObjectControllerListener!!)

println("Removed cluster map object listener")

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

◆ setClusterSize()

abstract boolean com.navigine.idl.java.ClusterMapObjectController.setClusterSize	(	float	width,
		float	height )

abstract

Specifies the size of the default cluster icon in pixels.

Returns: true if the operation is successful, false otherwise.

Java code snippet:

boolean sizeSuccess = clusterMapObjectController.setClusterSize(32.0f, 32.0f);

System.out.println("Set default cluster icon size: " + sizeSuccess);

Kotlin code snippet:

val sizeSuccess = controller.setClusterSize(32.0f, 32.0f)

println("Set default cluster icon size: $sizeSuccess")

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

◆ setEnabled()

abstract void com.navigine.idl.java.ClusterMapObjectController.setEnabled ( boolean enabled )

abstract

Enables or disables clustering. Default: true.

Java code snippet:

clusterMapObjectController.setEnabled(true);

System.out.println("Clustering enabled");

Kotlin code snippet:

controller.setEnabled(true)

println("Clustering enabled")

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

◆ setInteractive()

abstract boolean com.navigine.idl.java.ClusterMapObjectController.setInteractive ( boolean interactive )

abstract

Specifies whether cluster markers can be picked. Default: true.

Returns: true if the operation is successful, false otherwise.

Java code snippet:

boolean interactiveSuccess = clusterMapObjectController.setInteractive(true);

System.out.println("Set cluster markers interactive: " + interactiveSuccess);

Kotlin code snippet:

val interactiveSuccess = controller.setInteractive(true)

println("Set cluster markers interactive: $interactiveSuccess")

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

◆ setRadius()

abstract void com.navigine.idl.java.ClusterMapObjectController.setRadius ( float radius )

abstract

Cluster radius in density-independent pixels. Default: 40.

Java code snippet:

clusterMapObjectController.setRadius(40.0f);

System.out.println("Set cluster radius to 40 px");

Kotlin code snippet:

controller.setRadius(40.0f)

println("Set cluster radius to 40 px")

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

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

ClusterMapObjectController.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ addIconMapObject()

◆ addListener()

◆ clear()

◆ getClusters()

◆ getRadius()

◆ isEnabled()

◆ isValid()

◆ removeIconMapObject()

◆ removeListener()

◆ setClusterSize()

◆ setEnabled()

◆ setInteractive()

◆ setRadius()