MapImageOverlay class abstract

MapImageOverlay is used to draw images over the map, at a view coordinate inside the map viewport.

The image to be displayed is represented by a MapImage object. By default, the overlay is centered on the given view coordinate.

The resulting viewport area covered by the overlay is computed out of the overlay's view coordinate, the anchor point and the image size. The overlay subareas that fall outside of the map viewport get clipped.

To display the map overlay, it needs to be added to the scene using MapScene.addMapImageOverlay. To stop displaying it, remove it from the scene using MapScene.removeMapImageOverlay.

Constructors

MapImageOverlay(Point2D viewCoordinates, MapImage image)
Creates an instance of an overlay at given view coordinates, represented by specified image.
factory
MapImageOverlay.withAnchor(Point2D viewCoordinates, MapImage image, Anchor2D anchor)
Creates an instance of an overlay at given view coordinates, represented by specified image, with anchor point specifying how the image is positioned relative to the overlay's view coordinates.
factory

Properties

anchor ↔ Anchor2D
The anchor point for the overlay image which specifies the position offset relative to the overlay's view coordinates. Gets current anchor point for the overlay image.
getter/setter pair
drawOrder ↔ int
Draw order of this MapImageOverlay. Gets draw order of this MapImageOverlay. The default value is 0.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
image ↔ MapImage
Image overlayed on the map. Gets currently used map image.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
viewCoordinates ↔ Point2D
The view point in pixels on the map viewport where the map overlay is drawn. Gets the view point in pixels on the map viewport where the overlay is drawn.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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