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

Inheritance diagram for IconMapObject:

Public Member Functions
bool	setPosition (GlobalPoint point, int? sublocationId)
	Method is used to specify the center of the icon.

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

bool	setBitmap (ImageProvider bitmap)
	Method is used to specify the decoded raster 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 icon’s anchor on screen.

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.

bool	isValid ()

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	setTitleWithStyle (String title, TitleStyle style)
	Method is used to set the title and its style for 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 33 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.

Dart code snippet:

      // Get custom data
      Map<String, dynamic> retrievedData = _circleMapObject!.data;
      print("Circle custom data: $retrievedData");

◆ getId()

int MapObject.getId ( )

inherited

Gets the unique identifier of the map object.

Returns: The unique identifier of the map object.

Dart code snippet:

      // Get object ID
      int objectId = _circleMapObject!.id;
      print("Circle object ID: $objectId");

◆ getType()

MapObjectType MapObject.getType ( )

inherited

Gets the type of the map object.

Returns: The type of the map object MapObjectType.

Dart code snippet:

      // Get object type
      String objectTypeString = _circleMapObject!.type;
      print("Circle object type: $objectTypeString");

◆ isValid()

bool IconMapObject.isValid ( )

Reimplemented from MapObject.

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

Dart code snippet:

      // Set alpha transparency
      bool alphaSuccess = _circleMapObject!.setAlpha(0.7);
      print("Set circle alpha to 0.7: $alphaSuccess");

◆ setAngle()

bool IconMapObject.setAngle ( double angle )

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

Parameters

angle Rotation angle in radians. Default: 0.

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

Dart code snippet:

      // Set icon rotation angle (radians)
      bool angleSuccess = _iconMapObject!.setAngle(math.pi / 4);
      print("Set icon rotation angle to π/4: $angleSuccess");

◆ 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 radians.
duration	Animation duration in seconds.
type	Animation type AnimationType.

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

Dart code snippet:

      // Set icon rotation with animation (radians)
      bool angleAnimatedSuccess = _iconMapObject!.setAngleAnimated(
        math.pi / 2,
        2.0,
        AnimationType.SINE,
      );
      print(
        "Set icon rotation with animation to π/2: $angleAnimatedSuccess",
      );

◆ setBitmap()

bool IconMapObject.setBitmap ( ImageProvider bitmap )

Method is used to specify the decoded raster for the icon.

Parameters

bitmap Image provider: Android com.navigine.image.ImageProvider; iOS UIImage via binding; Flutter navigine_sdk ImageProvider.

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

Dart code snippet:

      // Icon pixels come from package:navigine_sdk ImageProvider (async decode in the engine).
      ImageProvider iconProvider = ImageProvider.fromImageProvider(
        const AssetImage('assets/icon.png'),
        cacheable: true,
      );
      bool bitmapSuccess = _iconMapObject!.setBitmap(iconProvider);
      print("Set icon from ImageProvider: $bitmapSuccess");

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

Dart code snippet:

      // Set collision buffer
      bool bufferSuccess = _iconMapObject!.setBuffer(10.0, 10.0);
      print("Set collision buffer to 10x10 pixels: $bufferSuccess");

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

Dart code snippet:

      // Enable collision detection
      bool collisionSuccess = _iconMapObject!.setCollisionEnabled(true);
      print("Enabled collision detection for icon: $collisionSuccess");

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

Dart code snippet:

      // Set custom data
      Map<String, dynamic> customData = {"key": "value", "number": 42};
      bool dataSuccess = _circleMapObject!.setData(customData);
      print("Set circle custom data: $dataSuccess");

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

Dart code snippet:

      // Set icon flat mode
      bool flatSuccess = _iconMapObject!.setFlat(true);
      print("Set icon flat mode to true: $flatSuccess");

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

Dart code snippet:

      // Set interactive mode
      bool interactiveSuccess = _circleMapObject!.setInteractive(true);
      print("Set circle interactive to true: $interactiveSuccess");

◆ setOffset()

bool IconMapObject.setOffset	(	double	width,
		double	height )

Method is used to specify an offset for the icon’s anchor on screen.

Parameters

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

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

Dart code snippet:

      // Set position offset
      bool offsetSuccess = _iconMapObject!.setOffset(0.0, -16.0);
      print("Set position offset to (0.0, -16.0) pixels: $offsetSuccess");

◆ setPosition()

bool IconMapObject.setPosition	(	GlobalPoint	point,
		int?	sublocationId )

Method is used to specify the center of the icon.

Parameters

point	WGS84 coordinates of the center GlobalPoint.
sublocationId	Floor this object is attached to, or null for the outdoor map.

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

Dart code snippet:

      // Set icon position
      GlobalPoint iconPoint = GlobalPoint(200.0, 300.0);
      bool success = _iconMapObject!.setPosition(iconPoint, 7);
      print("Set icon position to (${iconPoint.latitude}, ${iconPoint.longitude}): $success");

◆ setPositionAnimated()

bool IconMapObject.setPositionAnimated	(	GlobalPoint	point,
		int?	sublocationId,
		double	duration,
		AnimationType	type )

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

Parameters

point	WGS84 coordinates of the center GlobalPoint.
sublocationId	Floor this object is attached to, or null for the outdoor map.
duration	Animation duration in seconds.
type	Animation type AnimationType.

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

Dart code snippet:

      // Set icon position with animation
      GlobalPoint animatedIconPoint = GlobalPoint(250.0, 350.0);
      bool animatedSuccess = _iconMapObject!.setPositionAnimated(animatedIconPoint, 7, 1.5, AnimationType.CUBIC,  );
      print(
        "Set icon position with animation to (${animatedIconPoint.latitude}, ${animatedIconPoint.longitude}): $animatedSuccess",
      );

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

Dart code snippet:

      // Set rendering priority
      bool prioritySuccess = _iconMapObject!.setPriority(2);
      print("Set rendering priority to 2: $prioritySuccess");

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

Dart code snippet:

      // Set icon size
      bool sizeSuccess = _iconMapObject!.setSize(32.0, 32.0);
      print("Set icon size to 32x32 pixels: $sizeSuccess");

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

Dart code snippet:

      // Set title
      bool titleSuccess = _circleMapObject!.setTitle("Circle Object");
      print("Set circle title to 'Circle Object': $titleSuccess");

◆ setTitleWithStyle()

bool MapObject.setTitleWithStyle	(	String	title,
		TitleStyle	style )

inherited

Method is used to set the title and its style for the map object.

Parameters

title	The title to display on the location view.
style	Title style parameters TitleStyle.

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

Dart code snippet:

      // Set title with style
      bool titleStyleSuccess =
          _circleMapObject!.setTitleWithStyle("Styled Circle", titleStyle);
      print("Set circle title with style: $titleStyleSuccess");

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

Dart code snippet:

      // Set visibility
      bool visibleSuccess = _circleMapObject!.setVisible(true);
      print("Set circle visibility to true: $visibleSuccess");

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

◆ isValid()

◆ setAlpha()

◆ setAngle()

◆ setAngleAnimated()

◆ setBitmap()

◆ setBuffer()

◆ setCollisionEnabled()

◆ setData()

◆ setFlat()

◆ setInteractive()

◆ setOffset()

◆ setPosition()

◆ setPositionAnimated()

◆ setPriority()

◆ setSize()

◆ setTitle()

◆ setTitleWithStyle()

◆ setVisible()