Represents a polyline object with points placed along it on the location view. More...

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

Public Member Functions
abstract boolean	setPolyLine (LocationPolyline polyline)
	Method is used to specify the source polyline for the points.

abstract boolean	setColor (float red, float green, float blue, float alpha)
	Method is used to specify the color of the object.

abstract boolean	setSize (float width, float height)
	Method is used to specify the size of the points.

abstract boolean	setCollisionEnabled (boolean enabled)
	Method is used to enable or disable collision detection for the icon.

abstract boolean	setPlacement (Placement placement)
	Method is used to specify the placement mode for points along the polyline.

abstract boolean	setPlacementMinRatio (float ratio)
	Method is used to specify the minimum ratio of the polyline length for point placement.

abstract boolean	setPlacementSpacing (float spacing)
	Method is used to specify the spacing between points for spaced placement.

abstract boolean	setRepeatDistance (float distance)
	Method is used to specify the distance interval for repeating points along the polyline.

abstract boolean	setRepeatGroup (int group)
	Method is used to specify the group identifier for repeating points.

abstract boolean	setPriority (float priority)
	Method is used to specify the priority of the icon.

abstract boolean	isValid ()

abstract int	getId ()
	Gets the unique identifier of the map object.

abstract MapObjectType	getType ()
	Gets the type of the map object.

abstract byte[]	getData ()
	Gets the user-defined data associated with the map object.

abstract boolean	setVisible (boolean visible)
	Method is used to specify the visibility of the map object.

abstract boolean	setInteractive (boolean interactive)
	Method is used to specify whether the map object can be interacted with.

abstract void	setData (byte[] data)
	Method is used to set user-defined data for the map object.

abstract boolean	setTitle (String title)
	Method is used to set the title of the map object.

abstract boolean	setAlpha (float alpha)
	Method is used to set the opacity of the map object.

Detailed Description

Represents a polyline object with points placed along it on the location view.

Referenced from LocationWindow.

Definition at line 16 of file DottedPolylineMapObject.java.

Member Function Documentation

◆ getData()

abstract byte[] com.navigine.idl.java.MapObject.getData ( )

abstractinherited

Gets the user-defined data associated with the map object.

Returns: The data stored in the map object.

Java code snippet:

            // Get custom data
            Map<String, String> retrievedData = circleMapObject.getData();
            System.out.println("Circle custom data: " + retrievedData);

Kotlin code snippet:

            // Get custom data
            val retrievedData = circleMapObject!!.data
            println("Circle custom data: $retrievedData")

Reimplemented in com.navigine.idl.java.internal.CircleMapObjectBinding, com.navigine.idl.java.internal.ClusterMapObjectBinding, com.navigine.idl.java.internal.DottedPolylineMapObjectBinding, com.navigine.idl.java.internal.IconMapObjectBinding, com.navigine.idl.java.internal.MapObjectBinding, com.navigine.idl.java.internal.ModelMapObjectBinding, com.navigine.idl.java.internal.PolygonMapObjectBinding, and com.navigine.idl.java.internal.PolylineMapObjectBinding.

◆ getId()

abstract int com.navigine.idl.java.MapObject.getId ( )

abstractinherited

Gets the unique identifier of the map object.

Returns: The unique identifier of the map object.

Java code snippet:

            // Get object ID
            int objectId = circleMapObject.getId();
            System.out.println("Circle object ID: " + objectId);

Kotlin code snippet:

            // Get object ID
            val objectId = circleMapObject!!.id
            println("Circle object ID: $objectId")

Reimplemented in com.navigine.idl.java.internal.CircleMapObjectBinding, com.navigine.idl.java.internal.ClusterMapObjectBinding, com.navigine.idl.java.internal.DottedPolylineMapObjectBinding, com.navigine.idl.java.internal.IconMapObjectBinding, com.navigine.idl.java.internal.MapObjectBinding, com.navigine.idl.java.internal.ModelMapObjectBinding, com.navigine.idl.java.internal.PolygonMapObjectBinding, and com.navigine.idl.java.internal.PolylineMapObjectBinding.

◆ getType()

abstract MapObjectType com.navigine.idl.java.MapObject.getType ( )

abstractinherited

Gets the type of the map object.

Returns: The type of the map object MapObjectType.

Java code snippet:

            // Get object type
            String objectTypeString = circleMapObject.getType();
            System.out.println("Circle object type: " + objectTypeString);

Kotlin code snippet:

            // Get object type
            val objectTypeString = circleMapObject!!.type
            println("Circle object type: $objectTypeString")

Reimplemented in com.navigine.idl.java.internal.CircleMapObjectBinding, com.navigine.idl.java.internal.ClusterMapObjectBinding, com.navigine.idl.java.internal.DottedPolylineMapObjectBinding, com.navigine.idl.java.internal.IconMapObjectBinding, com.navigine.idl.java.internal.MapObjectBinding, com.navigine.idl.java.internal.ModelMapObjectBinding, com.navigine.idl.java.internal.PolygonMapObjectBinding, and com.navigine.idl.java.internal.PolylineMapObjectBinding.

◆ isValid()

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

abstract

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

Reimplemented from com.navigine.idl.java.MapObject.

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

◆ setAlpha()

abstract boolean com.navigine.idl.java.MapObject.setAlpha ( float alpha )

abstractinherited

Method is used to set the opacity of the map object.

Parameters

alpha Opacity multiplier. Values below 0 will be set to 0. Values above 1 will be set to 1. Default: 1.

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

Java code snippet:

            // Set alpha transparency
            boolean alphaSuccess = circleMapObject.setAlpha(0.7);
            System.out.println("Set circle alpha to 0.7: " + alphaSuccess);

Kotlin code snippet:

            // Set alpha transparency
            val alphaSuccess = circleMapObject!!.setAlpha(0.7)
            println("Set circle alpha to 0.7: $alphaSuccess")

Reimplemented in com.navigine.idl.java.internal.CircleMapObjectBinding, com.navigine.idl.java.internal.ClusterMapObjectBinding, com.navigine.idl.java.internal.DottedPolylineMapObjectBinding, com.navigine.idl.java.internal.IconMapObjectBinding, com.navigine.idl.java.internal.MapObjectBinding, com.navigine.idl.java.internal.ModelMapObjectBinding, com.navigine.idl.java.internal.PolygonMapObjectBinding, and com.navigine.idl.java.internal.PolylineMapObjectBinding.

◆ setCollisionEnabled()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setCollisionEnabled ( boolean enabled )

abstract

Method is used to enable or disable collision detection for the icon.

Parameters

enabled Specifies whether collision detection is enabled (true) or disabled (false). Default: false.

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

Java code snippet:

            // Enable collision detection
            boolean dottedCollisionSuccess = dottedPolylineMapObject.setCollisionEnabled(true);
            System.out.println("Enabled collision detection for dotted polyline: " + dottedCollisionSuccess);

Kotlin code snippet:

            // Enable collision detection
            val collisionSuccess = dottedPolylineMapObject!!.setCollisionEnabled(true)
            println("Enabled collision detection for dotted polyline: $collisionSuccess")

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

◆ setColor()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setColor	(	float	red,
		float	green,
		float	blue,
		float	alpha )

abstract

Method is used to specify the color of the object.

Parameters

red	Red RGBA component.
green	Green RGBA component.
blue	Blue RGBA component.
alpha	Opacity multiplier. Values below 0 will be set to 0. Default: 1.

Returns: true if success, false otherwise.

Java code snippet:

            // Set dotted polyline color
            boolean colorSuccess = dottedPolylineMapObject.setColor(0.5, 0.0, 1.0, 0.8);
            System.out.println("Set dotted polyline color to purple with 80% opacity: " + colorSuccess);

Kotlin code snippet:

            // Set dotted polyline color
            val colorSuccess = dottedPolylineMapObject!!.setColor(0.5, 0.0, 1.0, 0.8)
            println("Set dotted polyline color to purple with 80% opacity: $colorSuccess")

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

◆ setData()

abstract void com.navigine.idl.java.MapObject.setData ( byte[] data )

abstractinherited

Method is used to set user-defined data for the map object.

Parameters

data	Data to store in the map object.

Java code snippet:

            // Set custom data
            Map<String, String> customData = new HashMap<>();
            customData.put("key", "value");
            customData.put("number", "42");
            boolean dataSuccess = circleMapObject.setData(customData);
            System.out.println("Set circle custom data: " + dataSuccess);

Kotlin code snippet:

            // Set custom data
            val customData = mapOf("key" to "value", "number" to "42")
            val dataSuccess = circleMapObject!!.setData(customData)
            println("Set circle custom data: $dataSuccess")

Reimplemented in com.navigine.idl.java.internal.CircleMapObjectBinding, com.navigine.idl.java.internal.ClusterMapObjectBinding, com.navigine.idl.java.internal.DottedPolylineMapObjectBinding, com.navigine.idl.java.internal.IconMapObjectBinding, com.navigine.idl.java.internal.MapObjectBinding, com.navigine.idl.java.internal.ModelMapObjectBinding, com.navigine.idl.java.internal.PolygonMapObjectBinding, and com.navigine.idl.java.internal.PolylineMapObjectBinding.

◆ setInteractive()

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

abstractinherited

Method is used to specify whether the map object can be interacted with.

Parameters

interactive Specifies whether the object can be picked in the pickMapObjectAt method (true) or not (false). Default: false.

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

Java code snippet:

            // Set interactive mode
            boolean interactiveSuccess = circleMapObject.setInteractive(true);
            System.out.println("Set circle interactive to true: " + interactiveSuccess);

Kotlin code snippet:

            // Set interactive mode
            val interactiveSuccess = circleMapObject!!.setInteractive(true)
            println("Set circle interactive to true: $interactiveSuccess")

Reimplemented in com.navigine.idl.java.internal.CircleMapObjectBinding, com.navigine.idl.java.internal.ClusterMapObjectBinding, com.navigine.idl.java.internal.DottedPolylineMapObjectBinding, com.navigine.idl.java.internal.IconMapObjectBinding, com.navigine.idl.java.internal.MapObjectBinding, com.navigine.idl.java.internal.ModelMapObjectBinding, com.navigine.idl.java.internal.PolygonMapObjectBinding, and com.navigine.idl.java.internal.PolylineMapObjectBinding.

◆ setPlacement()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setPlacement ( Placement placement )

abstract

Method is used to specify the placement mode for points along the polyline.

Parameters

placement The placement mode Placement. Default: VERTEX.

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

Java code snippet:

            // Set placement type
            boolean dottedPlacementSuccess = dottedPolylineMapObject.setPlacement(Placement.CENTER);
            System.out.println("Set dotted polyline placement to CENTER: " + dottedPlacementSuccess);

Kotlin code snippet:

            // Set placement type
            val placementSuccess = dottedPolylineMapObject!!.setPlacement(Placement.CENTER)
            println("Set dotted polyline placement to CENTER: $placementSuccess")

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

◆ setPlacementMinRatio()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setPlacementMinRatio ( float ratio )

abstract

Method is used to specify the minimum ratio of the polyline length for point placement.

Parameters

ratio The minimum ratio of the polyline length (typically between 0 and 1). Default: 1.0.

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

Java code snippet:

            // Set placement min ratio
            boolean dottedMinRatioSuccess = dottedPolylineMapObject.setPlacementMinRatio(0.5);
            System.out.println("Set dotted polyline placement min ratio to 0.5: " + dottedMinRatioSuccess);

Kotlin code snippet:

            // Set placement min ratio
            val minRatioSuccess = dottedPolylineMapObject!!.setPlacementMinRatio(0.5)
            println("Set dotted polyline placement min ratio to 0.5: $minRatioSuccess")

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

◆ setPlacementSpacing()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setPlacementSpacing ( float spacing )

abstract

Method is used to specify the spacing between points for spaced placement.

Parameters

spacing The spacing distance in pixels. Default: 80.

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

Java code snippet:

            // Set placement spacing
            boolean dottedSpacingSuccess = dottedPolylineMapObject.setPlacementSpacing(10.0);
            System.out.println("Set dotted polyline placement spacing to 10.0: " + dottedSpacingSuccess);

Kotlin code snippet:

            // Set placement spacing
            val spacingSuccess = dottedPolylineMapObject!!.setPlacementSpacing(10.0)
            println("Set dotted polyline placement spacing to 10.0: $spacingSuccess")

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

◆ setPolyLine()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setPolyLine ( LocationPolyline polyline )

abstract

Method is used to specify the source polyline for the points.

Parameters

polyline Metrics coordinates of the polyline LocationPolyline.

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

Java code snippet:

            // Set dotted polyline geometry
            List<Point> dottedPoints = new ArrayList<>();
            dottedPoints.add(new Point(0.0, 100.0));
            dottedPoints.add(new Point(50.0, 150.0));
            dottedPoints.add(new Point(100.0, 100.0));
            dottedPoints.add(new Point(150.0, 150.0));
            Polyline dottedPolyline = new Polyline(dottedPoints);
            LocationPolyline locationDottedPolyline = new LocationPolyline(dottedPolyline, 1, 0);
            boolean success = dottedPolylineMapObject.setPolyLine(locationDottedPolyline);
            System.out.println("Set dotted polyline geometry: " + success);

Kotlin code snippet:

            // Set dotted polyline geometry
            val points = listOf(
                Point(160.0, 170.0),
                Point(165.0, 175.0),
                Point(170.0, 180.0),
                Point(175.0, 185.0)
            )
            val dottedPl = Polyline(points)
            val polyline = LocationPolyline(dottedPl, 1, 0)
            val success = dottedPolylineMapObject!!.setPolyline(polyline)
            println("Set dotted polyline with ${points.size} points: $success")

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

◆ setPriority()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setPriority ( float priority )

abstract

Method is used to specify the priority of the icon.

Parameters

priority The priority value for rendering or interaction. Default: max.

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

Java code snippet:

            // Set rendering priority
            boolean dottedPrioritySuccess = dottedPolylineMapObject.setPriority(1);
            System.out.println("Set dotted polyline rendering priority to 1: " + dottedPrioritySuccess);

Kotlin code snippet:

            // Set rendering priority
            val prioritySuccess = dottedPolylineMapObject!!.setPriority(1)
            println("Set dotted polyline rendering priority to 1: $prioritySuccess")

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

◆ setRepeatDistance()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setRepeatDistance ( float distance )

abstract

Method is used to specify the distance interval for repeating points along the polyline.

Parameters

distance The repeat distance in pixels. Default: 0.

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

Java code snippet:

            // Set repeat distance
            boolean dottedRepeatDistanceSuccess = dottedPolylineMapObject.setRepeatDistance(20.0);
            System.out.println("Set dotted polyline repeat distance to 20.0: " + dottedRepeatDistanceSuccess);

Kotlin code snippet:

            // Set repeat distance
            val repeatDistanceSuccess = dottedPolylineMapObject!!.setRepeatDistance(20.0)
            println("Set dotted polyline repeat distance to 20.0: $repeatDistanceSuccess")

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

◆ setRepeatGroup()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setRepeatGroup ( int group )

abstract

Method is used to specify the group identifier for repeating points.

Parameters

group The group identifier for point repetition. Default: 0.

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

Java code snippet:

            // Set repeat group
            boolean dottedRepeatGroupSuccess = dottedPolylineMapObject.setRepeatGroup(1);
            System.out.println("Set dotted polyline repeat group to 1: " + dottedRepeatGroupSuccess);

Kotlin code snippet:

            // Set repeat group
            val repeatGroupSuccess = dottedPolylineMapObject!!.setRepeatGroup(1)
            println("Set dotted polyline repeat group to 1: $repeatGroupSuccess")

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

◆ setSize()

abstract boolean com.navigine.idl.java.DottedPolylineMapObject.setSize	(	float	width,
		float	height )

abstract

Method is used to specify the size of the points.

Parameters

width	Width of the points in pixels.
height	Height of the points in pixels.

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

Java code snippet:

            // Set size
            Size dottedSize = new Size(16.0, 16.0);
            boolean dottedSizeSuccess = dottedPolylineMapObject.setSize(dottedSize);
            System.out.println("Set dotted polyline size to (" + dottedSize.getWidth() + ", " + dottedSize.getHeight() + "): " + dottedSizeSuccess);

Kotlin code snippet:

            // Set size
            val size = Size(16.0, 16.0)
            val sizeSuccess = dottedPolylineMapObject!!.setSize(size)
            println("Set dotted polyline size to (${size.width}, ${size.height}): $sizeSuccess")

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

◆ setTitle()

abstract boolean com.navigine.idl.java.MapObject.setTitle ( String title )

abstractinherited

Method is used to set the title of the map object.

Parameters

title The title to display on the location view.

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

Java code snippet:

            // Set title
            boolean titleSuccess = circleMapObject.setTitle("Circle Object");
            System.out.println("Set circle title to 'Circle Object': " + titleSuccess);

Kotlin code snippet:

            // Set title
            val titleSuccess = circleMapObject!!.setTitle("Circle Object")
            println("Set circle title to 'Circle Object': $titleSuccess")

Reimplemented in com.navigine.idl.java.internal.CircleMapObjectBinding, com.navigine.idl.java.internal.ClusterMapObjectBinding, com.navigine.idl.java.internal.DottedPolylineMapObjectBinding, com.navigine.idl.java.internal.IconMapObjectBinding, com.navigine.idl.java.internal.MapObjectBinding, com.navigine.idl.java.internal.ModelMapObjectBinding, com.navigine.idl.java.internal.PolygonMapObjectBinding, and com.navigine.idl.java.internal.PolylineMapObjectBinding.

◆ setVisible()

abstract boolean com.navigine.idl.java.MapObject.setVisible ( boolean visible )

abstractinherited

Method is used to specify the visibility of the map object.

Parameters

visible Specifies whether the object is visible (true) or hidden (false). Default: true.

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

Java code snippet:

            // Set visibility
            boolean visibleSuccess = circleMapObject.setVisible(true);
            System.out.println("Set circle visibility to true: " + visibleSuccess);

Kotlin code snippet:

            // Set visibility
            val visibleSuccess = circleMapObject!!.setVisible(true)
            println("Set circle visibility to true: $visibleSuccess")

Reimplemented in com.navigine.idl.java.internal.CircleMapObjectBinding, com.navigine.idl.java.internal.ClusterMapObjectBinding, com.navigine.idl.java.internal.DottedPolylineMapObjectBinding, com.navigine.idl.java.internal.IconMapObjectBinding, com.navigine.idl.java.internal.MapObjectBinding, com.navigine.idl.java.internal.ModelMapObjectBinding, com.navigine.idl.java.internal.PolygonMapObjectBinding, and com.navigine.idl.java.internal.PolylineMapObjectBinding.

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

DottedPolylineMapObject.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getData()

◆ getId()

◆ getType()

◆ isValid()

◆ setAlpha()

◆ setCollisionEnabled()

◆ setColor()

◆ setData()

◆ setInteractive()

◆ setPlacement()

◆ setPlacementMinRatio()

◆ setPlacementSpacing()

◆ setPolyLine()

◆ setPriority()

◆ setRepeatDistance()

◆ setRepeatGroup()

◆ setSize()

◆ setTitle()

◆ setVisible()