Geometry is the root class of the hierarchy. Geometry is an abstract (non-instantiable) class.
The instantiable subclasses of Geometry defined in this International Standard are restricted to 0, 1 and 2-dimensional geometric objects that exist in 2-dimensional coordinate space (R2).
All instantiable Geometry classes described in this part of ISO 19125 are defined so that valid instances of a Geometry class are topologically closed, i.e. all defined geometries include their boundary.
Geometry is defined as a module and is provided
primarily for the sake of documentation. Implementations need not
necessarily include this module itself. Therefore, you should not depend on
the result of is_a?(Geometry) to check type. Instead, use the
provided check_type class method (or === operator) defined in the Type module.
Some implementations may support higher dimensional objects or coordinate systems, despite the limits of the SFS.
The Geometry model defines three forms of equivalence.
Spatial equivalence is the weakest form of equivalence, indicating that the objects represent the same region of space, but may be different representations of that region. For example, POINT(0 0) and a MULTIPOINT(0 0) are spatially equivalent, as are LINESTRING(0 0, 10 10) and GEOMETRYCOLLECTION(POINT(0 0), LINESTRING(0 0, 10 10, 0 0)). As a general rule, objects must have factories that are Factory#eql? in order to be spatially equivalent.
Objective equivalence is a stronger form of equivalence, indicating that the objects are the same representation, but may be different objects. All objectively equivalent objects are spatially equivalent, but not all spatially equivalent objects are objectively equivalent. For example, none of the examples in the spatial equivalence section above are objectively equivalent. However, two separate objects that both represent POINT(1 2) are objectively equivalent as well as spatially equivalent.
Objective identity is the strongest form, indicating that the references refer to the same object. Of course, all pairs of references with the same objective identity are both objectively equivalent and spatially equivalent.
Different methods test for different types of equivalence:
equals? and == test for spatial equivalence.
eql? tests for objective equivalence.
equal? tests for objective identity.
If the given rhs is a geometry object, this operator must behave the same as the intersection method. The behavior for other rhs types is not specified; an implementation may choose to provide additional capabilities as appropriate.
# File lib/rgeo/feature/geometry.rb, line 618 def *(rhs_) intersection(rhs_) end
If the given rhs is a geometry object, this operator must behave the same as the union method. The behavior for other rhs types is not specified; an implementation may choose to provide additional capabilities as appropriate.
# File lib/rgeo/feature/geometry.rb, line 608 def +(rhs_) union(rhs_) end
If the given rhs is a geometry object, this operator must behave the same as the difference method. The behavior for other rhs types is not specified; an implementation may choose to provide additional capabilities as appropriate.
# File lib/rgeo/feature/geometry.rb, line 598 def -(rhs_) difference(rhs_) end
This operator should behave almost the same as the equals? method. The difference is that the == operator is required to handle rhs values that are not geometry objects (returning false in such cases) in order to fulfill the standard Ruby contract for the == operator, whereas the equals? method may assume that any rhs is a geometry.
# File lib/rgeo/feature/geometry.rb, line 588 def ==(rhs_) rhs_.kind_of?(::RGeo::Feature::Instance) ? equals?(rhs_) : false end
Exports this geometric object to a specific Well-known Binary Representation of Geometry.
Returns a binary string.
# File lib/rgeo/feature/geometry.rb, line 214 def as_binary raise Error::UnsupportedOperation, "Method Geometry#as_binary not defined." end
Exports this geometric object to a specific Well-known Text Representation of Geometry.
Returns an ASCII string.
# File lib/rgeo/feature/geometry.rb, line 200 def as_text raise Error::UnsupportedOperation, "Method Geometry#as_text not defined." end
Returns the closure of the combinatorial boundary of this geometric object. Because the result of this function is a closure, and hence topologically closed, the resulting boundary can be represented using representational Geometry primitives.
Returns an object that supports the Geometry interface.
# File lib/rgeo/feature/geometry.rb, line 264 def boundary raise Error::UnsupportedOperation, "Method Geometry#boundary not defined." end
Returns a geometric object that represents all Points whose distance from this geometric object is less than or equal to distance. Calculations are in the spatial reference system of this geometric object.
Returns an object that supports the Geometry interface.
# File lib/rgeo/feature/geometry.rb, line 487 def buffer(distance_) raise Error::UnsupportedOperation, "Method Geometry#buffer not defined." end
Returns true if this geometric object “spatially contains” another_geometry.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 404 def contains?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#contains? not defined." end
Returns a geometric object that represents the convex hull of this geometric object.
Returns an object that supports the Geometry interface.
# File lib/rgeo/feature/geometry.rb, line 501 def convex_hull raise Error::UnsupportedOperation, "Method Geometry#convex_hull not defined." end
Returns true if this geometric object “spatially crosses” another_geometry.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 364 def crosses?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#crosses? not defined." end
Returns a geometric object that represents the Point set difference of this geometric object with another_geometry.
Returns an object that supports the Geometry interface.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of performing operations on objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 558 def difference(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#difference not defined." end
The inherent dimension of this geometric object, which must be less than or equal to the coordinate dimension. This specification is restricted to geometries in 2-dimensional coordinate space.
Returns an integer. This value is -1 for an empty geometry, 0 for point geometries, 1 for curves, and 2 for surfaces.
# File lib/rgeo/feature/geometry.rb, line 137 def dimension raise Error::UnsupportedOperation, "Method Geometry#dimension not defined." end
Returns true if this geometric object is “spatially disjoint” from another_geometry.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 304 def disjoint?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#disjoint? not defined." end
Returns the shortest distance between any two Points in the two geometric objects as calculated in the spatial reference system of this geometric object.
Returns a floating-point scalar value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of measuring the distance between objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 471 def distance(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#distance not defined." end
The minimum bounding box for this Geometry, returned as a Geometry. The polygon is defined by the corner points of the bounding box [(MINX, MINY), (MAXX, MINY), (MAXX, MAXY), (MINX, MAXY), (MINX, MINY)].
Returns an object that supports the Geometry interface.
# File lib/rgeo/feature/geometry.rb, line 186 def envelope raise Error::UnsupportedOperation, "Method Geometry#envelope not defined." end
Returns true if this geometric object is objectively equivalent to the given object.
# File lib/rgeo/feature/geometry.rb, line 121 def eql?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#eql? not defined." end
Returns true if this geometric object is “spatially equal” to another_geometry.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 284 def equals?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#equals? not defined." end
Returns a factory for creating features related to this one. This does not necessarily need to be the same factory that created this object, but it should create objects that are “compatible” with this one. (i.e. they should be in the same spatial reference system by default, and it should be possible to perform relational operations on them.)
# File lib/rgeo/feature/geometry.rb, line 113 def factory raise Error::UnsupportedOperation, "Method Geometry#factory not defined." end
Returns the instantiable subtype of Geometry of which this geometric object is an instantiable member.
Returns one of the type modules in RGeo::Feature. e.g. a point object would return
RGeo::Feature::Point. Note that this is different
from the SFS specification, which stipulates that the string name of the
type is returned. To obtain the name string, call the
type_name method of the returned module.
# File lib/rgeo/feature/geometry.rb, line 155 def geometry_type raise Error::UnsupportedOperation, "Method Geometry#geometry_type not defined." end
Returns a geometric object that represents the Point set intersection of this geometric object with another_geometry.
Returns an object that supports the Geometry interface.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of performing operations on objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 520 def intersection(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#intersection not defined." end
Returns true if this geometric object “spatially intersects” another_geometry.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 324 def intersects?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#intersects? not defined." end
Returns true if this geometric object is the empty Geometry. If true, then this geometric object represents the empty point set for the coordinate space.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
# File lib/rgeo/feature/geometry.rb, line 230 def is_empty? raise Error::UnsupportedOperation, "Method Geometry#is_empty? not defined." end
Returns true if this geometric object has no anomalous geometric points, such as self intersection or self tangency. The description of each instantiable geometric class will include the specific conditions that cause an instance of that class to be classified as not simple.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
# File lib/rgeo/feature/geometry.rb, line 248 def is_simple? raise Error::UnsupportedOperation, "Method Geometry#is_simple? not defined." end
Returns true if this geometric object “spatially overlaps” another_geometry.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 424 def overlaps?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#overlaps? not defined." end
Returns true if this geometric object is spatially related to another_geometry by testing for intersections between the interior, boundary and exterior of the two geometric objects as specified by the values in the intersection_pattern_matrix.
The intersection_pattern_matrix is provided as a nine-character string in row-major order, representing the dimensionalities of the different intersections in the DE-9IM. Supported characters include T, F, *, 0, 1, and 2.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 451 def relate(another_geometry_, intersection_pattern_matrix_) raise Error::UnsupportedOperation, "Method Geometry#relate not defined." end
Returns the Spatial Reference System ID for this geometric object.
Returns an integer.
This will normally be a foreign key to an index of reference systems stored in either the same or some other datastore.
# File lib/rgeo/feature/geometry.rb, line 171 def srid raise Error::UnsupportedOperation, "Method Geometry#srid not defined." end
Returns a geometric object that represents the Point set symmetric difference of this geometric object with another_geometry.
Returns an object that supports the Geometry interface.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of performing operations on objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 577 def sym_difference(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#sym_difference not defined." end
Returns true if this geometric object “spatially touches” another_geometry.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 344 def touches?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#touches? not defined." end
Returns a geometric object that represents the Point set union of this geometric object with another_geometry.
Returns an object that supports the Geometry interface.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of performing operations on objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 539 def union(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#union not defined." end
Returns true if this geometric object is “spatially within” another_geometry.
Returns a boolean value. Note that this is different from the SFS specification, which stipulates an integer return value.
Although implementations are free to attempt to handle another_geometry values that do not share the same factory as this geometry, strictly speaking, the result of comparing objects of different factories is undefined.
# File lib/rgeo/feature/geometry.rb, line 384 def within?(another_geometry_) raise Error::UnsupportedOperation, "Method Geometry#within? not defined." end