Represents an icon object on the location view. More...

Inheritance diagram for IconMapObject:

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

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

bool	setBitmap (ImageWrapper bitmap)
	Method is used to specify the bitmap image for the icon.

bool	setSize (double width, double height)
	Method is used to specify the size of the icon.

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

bool	setAngle (double angle)
	Method is used to specify the rotation angle of the icon.

bool	setAngleAnimated (double angle, double duration, AnimationType type)
	Method is used to rotate the icon with the specified animation.

bool	setBuffer (double width, double height)
	Method is used to specify the buffer size around the icon 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 icon.

bool	setFlat (bool flat)
	Method is used to specify whether the icon is flat or billboarded.

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 an icon object on the location view.

Referenced from LocationWindow.

Note: IconMapObject maintains orientation to the screen surface by default.

Definition at line 28 of file icon_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.

◆ setAngle()

bool IconMapObject.setAngle ( double angle )

Method is used to specify the rotation angle of the icon.

Parameters

angle Rotation angle in degrees. Default: 0.

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

◆ setAngleAnimated()

bool IconMapObject.setAngleAnimated	(	double	angle,
		double	duration,
		AnimationType	type )

Method is used to rotate the icon with the specified animation.

Parameters

angle	Rotation angle in degrees.
duration	Animation duration in seconds.
type	Animation type AnimationType.

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

◆ setBitmap()

bool IconMapObject.setBitmap ( ImageWrapper bitmap )

Method is used to specify the bitmap image for the icon.

Parameters

bitmap Platform bitmap object.

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

◆ setBuffer()

bool IconMapObject.setBuffer	(	double	width,
		double	height )

Method is used to specify the buffer size around the icon 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 IconMapObject.setCollisionEnabled ( bool enabled )

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.

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

◆ setFlat()

bool IconMapObject.setFlat ( bool flat )

Method is used to specify whether the icon is flat or billboarded.

Parameters

flat	If true, the icon aligns with the location view surface; if false, it maintains orientation to the screen surface. Default: false.

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

◆ setPosition()

bool IconMapObject.setPosition ( LocationPoint point )

Method is used to specify the center of the icon.

Parameters

point Metrics coordinates of the center LocationPoint.

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

◆ setPositionAnimated()

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

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

Parameters

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

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

◆ setPriority()

bool IconMapObject.setPriority ( double priority )

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.

◆ setSize()

bool IconMapObject.setSize	(	double	width,
		double	height )

Method is used to specify the size of the icon.

Parameters

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

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:

icon_map_object.dart

Public Member Functions

Detailed Description

Member Function Documentation

◆ getData()

◆ getId()

◆ getType()

◆ setAlpha()

◆ setAngle()

◆ setAngleAnimated()

◆ setBitmap()

◆ setBuffer()

◆ setCollisionEnabled()

◆ setData()

◆ setFlat()

◆ setInteractive()

◆ setOffset()

◆ setPosition()

◆ setPositionAnimated()

◆ setPriority()

◆ setSize()

◆ setTitle()

◆ setVisible()