com.gwidgets.api.leaflet

Class CRS

java.lang.Object

com.gwidgets.api.leaflet.CRS

@JsType(isNative=true)
public abstract class CRS
extends Object

Defines coordinate reference systems for projecting geographical points into pixel (screen) coordinates and back (and to coordinates in other units for WMS services).

Author:

Zakaria Amine

Field Summary

Fields

Modifier and Type	Field and Description
String	code Standard code name of the CRS passed into WMS services (e.g.
Boolean	infinite If true, the coordinate space will be unbounded (infinite in both axes)
double[]	wrapLat Like wrapLng, but for the latitude (vertical) axis.
double[]	wrapLng An array of two numbers defining whether the longitude (horizontal) coordinate axis wraps around a given range and how.

Constructor Summary

Constructors

Constructor and Description
CRS()

Method Summary

Modifier and Type	Method and Description
double	distance(LatLng latlng1, LatLng latlng2) Returns the distance between two geographical coordinates.
Bounds	getProjectedBounds(double zoom) Returns the projection's bounds scaled and transformed for the provided zoom.
Point	latLngToPoint(LatLng latlng, double zoom) Projects geographical coordinates on a given zoom into pixel coordinates.
LatLng	pointToLatLng(Point point, double zoom) The inverse of latLngToPoint.
Point	project(LatLng latlng) Projects geographical coordinates into coordinates in units accepted for this CRS (e.g.
double	scale(double zoom) Returns the scale used when transforming projected coordinates into pixel coordinates for a particular zoom.
LatLng	unproject(Point point) Given a projected coordinate returns the corresponding LatLng.
double	wrapLatLng(LatLng latlng) Returns a LatLng where lat and lng has been wrapped according to the CRS's wrapLat and wrapLng properties, if they are outside the CRS's bounds.
double	zoom(double scale) Inverse of scale(), returns the zoom level corresponding to a scale factor of scale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

code

@JsProperty
public String code

Standard code name of the CRS passed into WMS services (e.g. 'EPSG:3857')

wrapLng

@JsProperty
public double[] wrapLng

An array of two numbers defining whether the longitude (horizontal) coordinate axis wraps around a given range and how. Defaults to [-180, 180] in most geographical CRSs. If undefined, the longitude axis does not wrap around.

wrapLat

@JsProperty
public double[] wrapLat

Like wrapLng, but for the latitude (vertical) axis.

infinite

@JsProperty
public Boolean infinite

If true, the coordinate space will be unbounded (infinite in both axes)

Constructor Detail

CRS

public CRS()

Method Detail

latLngToPoint

@JsMethod
public Point latLngToPoint(LatLng latlng,
                                     double zoom)

Projects geographical coordinates on a given zoom into pixel coordinates.

Parameters:

latlng - the latlng

zoom - the zoom

Returns:

the point

pointToLatLng

@JsMethod
public LatLng pointToLatLng(Point point,
                                      double zoom)

The inverse of latLngToPoint. Projects pixel coordinates on a given zoom into geographical coordinates.

Parameters:

point - the point

zoom - the zoom

Returns:

the lat lng

project

@JsMethod
public Point project(LatLng latlng)

Projects geographical coordinates into coordinates in units accepted for this CRS (e.g. meters for EPSG:3857, for passing it to WMS services).

Parameters:

latlng - the latlng

Returns:

the point

unproject

@JsMethod
public LatLng unproject(Point point)

Given a projected coordinate returns the corresponding LatLng. The inverse of project.

Parameters:

point - the point

Returns:

the latlng

scale

@JsMethod
public double scale(double zoom)

Returns the scale used when transforming projected coordinates into pixel coordinates for a particular zoom. For example, it returns 256 * 2^zoom for Mercator-based CRS.

Parameters:

zoom - the zoom

Returns:

the number

zoom

@JsMethod
public double zoom(double scale)

Inverse of scale(), returns the zoom level corresponding to a scale factor of scale.

Parameters:

scale - the scale

Returns:

the zoom level

getProjectedBounds

@JsMethod
public Bounds getProjectedBounds(double zoom)

Returns the projection's bounds scaled and transformed for the provided zoom.

Parameters:

zoom - the zoom level

Returns:

the bounds

distance

@JsMethod
public double distance(LatLng latlng1,
                                 LatLng latlng2)

Returns the distance between two geographical coordinates.

Parameters:

latlng1 -

latlng2 -

Returns:

the distance

wrapLatLng

@JsMethod
public double wrapLatLng(LatLng latlng)

Returns a LatLng where lat and lng has been wrapped according to the CRS's wrapLat and wrapLng properties, if they are outside the CRS's bounds.

Parameters:

latlng -

Returns:

the LatLng