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

Inheritance diagram for CircleMapObject:

Public Member Functions
bool	setPosition (LocationPoint point)
	Method is used to specify the center of the circle.

bool	setPositionAnimated (LocationPoint point, double duration, AnimationType type)
	Method is used to move the center of the circle with the specified animation.

bool	setColor (double red, double green, double blue, double alpha)
	Method is used to specify the fill color of the circle.

bool	setRadius (double radius)
	Method is used to specify the size of the circle.

bool	setCollisionEnabled (bool enabled)
	Method is used to enable or disable collision detection for the circle.

bool	setBuffer (double width, double height)
	Method is used to specify the buffer size around the circle for collision detection.

bool	setOffset (double width, double height)
	Method is used to specify an offset for the circle’s position.

bool	setPriority (double priority)
	Method is used to specify the priority of the circle.

bool	setOutlineColor (double red, double green, double blue, double alpha)
	Method is used to specify the color of the circle’s outline.

bool	setOutlineRadius (double radius)
	Method is used to specify the thickness of the circle’s outline.

bool	setOutlineAlpha (double alpha)
	Method is used to specify the opacity of the circle’s outline.

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

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

Uint8List	getData ()
	Gets the user-defined data associated with the map object.

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

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

void	setData (Uint8List data)
	Method is used to set user-defined data for the map object.

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

bool	setAlpha (double 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 25 of file circle_map_object.dart.

Member Function Documentation

◆ getData()

Uint8List MapObject.getData ( )

inherited

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

Returns: The data stored in the map object.

◆ getId()

int MapObject.getId ( )

inherited

Gets the unique identifier of the map object.

Returns: The unique identifier of the map object.

◆ getType()

MapObjectType MapObject.getType ( )

inherited

Gets the type of the map object.

Returns: The type of the map object map_object_type.

◆ setAlpha()

bool MapObject.setAlpha ( double alpha )

inherited

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

bool CircleMapObject.setBuffer	(	double	width,
		double	height )

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

bool CircleMapObject.setCollisionEnabled ( bool enabled )

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

bool CircleMapObject.setColor	(	double	red,
		double	green,
		double	blue,
		double	alpha )

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

void MapObject.setData ( Uint8List data )

inherited

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

bool MapObject.setInteractive ( bool interactive )

inherited

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

bool CircleMapObject.setOffset	(	double	width,
		double	height )

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

bool CircleMapObject.setOutlineAlpha ( double alpha )

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

bool CircleMapObject.setOutlineColor	(	double	red,
		double	green,
		double	blue,
		double	alpha )

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

bool CircleMapObject.setOutlineRadius ( double radius )

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

bool CircleMapObject.setPosition ( LocationPoint point )

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

bool CircleMapObject.setPositionAnimated	(	LocationPoint	point,
		double	duration,
		AnimationType	type )

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

bool CircleMapObject.setPriority ( double priority )

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

bool CircleMapObject.setRadius ( double radius )

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

bool MapObject.setTitle ( String title )

inherited

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

bool MapObject.setVisible ( bool visible )

inherited

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:

circle_map_object.dart

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