Class LinearPluginMapCoordinateConverter

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

A linear converter for a map image whose bounds are known in world units.

public sealed class LinearPluginMapCoordinateConverter : IPluginMapCoordinateConverter

Inheritance

object

LinearPluginMapCoordinateConverter

Implements

IPluginMapCoordinateConverter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

North is up: the image's top edge is the northern edge of the bounds, its left edge the western one.

Constructors

LinearPluginMapCoordinateConverter(PluginMapViewport)

Makes a converter for an image that covers the given part of the world.

public LinearPluginMapCoordinateConverter(PluginMapViewport worldBounds)

Parameters

worldBounds PluginMapViewport

The part of the world the whole image covers.

Properties

WorldBounds

The part of the world the whole image covers.

public PluginMapViewport WorldBounds { get; }

Property Value

PluginMapViewport

Methods

PixelToWorld(PluginMapPixel, double, double)

Which world point a pixel of an image of the given size shows.

public PluginMapPoint PixelToWorld(PluginMapPixel pixel, double imageWidth, double imageHeight)

Parameters

pixel PluginMapPixel

The pixel position.

imageWidth double

The image's width in pixels.

imageHeight double

The image's height in pixels.

Returns

PluginMapPoint

The world point. It carries no elevation.

Exceptions

ArgumentOutOfRangeException

The image width or height is zero or negative.

WorldToPixel(PluginMapPoint, double, double)

Where a world point falls on an image of the given size.

public PluginMapPixel WorldToPixel(PluginMapPoint world, double imageWidth, double imageHeight)

Parameters

world PluginMapPoint

The world point.

imageWidth double

The image's width in pixels.

imageHeight double

The image's height in pixels.

Returns

PluginMapPixel

The pixel position; outside the image when the point is outside WorldBounds.

Exceptions

ArgumentOutOfRangeException

The image width or height is zero or negative.