-
-
Notifications
You must be signed in to change notification settings - Fork 31
/
Point.php
280 lines (240 loc) · 6.92 KB
/
Point.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<?php
declare(strict_types=1);
namespace Brick\Geo;
use ArrayIterator;
use Brick\Geo\Attribute\NoProxy;
use Brick\Geo\Exception\InvalidGeometryException;
use Brick\Geo\Projector\Projector;
/**
* A Point is a 0-dimensional geometric object and represents a single location in coordinate space.
*
* A Point has an x-coordinate value, a y-coordinate value.
* If called for by the associated Spatial Reference System, it may also have coordinate values for z and m.
*
* The boundary of a Point is the empty set.
*/
class Point extends Geometry
{
/**
* The x-coordinate value for this Point, or NULL if the point is empty.
*/
private ?float $x = null;
/**
* The y-coordinate value for this Point, or NULL if the point is empty.
*/
private ?float $y = null;
/**
* The z-coordinate value for this Point, or NULL if it does not have one.
*/
private ?float $z = null;
/**
* The m-coordinate value for this Point, or NULL if it does not have one.
*/
private ?float $m = null;
/**
* @param CoordinateSystem $cs The coordinate system.
* @param float ...$coords The point coordinates; can be empty for an empty point.
*
* @throws InvalidGeometryException If the number of coordinates does not match the coordinate system.
*/
public function __construct(CoordinateSystem $cs, float ...$coords)
{
parent::__construct($cs, ! $coords);
if ($coords) {
if (count($coords) !== $cs->coordinateDimension()) {
throw new InvalidGeometryException(sprintf(
'Expected %d coordinates for Point %s, got %d.',
$cs->coordinateDimension(),
$cs->coordinateName(),
count($coords)
));
}
$coords = array_values($coords);
foreach ($coords as $i => $coord) {
if (! is_finite($coord)) {
$coordinateName = match ($i) {
0 => 'X',
1 => 'Y',
2 => $cs->hasZ() ? 'Z' : 'M',
3 => 'M',
};
throw new InvalidGeometryException(sprintf(
'Coordinate #%d (%s) for Point %s is %s, this is not allowed.',
$i + 1,
$coordinateName,
$cs->coordinateName(),
is_infinite($coord) ? ($coord > 0 ? '+' : '-') . 'INF' : 'NaN',
));
}
}
$this->x = $coords[0];
$this->y = $coords[1];
$hasZ = $cs->hasZ();
$hasM = $cs->hasM();
if ($hasZ) {
$this->z = $coords[2];
}
if ($hasM) {
$this->m = $coords[$hasZ ? 3 : 2];
}
}
}
/**
* Creates a point with X and Y coordinates.
*/
public static function xy(float $x, float $y, int $srid = 0) : Point
{
return new Point(CoordinateSystem::xy($srid), $x, $y);
}
/**
* Creates a point with X, Y and Z coordinates.
*/
public static function xyz(float $x, float $y, float $z, int $srid = 0) : Point
{
return new Point(CoordinateSystem::xyz($srid), $x, $y, $z);
}
/**
* Creates a point with X, Y and M coordinates.
*/
public static function xym(float $x, float $y, float $m, int $srid = 0) : Point
{
return new Point(CoordinateSystem::xym($srid), $x, $y, $m);
}
/**
* Creates a point with X, Y, Z and M coordinates.
*/
public static function xyzm(float $x, float $y, float $z, float $m, int $srid = 0) : Point
{
return new Point(CoordinateSystem::xyzm($srid), $x, $y, $z, $m);
}
/**
* Creates an empty Point with XY dimensionality.
*/
public static function xyEmpty(int $srid = 0) : Point
{
return new Point(CoordinateSystem::xy($srid));
}
/**
* Creates an empty Point with XYZ dimensionality.
*/
public static function xyzEmpty(int $srid = 0) : Point
{
return new Point(CoordinateSystem::xyz($srid));
}
/**
* Creates an empty Point with XYM dimensionality.
*/
public static function xymEmpty(int $srid = 0) : Point
{
return new Point(CoordinateSystem::xym($srid));
}
/**
* Creates an empty Point with XYZM dimensionality.
*/
public static function xyzmEmpty(int $srid = 0) : Point
{
return new Point(CoordinateSystem::xyzm($srid));
}
/**
* Returns the x-coordinate value for this Point.
*
* Returns NULL if the Point is empty.
*/
public function x() : ?float
{
return $this->x;
}
/**
* Returns the y-coordinate value for this Point.
*
* Returns NULL if the Point is empty.
*/
public function y() : ?float
{
return $this->y;
}
/**
* Returns the z-coordinate value for this Point.
*
* Returns NULL if the Point is empty, or does not have a Z coordinate.
*/
public function z() : ?float
{
return $this->z;
}
/**
* Returns the m-coordinate value for this Point.
*
* Returns NULL if the Point is empty, or does not have a M coordinate.
*/
public function m() : ?float
{
return $this->m;
}
#[NoProxy]
public function geometryType() : string
{
return 'Point';
}
#[NoProxy]
public function geometryTypeBinary() : int
{
return Geometry::POINT;
}
#[NoProxy]
public function dimension() : int
{
return 0;
}
public function getBoundingBox() : BoundingBox
{
return (new BoundingBox())->extendedWithPoint($this);
}
/**
* @psalm-return list<float>
*
* @return float[]
*/
public function toArray() : array
{
if ($this->isEmpty) {
return [];
}
/** @var list<float> $result */
$result = [$this->x, $this->y];
if ($this->z !== null) {
$result[] = $this->z;
}
if ($this->m !== null) {
$result[] = $this->m;
}
return $result;
}
public function project(Projector $projector) : Point
{
return $projector->project($this);
}
/**
* Returns the number of coordinates in this Point.
*
* Required by interface Countable.
*/
public function count() : int
{
if ($this->isEmpty) {
return 0;
}
return $this->coordinateSystem->coordinateDimension();
}
/**
* Returns an iterator for the coordinates in this Point.
*
* Required by interface IteratorAggregate.
*
* @psalm-return ArrayIterator<int, float>
*/
public function getIterator() : ArrayIterator
{
return new ArrayIterator($this->toArray());
}
}