com.navigine.idl.java.CircleMapObject Class Reference

Represents a circle on the location view. More...

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

Public Member Functions
abstract boolean	setPosition (LocationPoint point)
	Method is used to specify the center of the circle.
abstract boolean	setPositionAnimated (LocationPoint point, float duration, AnimationType type)
	Method is used to move the center of the circle with the specified animation.
abstract boolean	setColor (float red, float green, float blue, float alpha)
	Method is used to specify the fill color of the circle.
abstract boolean	setRadius (float radius)
	Method is used to specify the size of the circle.
abstract boolean	setCollisionEnabled (boolean enabled)
	Method is used to enable or disable collision detection for the circle.
abstract boolean	setBuffer (float width, float height)
	Method is used to specify the buffer size around the circle for collision detection.
abstract boolean	setOffset (float width, float height)
	Method is used to specify an offset for the circle’s position.
abstract boolean	setPriority (float priority)
	Method is used to specify the priority of the circle.
abstract boolean	setOutlineColor (float red, float green, float blue, float alpha)
	Method is used to specify the color of the circle’s outline.
abstract boolean	setOutlineRadius (float radius)
	Method is used to specify the thickness of the circle’s outline.
abstract boolean	setOutlineAlpha (float alpha)
	Method is used to specify the opacity of the circle’s outline.
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 circle on the location view.

Referenced from LocationWindow.

Definition at line 18 of file CircleMapObject.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")

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")

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")

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")

setBuffer()

abstract boolean com.navigine.idl.java.CircleMapObject.setBuffer ( float width, float height )

abstract

Method is used to specify the buffer size around the circle for collision detection.

Parameters

width	Width of the buffer in pixels. Default: 0.
height	Height of the buffer in pixels. Default: 0.

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set collision buffer
            boolean bufferSuccess = circleMapObject.setBuffer(5.0, 5.0);
            System.out.println("Set collision buffer to 5x5 pixels: " + bufferSuccess);

Kotlin code snippet:

            // Set collision buffer
            val bufferSuccess = circleMapObject!!.setBuffer(5.0, 5.0)
            println("Set collision buffer to 5x5 pixels: $bufferSuccess")

setCollisionEnabled()

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

abstract

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

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 collisionSuccess = circleMapObject.setCollisionEnabled(true);
            System.out.println("Enabled collision detection for circle: " + collisionSuccess);

Kotlin code snippet:

            // Enable collision detection
            val collisionSuccess = circleMapObject!!.setCollisionEnabled(true)
            println("Enabled collision detection for circle: $collisionSuccess")

setColor()

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

abstract

Method is used to specify the fill color of the circle.

Parameters

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

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set circle color
            boolean colorSuccess = circleMapObject.setColor(1.0, 0.0, 0.0, 0.8);
            System.out.println("Set circle color to red with 80% opacity: " + colorSuccess);

Kotlin code snippet:

            // Set circle color
            val colorSuccess = circleMapObject!!.setColor(1.0, 0.0, 0.0, 0.8)
            println("Set circle color to red with 80% opacity: $colorSuccess")

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")

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")

setOffset()

abstract boolean com.navigine.idl.java.CircleMapObject.setOffset ( float width, float height )

abstract

Method is used to specify an offset for the circle’s position.

Parameters

width	Horizontal offset in pixels.
height	Vertical offset in pixels.

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set position offset
            boolean offsetSuccess = circleMapObject.setOffset(2.0, 3.0);
            System.out.println("Set position offset to (2.0, 3.0) pixels: " + offsetSuccess);

Kotlin code snippet:

            // Set position offset
            val offsetSuccess = circleMapObject!!.setOffset(2.0, 3.0)
            println("Set position offset to (2.0, 3.0) pixels: $offsetSuccess")

setOutlineAlpha()

abstract boolean com.navigine.idl.java.CircleMapObject.setOutlineAlpha ( float alpha )

abstract

Method is used to specify the opacity of the circle’s outline.

Parameters

alpha

Opacity multiplier (0 to 1). Values below 0 are set to 0. Default: 1.

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set outline alpha
            boolean outlineAlphaSuccess = circleMapObject.setOutlineAlpha(0.5);
            System.out.println("Set circle outline alpha to 0.5: " + outlineAlphaSuccess);

Kotlin code snippet:

            // Set outline alpha
            val outlineAlphaSuccess = circleMapObject!!.setOutlineAlpha(0.5)
            println("Set circle outline alpha to 0.5: $outlineAlphaSuccess")

setOutlineColor()

abstract boolean com.navigine.idl.java.CircleMapObject.setOutlineColor ( float red, float green, float blue, float alpha )

abstract

Method is used to specify the color of the circle’s outline.

Parameters

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

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set outline color
            boolean outlineColorSuccess = circleMapObject.setOutlineColor(0.0, 0.0, 1.0, 1.0);
            System.out.println("Set circle outline color to blue: " + outlineColorSuccess);

Kotlin code snippet:

            // Set outline color
            val outlineColorSuccess = circleMapObject!!.setOutlineColor(0.0, 0.0, 1.0, 1.0)
            println("Set circle outline color to blue: $outlineColorSuccess")

setOutlineRadius()

abstract boolean com.navigine.idl.java.CircleMapObject.setOutlineRadius ( float radius )

abstract

Method is used to specify the thickness of the circle’s outline.

Parameters

radius

Thickness of the outline in pixels.

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set outline radius
            boolean outlineRadiusSuccess = circleMapObject.setOutlineRadius(2.0);
            System.out.println("Set circle outline radius to 2.0: " + outlineRadiusSuccess);

Kotlin code snippet:

            // Set outline radius
            val outlineRadiusSuccess = circleMapObject!!.setOutlineRadius(2.0)
            println("Set circle outline radius to 2.0: $outlineRadiusSuccess")

setPosition()

abstract boolean com.navigine.idl.java.CircleMapObject.setPosition ( LocationPoint point )

abstract

Method is used to specify the center of the circle.

Parameters

point

Metrics coordinates of the center LocationPoint.

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set circle position
            LocationPoint centerPoint = new LocationPoint(100.0, 200.0);
            boolean success = circleMapObject.setPosition(centerPoint);
            System.out.println("Set circle position to (" + centerPoint.getX() + ", " + centerPoint.getY() + "): " + success);

Kotlin code snippet:

            // Set circle position
            val centerPoint = LocationPoint(100.0, 200.0)
            val success = circleMapObject!!.setPosition(centerPoint)
            println("Set circle position to (${centerPoint.x}, ${centerPoint.y}): $success")

setPositionAnimated()

abstract boolean com.navigine.idl.java.CircleMapObject.setPositionAnimated ( LocationPoint point, float duration, AnimationType type )

abstract

Method is used to move the center of the circle with the specified animation.

Parameters

point	Metrics coordinates of the center LocationPoint.
duration	Animation duration in seconds.
type	Animation type AnimationType. Default: CENTER.

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set circle position with animation
            LocationPoint animatedPoint = new LocationPoint(150.0, 250.0);
            boolean animatedSuccess = circleMapObject.setPositionAnimated(animatedPoint, 2.0, AnimationType.LINEAR);
            System.out.println("Set circle position with animation to (" + animatedPoint.getX() + ", " + animatedPoint.getY() + "): " + animatedSuccess);

Kotlin code snippet:

            // Set circle position with animation
            val animatedPoint = LocationPoint(150.0, 250.0)
            val animatedSuccess = circleMapObject!!.setPositionAnimated(animatedPoint, 2.0, AnimationType.LINEAR)
            println("Set circle position with animation to (${animatedPoint.x}, ${animatedPoint.y}): $animatedSuccess")

setPriority()

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

abstract

Method is used to specify the priority of the circle.

Parameters

priority

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

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set rendering priority
            boolean prioritySuccess = circleMapObject.setPriority(1);
            System.out.println("Set rendering priority to 1: " + prioritySuccess);

Kotlin code snippet:

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

setRadius()

abstract boolean com.navigine.idl.java.CircleMapObject.setRadius ( float radius )

abstract

Method is used to specify the size of the circle.

Parameters

radius

Radius of the circle in meters.

Returns

true if the operation is successful, false otherwise.

Java code snippet:

            // Set circle radius
            boolean radiusSuccess = circleMapObject.setRadius(10.0);
            System.out.println("Set circle radius to 10.0 meters: " + radiusSuccess);

Kotlin code snippet:

            // Set circle radius
            val radiusSuccess = circleMapObject!!.setRadius(10.0)
            println("Set circle radius to 10.0 meters: $radiusSuccess")

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")

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")

---

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

• CircleMapObject.java