Point2 class
An immutable point with X and Y as num values.
Constructors
- Point2({required num x, required num y})
-
A point at given x and y.
const
- Point2.create({required num x, required num y, num? z, num? m})
-
A point from parameters compatible with CreatePosition function type.
const
-
Point2.from(Iterable<
num> coords, {int? offset}) -
A point from
coords
given in order: x, y.factory - Point2.fromText(String text, {Pattern? delimiter})
-
A point parsed from
text
with coordinates given in order: x, y.factory - Point2.origin()
-
A point at the origin (0.0, 0.0).
const
- Point2.parse(String text, {ParseCoords? parser})
-
A point parsed from
text
with coordinates in order: x, y.factory - Point2.xy(num x, num y)
-
A point with coordinates given in order x, y.
const
Properties
-
bounds
→ Bounds<
Point< ?num> > -
The bounds for this object (could be calculated if not explicitely set).
no setterinherited
-
boundsExplicit
→ Bounds<
Point< ?num> > -
The explicit bounds for this object when available.
no setterinherited
- coordinateDimension → int
-
The number of coordinate values (2, 3 or 4).
no setter
- dimension → int
-
The topological dimension of this geometry.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- is3D → bool
-
True for 3D positions (with z or elevation coordinate).
no setter
- isEmpty → bool
-
True if this geometry is considered empty without data or coordinates.
no setterinherited
- isGeographic → bool
-
True for geographic coordinates (with longitude and latitude).
no setterinherited
- isMeasured → bool
-
True if a measure value is available (or the m coordinate for a position).
no setter
- isNotEmpty → bool
-
True if this geometry is NOT considered empty without data or coordinates.
no setterinherited
- m → num
-
The m ("measure") coordinate value. Returns zero if not available.
no setterinherited
-
onePoint
→ Point<
num> ? -
Returns one of points contained by this geometry if it's not empty.
no setterinherited
- optM → num?
-
The m ("measure") coordinate optionally. Returns null if not available.
no setterinherited
- optZ → num?
-
The z coordinate value optionally. Returns null if not available.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spatialDimension → int
-
The number of spatial coordinate values (2 for 2D or 3 for 3D).
no setter
- type → Coords
-
The coordinate type.
no setter
- typeGeom → Geom
-
The type of this geometry.
no setterinherited
-
values
→ List<
num> -
Returns coordinate values of this point as a fixed length list.
no setterinherited
- x → num
-
The x coordinate value.
final
- y → num
-
The y coordinate value.
final
- z → num
-
The z coordinate value. Returns zero if not available.
no setterinherited
Methods
-
copyTo<
R extends Position> (CreatePosition< R> factory) → R -
Copies this position to a new position created by the
factory
.inherited -
copyWith(
{num? x, num? y, num? z, num? m}) → Point2 -
Copies this point with optional
x
,y
,z
andm
overriding values.override -
equals2D(
Position other, {num? toleranceHoriz}) → bool -
True if this position equals with
other
by testing 2D coordinates only.inherited -
equals3D(
Position other, {num? toleranceHoriz, num? toleranceVert}) → bool -
True if this position equals with
other
by testing 3D coordinates only.inherited -
newFrom(
Iterable< num> coords, {int? offset, int? length}) → Point2 -
Creates a new point instance of a type compatible with this object.
override
-
newWith(
{num x = 0.0, num y = 0.0, num? z, num? m}) → Point2 -
Creates a new point instance of a type compatible with this object.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
project<
R extends Point< (num> >Projection projection, {required CreatePosition< R> to}) → R -
Returns a new point projected from this point using
projection
.inherited -
toString(
) → String -
A string representation of this object.
override
-
toStringAs(
{TextWriterFormat< GeometryContent> format = DefaultFormat.geometry, int? decimals}) → String -
A string representation of this geometry, with
format
applied.inherited -
transform(
TransformPosition transform) → Point2 -
Returns a new point transformed from this point using transform.
override
-
valuesAsString(
{String delimiter = ',', int? decimals}) → String -
A string representation of coordinate values separated by
delimiter
.inherited -
writeTo(
SimpleGeometryContent writer) → void -
Writes this geometry object to
writer
.inherited -
writeValues(
StringSink buffer, {String delimiter = ',', int? decimals}) → void -
Writes coordinate values to
buffer
separated bydelimiter
.inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
int i) → num -
A coordinate value by the coordinate axis index
i
.override
Static Methods
-
tryParse(
String text, {ParseCoords? parser}) → Point2? -
A point parsed from
text
with coordinates in order: x, y.
Constants
-
coordinates
→ const PointFactory<
Point2> -
A PointFactory creating
Point2
instances.