Interface IPluginMapSurface

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

Host-owned map surface suitable for declarative map controls.

public interface IPluginMapSurface : IDisposable

Inherited Members

IDisposable.Dispose()

Remarks

Dispose it to remove the map and its callbacks.

Properties

Background

The image drawn under the markers, or null before one is set.

PluginMapImage? Background { get; }

Property Value

PluginMapImage

Markers

The markers last given to SetMarkers(IReadOnlyList<PluginMapMarker>).

IReadOnlyList<PluginMapMarker> Markers { get; }

Property Value

IReadOnlyList<PluginMapMarker>

Route

The route last given to SetRoute(IReadOnlyList<PluginMapPoint>).

IReadOnlyList<PluginMapPoint> Route { get; }

Property Value

IReadOnlyList<PluginMapPoint>

Viewport

The part of the world the map shows. Set it to pan or zoom.

PluginMapViewport Viewport { get; set; }

Property Value

PluginMapViewport

Methods

SetBackground(PluginMapImage)

Sets the image drawn under the markers.

void SetBackground(PluginMapImage image)

Parameters

image PluginMapImage

The image and its world bounds.

SetMarkers(IReadOnlyList<PluginMapMarker>)

Replaces every marker on the map.

void SetMarkers(IReadOnlyList<PluginMapMarker> markers)

Parameters

markers IReadOnlyList<PluginMapMarker>

The new markers; an empty list clears them.

SetRoute(IReadOnlyList<PluginMapPoint>)

Replaces the route drawn on the map.

void SetRoute(IReadOnlyList<PluginMapPoint> points)

Parameters

points IReadOnlyList<PluginMapPoint>

The route's points in walking order; an empty list clears it.

Events

Input

Raised for each pointer event over the map.

event Action<PluginMapInput>? Input

Event Type

Action<PluginMapInput>