phpDocumentor

Spatial extends GBox

in package

• shomgt
• mapcat

BBox en coord. géo., chaque position codée comme [lon, lat]

Table of Contents

Constants

CONSTRAINTS  = ["les latitudes sont comprises entre -90° et 90°", "la latitude North est supérieure à la latitude South", "les longitudes West et East sont comprises entre -180° et 180° sauf dans l'exception circumnavigateTheEarth", "la longitude East est supérieure à la longitude West sauf dans l'exception astrideTheAntimeridian"]

Liste des contraintes

ErrorDistanceOfEmptyGBox  = 'GBox::ErrorDistanceOfEmptyGBox'

ErrorDistOfEmptyGBox  = 'GBox::ErrorDistOfEmptyGBox'

ErrorIncorrectNbOfParams  = 'BBox::ErrorIncorrectNbOfParams'

ErrorIncorrectParams  = 'BBox::ErrorIncorrectParams'

ErrorIncorrectPosTypeInBound  = 'BBox::ErrorIncorrectPosTypeInBound'

ErrorIntersectsWithUndefBBox  = 'BBox::ErrorIntersectsWithUndefBBox'

ErrorParamInConstruct  = 'GBox::ErrorParamInConstruct'

EXCEPTIONS  = ['astrideTheAntimeridian' => ["l'exception astrideTheAntimeridian correspond à une boite à cheval sur l'anti-méridien", "sauf dans l'exception circumnavigateTheEarth", "elle est indiquée par la valeur 'astrideTheAntimeridian' dans le champ exception", "dans ce cas East < West mais Spatial::__construct() augmente East de 360° pour que East > West"], 'circumnavigateTheEarth' => ["l'exception circumnavigateTheEarth correspond à une boite couvrant la totalité de la Terre en longitude", "elle est indiquée par la valeur 'circumnavigateTheEarth' dans le champ exception", "dans ce cas (East - West) >= 360 et -180° <= West < 180° < East < 540° (360+180)"]]

Liste des exceptions

Properties

$exception  : string|null

$max  : TPos

$min  : TPos

$precision  : int

Methods

__construct()  : mixed

ajoute au mécanisme de création de BBox la possibilité de créer une GBox à partir d'un array respectant le format Spatial défini dans MapCat et shomgt.yaml

__toString()  : string

affiche la BBox en utilisant le format GeoJSON d'un Bbox avec des coord. arrondies en fonction de la $precision définie dans la classe appelée

area()  : float

asArray()  : array<string, TPos>

asGeoJsonBbox()  : array<int, float>

renvoie un array de 4 coord [west, south, east, north] avec east < 180 conforme à la structuration dans GeoJSON

badLats()  : string|null

si les latitudes ne sont pas correctes alors renvoie la raison, sinon renvoie null

badLons()  : string|null

si les longitudes ne sont pas correctes alors renvoie la raison, sinon renvoie null

bound()  : static

retourne la BBox contenant à la fois $this et la position

center()  : TPos

retourne le centre de la BBox ou [] si elle est vide

constructTest()  : void

dist()  : float

distance la plus courte entre les position des 2 GBox, génère une exception si une des 2 BBox est vide

distance()  : float

distance entre 2 boites, nulle ssi les 2 boites sont identiques

distTest()  : void

distVerbose()  : float

dLat()  : float|null

dLon()  : float|null

east()  : float|null

empty()  : bool

renvoit vrai ssi la bbox est vide

exceptionLons()  : string|null

si $this correspond à une exception alors renvoie son libellé, sinon null

fromGeoDMd()  : self

maintien de la méthode fromGeoDMd() pour conserver la compatibilité avec le code existant

includes()  : bool

teste si $small est strictement inclus dans $this

includesTest()  : void

inters()  : bool

version bouléenne de intersects()

intersects()  : static

intersection de 2 bbox, si $this intersecte $b2 alors retourne le GBox/EBox d'intersection, sinon retourne null.

intersectsAntiMeridian()  : bool

Teste l'intersection avec l'AM

intersectsAntiMeridianTest()  : void

intersectsTest()  : void

intersectsVerbose()  : BBox|null

isBad()  : string|null

si $this n'est pas correct alors renvoie la raison, sinon null

lgeoJSON()  : string

retourne le code JS génèrant l'objet L.geoJSON

ne()  : TPos

north()  : float|null

polygon()  : TLLPos

retourne un array d'array avec les 5 positions du polygone de la BBox ou [] si elle est vide

proj()  : EBox

calcule la projection d'un GBox en utilisant $proj qui doit être défini comme projection dans coordsys

round()  : static

si $this est indéfini alors le renvoit sinon crée un nouvel objet de la classe appelée avec des coord. arrondies en fonction de la $precision définie dans la classe appelée

size()  : float

taille max en degrés de longueur constante (Zoom::Size0 / 360) ou rettourne 0 si la BBox est vide

south()  : float|null

sw()  : TPos

test()  : void

translate360East()  : static

retourne le GBox translaté de 360° vers l'est

translate360West()  : static

retourne le GBox translaté de 360° vers l'ouest

union()  : static

Retourne l'union de 2 BBox

unionVerbose()  : BBox

west()  : float|null

layer()  : TGeoJsonFeatureCollection

génère une FeatureCollection GeoJson contenant le multiPolygone

multiPolygon()  : TGJMultiPolygon

Retourne la boite comme MultiPolygon GeoJSON avec décomposition en 2 polygones.

nw()  : TPos

ring()  : TLPos

se()  : TPos