ProjectionBase Class

The base class for all projections used in the MapControl.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public abstract class ProjectionBase :
    ICoordPointToMapUnitConverter

VB.NET

Public MustInherit Class ProjectionBase
    Implements ICoordPointToMapUnitConverter

Related API Members

The following members accept/return ProjectionBase objects:

• BingMapDataProvider.Projection
• GeoMapCoordinateSystem.Projection
• MapDataProviderBase.Projection
• OpenStreetMapDataProvider.Projection
• ProjectionBase.DefaultProjection

Remarks

For more information, see Geographical Projections.

Example

This example shows how to get a Hammer-Aitoff map projection for the shapes loaded from the Shapefiles (Countries.shp, Countries.dbf).

To create a custom map projection, do the following:

• Inherit a ProjectionBase class;
• Override the ProjectionBase.GeoPointToMapUnit and ProjectionBase.MapUnitToGeoPoint methods, which specify formulas to calculate custom projection coordinates and map geographical points (longitude and latitude);
• Override the ProjectionBase.GeoToKilometersSize and ProjectionBase.KilometersToGeoSize methods to convert the specified size in geographical points to the corresponding size in kilometers for the specified anchor point and vice versa.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-implement-a-custom-map-projection-e4783

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraMap;

namespace CustomProjection {
    public partial class Form1 : Form {
        const string filepath = "../../Data/Countries.shp";

        GeoMapCoordinateSystem CoordinateSystem {
            get { return (GeoMapCoordinateSystem)mapControl1.CoordinateSystem; }
        }

        VectorItemsLayer MapLayer {
            get { return (VectorItemsLayer)mapControl1.Layers["MapLayer"]; }
        }

        ShapefileDataAdapter Adapter {
            get { return (ShapefileDataAdapter)MapLayer.Data; }
        }

        public Form1() {
            InitializeComponent();
            CoordinateSystem.Projection = new HammerAitoffProjection();

            Uri baseUri = new Uri(System.Reflection.Assembly.GetEntryAssembly().Location);
            Adapter.FileUri = new Uri(baseUri, filepath);
        }
    }
}

HammerAitoffProjection.cs

using System;
using DevExpress.XtraMap;

namespace CustomProjection {
    public class HammerAitoffProjection : ProjectionBase {
        const double minLatitude = -90.0;
        const double maxLatitude = 90.0;
        const double minLongitude = -180.0;
        const double maxLongitude = 180.0;

        public override double OffsetX { get { return 0.5; } }
        public override double OffsetY { get { return 0.5; } }
        public override double ScaleX { get { return 0.5; } }
        public override double ScaleY { get { return -0.25; } }

        bool IsValidPoint(double x, double y) {
            if (Math.Pow(x, 2) + Math.Pow(y, 2) > 1)
                return false;
            else
                return true;
        }

        static double RadianToDegree(double value) {
            return value * 180.0 / Math.PI;
        }

        static double DegreeToRadian(double value) {
            return value * Math.PI / 180.0;
        }

        public override MapUnit GeoPointToMapUnit(GeoPoint geoPoint) {
            double lonInRadian = DegreeToRadian(
                Math.Min(
                    maxLongitude,
                    Math.Max(minLongitude, geoPoint.Longitude)
                )
            );
            double latInRadian = DegreeToRadian(
                Math.Min(
                    maxLatitude,
                    Math.Max(minLatitude, geoPoint.Latitude)
                )
            );
            double z = Math.Sqrt(1 + Math.Cos(latInRadian) * Math.Cos(lonInRadian / 2));
            double x = Math.Cos(latInRadian) * Math.Sin(lonInRadian / 2) / z;
            double y = Math.Sin(latInRadian) / z;

            return new MapUnit(x * ScaleX + OffsetX, y * ScaleY + OffsetY);

        }

        public override GeoPoint MapUnitToGeoPoint(MapUnit mapPoint) {
            double x = (mapPoint.X - OffsetX) / ScaleX;
            double y = Math.Min(1, Math.Max(-1, (mapPoint.Y - OffsetY) / ScaleY));

            if (IsValidPoint(x, y)) {
                double z = Math.Sqrt(1 - 0.5 * Math.Pow(x, 2) - 0.5 * Math.Pow(y, 2));
                double c = Math.Sqrt(2) * z * x / (2 * Math.Pow(z, 2) - 1);
                double lon = 2 * Math.Atan(c);
                double lat = Math.Asin(Math.Min(Math.Max(Math.Sqrt(2) * z * y, -1), 1));
                double latInDegree = lat * 180.0 / Math.PI;
                double lonInDegree = lon * 180.0 / Math.PI;

                return new GeoPoint(
                    Math.Min(
                        maxLatitude,
                        Math.Max(minLatitude, RadianToDegree(lat))
                    ),
                    Math.Min(
                        maxLongitude,
                        Math.Max(minLongitude, RadianToDegree(lon))
                    )
                );
            }
            else {
                int signX = (x < 0) ? -1 : 1;
                int signY = (y < 0) ? -1 : 1;
                return new GeoPoint(maxLatitude * signY, maxLongitude * signX);
            }

        }

        public override MapSize GeoToKilometersSize(GeoPoint anchorPoint, MapSize size) {
            return new MapSize(              
                size.Width * LonToKilometersRatio * Math.Cos(DegreeToRadian(anchorPoint.Latitude)),
                size.Height * LatToKilometersRatio
            );
        }

        public override MapSize KilometersToGeoSize(GeoPoint anchorPoint, MapSize size) {
            return new MapSize(
                size.Width / LonToKilometersRatio / Math.Cos(DegreeToRadian(anchorPoint.Latitude)),
                size.Height / LatToKilometersRatio
            );
        }
    }
}

Form1.vb

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraMap

Namespace CustomProjection
    Partial Public Class Form1
        Inherits Form

        Private Const filepath As String = "../../Data/Countries.shp"

        Private ReadOnly Property CoordinateSystem() As GeoMapCoordinateSystem
            Get
                Return CType(mapControl1.CoordinateSystem, GeoMapCoordinateSystem)
            End Get
        End Property

        Private ReadOnly Property MapLayer() As VectorItemsLayer
            Get
                Return CType(mapControl1.Layers("MapLayer"), VectorItemsLayer)
            End Get
        End Property

        Private ReadOnly Property Adapter() As ShapefileDataAdapter
            Get
                Return CType(MapLayer.Data, ShapefileDataAdapter)
            End Get
        End Property

        Public Sub New()
            InitializeComponent()
            CoordinateSystem.Projection = New HammerAitoffProjection()

            Dim baseUri As New Uri(System.Reflection.Assembly.GetEntryAssembly().Location)
            Adapter.FileUri = New Uri(baseUri, filepath)
        End Sub
    End Class
End Namespace

HammerAitoffProjection.vb

Imports System
Imports DevExpress.XtraMap

Namespace CustomProjection
    Public Class HammerAitoffProjection
        Inherits ProjectionBase

        Private Const minLatitude As Double = -90.0
        Private Const maxLatitude As Double = 90.0
        Private Const minLongitude As Double = -180.0
        Private Const maxLongitude As Double = 180.0

        Public Overrides Property OffsetX() As Double
            Set(value As Double)
            End Set
            Get
                Return 0.5
            End Get
        End Property
        Public Overrides Property OffsetY() As Double
            Set(value As Double)
            End Set
            Get
                Return 0.5
            End Get
        End Property
        Public Overrides Property ScaleX() As Double
            Set(value As Double)
            End Set
            Get
                Return 0.5
            End Get
        End Property
        Public Overrides Property ScaleY() As Double
            Set(value As Double)
            End Set
            Get
                Return -0.25
            End Get
        End Property

        Private Function IsValidPoint(ByVal x As Double, ByVal y As Double) As Boolean
            If Math.Pow(x, 2) + Math.Pow(y, 2) > 1 Then
                Return False
            Else
                Return True
            End If
        End Function

        Private Shared Function RadianToDegree(ByVal value As Double) As Double
            Return value * 180.0 / Math.PI
        End Function

        Private Shared Function DegreeToRadian(ByVal value As Double) As Double
            Return value * Math.PI / 180.0
        End Function

        Public Overrides Function GeoPointToMapUnit(ByVal geoPoint As GeoPoint) As MapUnit
            Dim lonInRadian As Double = DegreeToRadian(Math.Min(maxLongitude, Math.Max(minLongitude, geoPoint.Longitude)))
            Dim latInRadian As Double = DegreeToRadian(Math.Min(maxLatitude, Math.Max(minLatitude, geoPoint.Latitude)))
            Dim z As Double = Math.Sqrt(1 + Math.Cos(latInRadian) * Math.Cos(lonInRadian / 2))
            Dim x As Double = Math.Cos(latInRadian) * Math.Sin(lonInRadian / 2) / z
            Dim y As Double = Math.Sin(latInRadian) / z

            Return New MapUnit(x * ScaleX + OffsetX, y * ScaleY + OffsetY)

        End Function

        Public Overrides Function MapUnitToGeoPoint(ByVal mapPoint As MapUnit) As GeoPoint
            Dim x As Double = (mapPoint.X - OffsetX) / ScaleX
            Dim y As Double = Math.Min(1, Math.Max(-1, (mapPoint.Y - OffsetY) / ScaleY))

            If IsValidPoint(x, y) Then
                Dim z As Double = Math.Sqrt(1 - 0.5 * Math.Pow(x, 2) - 0.5 * Math.Pow(y, 2))
                Dim c As Double = Math.Sqrt(2) * z * x / (2 * Math.Pow(z, 2) - 1)
                Dim lon As Double = 2 * Math.Atan(c)
                Dim lat As Double = Math.Asin(Math.Min(Math.Max(Math.Sqrt(2) * z * y, -1), 1))
                Dim latInDegree As Double = lat * 180.0 / Math.PI
                Dim lonInDegree As Double = lon * 180.0 / Math.PI

                Return New GeoPoint(Math.Min(maxLatitude, Math.Max(minLatitude, RadianToDegree(lat))), Math.Min(maxLongitude, Math.Max(minLongitude, RadianToDegree(lon))))
            Else
                Dim signX As Integer = If(x < 0, -1, 1)
                Dim signY As Integer = If(y < 0, -1, 1)
                Return New GeoPoint(maxLatitude * signY, maxLongitude * signX)
            End If

        End Function

        Public Overrides Function GeoToKilometersSize(ByVal anchorPoint As GeoPoint, ByVal size As MapSize) As MapSize
            Return New MapSize(size.Width * LonToKilometersRatio * Math.Cos(DegreeToRadian(anchorPoint.Latitude)), size.Height * LatToKilometersRatio)
        End Function

        Public Overrides Function KilometersToGeoSize(ByVal anchorPoint As GeoPoint, ByVal size As MapSize) As MapSize
            Return New MapSize(size.Width / LonToKilometersRatio / Math.Cos(DegreeToRadian(anchorPoint.Latitude)), size.Height / LatToKilometersRatio)
        End Function
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ProjectionBase class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-specify-a-map-projection-t232940/CS/MapProjections/Form1.cs#L9

const string filepath = @"..\..\Data\Countries.shp";
List<ProjectionBase> mapProjections = new List<ProjectionBase>() {
    new BraunStereographicProjection(),

how-to-implement-a-custom-map-projection-e4783/CS/CustomProjection/HammerAitoffProjection.cs#L5

namespace CustomProjection {
    public class HammerAitoffProjection : ProjectionBase {
        const double minLatitude = -90.0;

how-to-load-image-tiles-from-another-source-by-creating-custom-data-provider-e4758/CS/CustomProvider/Form1.cs#L36

public override ProjectionBase Projection {
    get {

VB.NET

how-to-specify-a-map-projection-t232940/VB/MapProjections/Form1.vb#L11

Private Const filepath As String = "..\..\Data\Countries.shp"
Private mapProjections As New List(Of ProjectionBase)() From { _
    New BraunStereographicProjection(), _

how-to-implement-a-custom-map-projection-e4783/VB/CustomProjection/HammerAitoffProjection.vb#L6

Public Class HammerAitoffProjection
    Inherits ProjectionBase

how-to-load-image-tiles-from-another-source-by-creating-custom-data-provider-e4758/VB/CustomProvider/Form1.vb#L39

Public Overrides ReadOnly Property Projection() As ProjectionBase
    Get

Inheritance

Show 13 items

Object

ProjectionBase

SphericalMercatorProjection

EquirectangularProjection

EquidistantProjection

EqualAreaProjection

EPSG4326Projection

EllipticalMercatorProjection

BraunStereographicProjection

MillerProjection

SinusoidalProjection

LambertCylindricalEqualAreaProjection

KavrayskiyProjection