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.

◆ 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.

◆ getType()

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

abstractinherited

Gets the type of the map object.

Returns: The type of the map object map_object_type.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

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

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

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

CircleMapObject.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getData()

◆ getId()

◆ getType()

◆ setAlpha()

◆ setBuffer()

◆ setCollisionEnabled()

◆ setColor()

◆ setData()

◆ setInteractive()

◆ setOffset()

◆ setOutlineAlpha()

◆ setOutlineColor()

◆ setOutlineRadius()

◆ setPosition()

◆ setPositionAnimated()

◆ setPriority()

◆ setRadius()

◆ setTitle()

◆ setVisible()