IconMapObject class abstract

@ingroup navigine_dart_classes @ingroup navigine_dart_location_view

@brief Represents an icon object on the location view.

Referenced from @see LocationWindow "LocationWindow".

@note IconMapObject maintains orientation to the screen surface by default.

Implemented types
Implementers

Constructors

IconMapObject()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getData() → Uint8List
@brief Gets the user-defined data associated with the map object. @return The data stored in the map object.
inherited
getId() → int
@brief Gets the unique identifier of the map object. @return The unique identifier of the map object.
inherited
getType() → MapObjectType
@brief Gets the type of the map object. @return The type of the map object @see MapObjectType "MapObjectType".
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setAlpha(double alpha) → bool
@brief Method is used to set the opacity of the map object. @param alpha Opacity multiplier. Values below 0 will be set to 0. Values above 1 will be set to 1. Default: 1. @return true if the operation is successful, false otherwise.
inherited
setAngle(double angle) → bool
@brief Method is used to specify the rotation angle of the icon. @param angle Rotation angle in degrees. Default: 0. @return true if the operation is successful, false otherwise.
setAngleAnimated(double angle, double duration, AnimationType type) → bool
@brief Method is used to rotate the icon with the specified animation. @param angle Rotation angle in degrees. @param duration Animation duration in seconds. @param type Animation type @see AnimationType "AnimationType". @return true if the operation is successful, false otherwise.
setBitmap(ImageWrapper bitmap) → bool
@brief Method is used to specify the bitmap image for the icon. @param bitmap Platform bitmap object. @return true if the operation is successful, false otherwise.
setBuffer(double width, double height) → bool
@brief Method is used to specify the buffer size around the icon for collision detection. @param width Width of the buffer in pixels. Default: 0. @param height Height of the buffer in pixels. Default: 0. @return true if the operation is successful, false otherwise.
setCollisionEnabled(bool enabled) → bool
@brief Method is used to enable or disable collision detection for the icon. @param enabled Specifies whether collision detection is enabled (true) or disabled (false). Default: false. @return true if the operation is successful, false otherwise.
setData(Uint8List data) → void
@brief Method is used to set user-defined data for the map object. @param data Data to store in the map object.
inherited
setFlat(bool flat) → bool
@brief Method is used to specify whether the icon is flat or billboarded. @param flat If true, the icon aligns with the location view surface; if false, it maintains orientation to the screen surface. Default: false. @return true if the operation is successful, false otherwise.
setInteractive(bool interactive) → bool
@brief Method is used to specify whether the map object can be interacted with. @param interactive Specifies whether the object can be picked in the pickMapObjectAt method (true) or not (false). Default: false. @return true if the operation is successful, false otherwise.
inherited
setOffset(double width, double height) → bool
@brief Method is used to specify an offset for the circle’s position. @param width Horizontal offset in pixels. @param height Vertical offset in pixels. @return true if the operation is successful, false otherwise.
setPosition(LocationPoint point) → bool
@brief Method is used to specify the center of the icon. @param point Metrics coordinates of the center @see LocationPoint "LocationPoint". @return true if the operation is successful, false otherwise.
setPositionAnimated(LocationPoint point, double duration, AnimationType type) → bool
@brief Method is used to move the center of the icon with the specified animation. @param point Metrics coordinates of the center @see LocationPoint "LocationPoint". @param duration Animation duration in seconds. @param type Animation type @see AnimationType "AnimationType". @return true if the operation is successful, false otherwise.
setPriority(double priority) → bool
@brief Method is used to specify the priority of the icon. @param priority The priority value for rendering or interaction. Default: max. @return true if the operation is successful, false otherwise.
setSize(double width, double height) → bool
@brief Method is used to specify the size of the icon. @param width Width of the icon in pixels. @param height Height of the icon in pixels. @return true if the operation is successful, false otherwise.
setTitle(String title) → bool
@brief Method is used to set the title of the map object. @param title The title to display on the location view. @return true if the operation is successful, false otherwise.
inherited
setVisible(bool visible) → bool
@brief Method is used to specify the visibility of the map object. @param visible Specifies whether the object is visible (true) or hidden (false). Default: true. @return true if the operation is successful, false otherwise.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited