EMAPI.Bounds

Instancje tej klasy reprezentują prostokąty ograniczające mapę.

Możliwe przykłady użycia

bounds = new EMAPI.Bounds();
bounds.extend(new EMAPI.LonLat(4,5));
bounds.extend(new EMAPI.LonLat(5,6));
bounds.toBBOX(); // zwraca 4,5,5,6

Podsumowanie

EMAPI.Bounds	Instancje tej klasy reprezentują prostokąty ograniczające mapę.
Properties
left	{Float} Mniejsza współrzędna pozioma.
bottom	{Float} Mniejsza współrzędna pionowa.
right	{Float} Większa współrzędna pozioma.
top	{Float} Większa współrzędna pionowa.
Functions
EMAPI.Bounds	Towrzy nowy obiekt klasy EMAPI.Bounds.
clone	Tworzy kopię prostokąta.
equals	Porównuje dwa prostokąty, aktualny z przekazywanym w parametrze.
toString	Zwraca współrzędne prostokąta w formie tekstowej.
toArray	Zwraca współrzędne prostokąta jako tablicę.
toBBOX	Zwraca współrzędne prostokąta w uproszczonej formie tekstowej.
getWidth	Zwraca szerokość prostokąta.
getHeight	Zwraca wysokość prostokąta.
getSize	Zwraca rozmiary prostokąta.
getCenterPixel	Zwraca środek ekranowy prostokąta.
getCenterLonLat	Zwraca środek geograficzny prostokąta.
add	Tworzy kopię prostokąta ze współrzędnymi przesuniętymi o podane wartości.
extend	Rozszerza, jezeli to konieczne, prostokąt tak, aby zawierał wskazany punkt lub inny prostokąt.
containsLonLat	Sprawdza, czy punkt geograficzny jest zawarty w prostokącie.
containsPixel	Sprawdza, czy punkt ekranowy jest zawarty w prostokącie.
contains	Sprawdza, czy punkt o podanych współrzędnych jest zawarty w prostokącie.
intersectsBounds	Sprawdza, czy inny prostokąt ma z aktualnym prostokątem część wspólną.
containsBounds	Sprawdza, czy inny prostokąt jest zawarty w danym prostokącie.
determineQuadrant	Sprawdza, czy w której części prostokąta znajduje się punkt geograficzny.
fromString	Alternatywna metoda konstruująca obiekt klasy EMAPI.Bounds na podstawie postaci tekstowej współrzędnych.
fromArray	Alternatywna metoda konstruująca obiekt klasy EMAPI.Bounds na podstawie tablicy współrzędnych.
fromSize	Alternatywna metoda konstruująca obiekt klasy EMAPI.Bounds na podstawie obiektu EMAPI.Size.

Properties

left

{Float} Mniejsza współrzędna pozioma.

bottom

{Float} Mniejsza współrzędna pionowa.

right

{Float} Większa współrzędna pozioma.

top

{Float} Większa współrzędna pionowa.

Functions

EMAPI.Bounds

Towrzy nowy obiekt klasy EMAPI.Bounds.

Parametry

left	{Float} Lewe ograniczenie prostokąta. Powinno być mniejsze od prawego.
bottom	{Float} Dolne ograniczenie prostokąta. Powinno być większe od górnego.
right	{Float} Prawe ograniczenie prostokąta.
top	{Float} Górne ograniczenie prostokąta.

clone

clone:function()

Tworzy kopię prostokąta.

Wynik

{EMAPI.Bounds} Nowy obiekt klasy EMAPI.Bounds z identycznymi współrzędnymi.

equals

equals:function( bounds )

Porównuje dwa prostokąty, aktualny z przekazywanym w parametrze.

Parametry

bounds

{EMAPI.Bounds} Prostokąt do porównania z aktualnym.

Wynik

{Boolean} Informacja czy prostokąty są identyczne.

toString

toString:function()

Zwraca współrzędne prostokąta w formie tekstowej.

Wynik

{String} Tekstowa reprezentacja prostokąta (np. “left-bottom=(5,42) right-top=(10,45)”).

toArray

toArray: function()

Zwraca współrzędne prostokąta jako tablicę.

Wynik

{Array(Float)} Tablica zawierającą współrzędne w kolejności [left, bottom, right, top].

toBBOX

toBBOX:function( decimal )

Zwraca współrzędne prostokąta w uproszczonej formie tekstowej.

Parametry

decimal

{Integer} Liczba znaczących cyfr w zwracanych współrzędnych (domyślnie 6).

Wynik

{String} Skrócona reprezentacja tekstowa obiektu EMAPI.Bounds (np. “5,42,10,45”).

getWidth

getWidth:function()

Zwraca szerokość prostokąta.

Wynik

{Float} Szerokość prostokąta.

getHeight

getHeight:function()

Zwraca wysokość prostokąta.

Wynik

{Float} Wysokość prostokąta.

getSize

getSize:function()

Zwraca rozmiary prostokąta.

Wynik

{EMAPI.Size} Rozmiar prostokąta w formie obiektu klasy EMAPI.Size.

getCenterPixel

getCenterPixel:function()

Zwraca środek ekranowy prostokąta.

Wynik

{EMAPI.Pixel} Ekranowy punkt środkowy prostokąta.

getCenterLonLat

getCenterLonLat:function()

Zwraca środek geograficzny prostokąta.

Wynik

{EMAPI.LonLat} Geograficzny punkt środkowy prostokąta.

add

add:function( x,
y )

Tworzy kopię prostokąta ze współrzędnymi przesuniętymi o podane wartości.

Parametry

x	{Float} Przesunięcie w poziomie.
y	{Float} Przesunięcie w pionie.

Wynik

{EMAPI.Bounds} Nowy przesunięty obiekt EMAPI.Bounds.

extend

extend:function( object )

Rozszerza, jezeli to konieczne, prostokąt tak, aby zawierał wskazany punkt lub inny prostokąt.

Parametry

object

{EMAPI.LonLat lub EMAPI.Bounds} Obiekt, który musi być zawarty w nowym prostokącie.

containsLonLat

containsLonLat:function( ll,
inclusive )

Sprawdza, czy punkt geograficzny jest zawarty w prostokącie.

Parametry

ll	{EMAPI.LonLat} Punkt geograficzny.
inclusive	{Boolean} Informacja, czy brać pod uwagę brzeg prostokąta (domyślnie true).

Wynik

{Boolean} Informacja o zawieraniu się punktu w prostokącie.

containsPixel

containsPixel:function( px,
inclusive )

Sprawdza, czy punkt ekranowy jest zawarty w prostokącie.

Parametry

px	{EMAPI.Pixel} Punkt ekranowy.
inclusive	{Boolean} Informacja, czy brać pod uwagę brzeg prostokąta (domyślnie true).

Wynik

{Boolean} Informacja o zawieraniu się punktu w prostokącie.

contains

contains:function( x,
y,
inclusive )

Sprawdza, czy punkt o podanych współrzędnych jest zawarty w prostokącie.

Parametry

x	{Float} Współrzędna x.
y	{Float} Współrzędna y.
inclusive	{Boolean} Informacja, czy brać pod uwagę brzeg prostokąta (domyślnie true).

Wynik

{Boolean} Informacja o zawieraniu się punktu w prostokącie.

intersectsBounds

intersectsBounds:function( bounds,
inclusive )

Sprawdza, czy inny prostokąt ma z aktualnym prostokątem część wspólną.

Parametry

bounds	{EMAPI.Bounds} Dane sprawdzanego prostokąta.
inclusive	{Boolean} Informacja, czy brać pod uwagę brzeg prostokąta (domyślnie true).

Wynik

{Boolean} Informacja o nachodzeniu się prostokątów.

containsBounds

containsBounds:function( bounds,
partial,
inclusive )

Sprawdza, czy inny prostokąt jest zawarty w danym prostokącie.

bounds	{EMAPI.Bounds} Dane sprawdzanego prostokąta.
partial	{Boolean} Informacja czy cały prostokąt ma się zawierać w danym, czy też wystarczy część (domyślnie false).
inclusive	{Boolean} Informacja, czy brać pod uwagę brzeg prostokąta (domyślnie true).

Wynik

{Boolean} Informacja o zawieraniu się prostokąta w danym.

determineQuadrant

determineQuadrant: function( lonlat )

Sprawdza, czy w której części prostokąta znajduje się punkt geograficzny.

Parametry

lonlat

{EMAPI.LonLat} Punkt geograficzny.

Wynik

{String} Część prostokąta (“br”, “tr”, “tl”, “bl”), w której znajduje się punkt.

fromString

E.Bounds.fromString = function( str )

Alternatywna metoda konstruująca obiekt klasy EMAPI.Bounds na podstawie postaci tekstowej współrzędnych.

Parametry

str	{String} Oddzielone przecinkiem wartości współrzędnych prostokąta (np. “5,42,10,45”).

Wynik

{EMAPI.Bounds} Nowy obiekt EMAPI.Bounds zbudowany na podstawie łańcucha przekazanego w parametrze.

fromArray

E.Bounds.fromArray = function( bbox )

Alternatywna metoda konstruująca obiekt klasy EMAPI.Bounds na podstawie tablicy współrzędnych.

Parametry

bbox	{Array(Float)} Tablica współrzędnych prostokąta (np. [5,42,10,45]).

Wynik

{EMAPI.Bounds} Nowy obiekt EMAPI.Bounds zbudowany na podstawie tablicy przekazanej w parametrze.

fromSize

E.Bounds.fromSize = function( size )

Alternatywna metoda konstruująca obiekt klasy EMAPI.Bounds na podstawie obiektu EMAPI.Size.

Parametry

size	{EMAPI.Size} Obiekt EMAPI.Size do utworzenia prostokąta.

Wynik

{EMAPI.Bounds} Nowy obiekt EMAPI.Bounds zbudowany na podstawie przekazanego parametru EMAPI.Size.