Class: Geos::Geometry

Inherits:
Object
  • Object
show all
Includes:
Tools
Defined in:
lib/ffi-geos/geometry.rb

Direct Known Subclasses

GeometryCollection, LineString, Point, Polygon

Defined Under Namespace

Classes: CouldntNormalizeError

Constant Summary

Constants included from GeomTypes

Geos::GeomTypes::GEOS_GEOMETRYCOLLECTION, Geos::GeomTypes::GEOS_LINEARRING, Geos::GeomTypes::GEOS_LINESTRING, Geos::GeomTypes::GEOS_MULTILINESTRING, Geos::GeomTypes::GEOS_MULTIPOINT, Geos::GeomTypes::GEOS_MULTIPOLYGON, Geos::GeomTypes::GEOS_POINT, Geos::GeomTypes::GEOS_POLYGON

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Tools

#bool_result, #bool_to_int, #cast_geometry_ptr, #check_enum_value, #check_geometry, #extract_options!, #pick_srid_according_to_policy, #pick_srid_from_geoms, #symbol_for_enum

Constructor Details

#initialize(ptr, options = {}) ⇒ Geometry

For internal use. Geometry objects should be created via WkbReader, WktReader and the various Geos.create_* methods.



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/ffi-geos/geometry.rb', line 17

def initialize(ptr, options = {})
  options = {
    auto_free: true
  }.merge(options)

  @ptr = FFI::AutoPointer.new(
    ptr,
    self.class.method(:release)
  )

  @ptr.autorelease = !!options[:auto_free]
  @parent = options[:parent] if options[:parent]
end

Instance Attribute Details

#ptr ⇒ Object (readonly)

Returns the value of attribute ptr.



7
8
9
 
# File 'lib/ffi-geos/geometry.rb', line 7

def ptr
  @ptr
end

Class Method Details

.release(ptr) ⇒ Object

:nodoc:



41
42
43
 
# File 'lib/ffi-geos/geometry.rb', line 41

def self.release(ptr) # :nodoc:
  FFIGeos.GEOSGeom_destroy_r(Geos.current_handle_pointer, ptr)
end

Instance Method Details

#==(other) ⇒ Object 



374
375
376
377
378
 
# File 'lib/ffi-geos/geometry.rb', line 374

def ==(other)
  return eql?(other) if other.is_a?(Geos::Geometry)

  false
end

#area ⇒ Object 



482
483
484
485
486
487
488
 
# File 'lib/ffi-geos/geometry.rb', line 482

def area
  return 0 if empty?

  double_ptr = FFI::MemoryPointer.new(:double)
  FFIGeos.GEOSArea_r(Geos.current_handle_pointer, ptr, double_ptr)
  double_ptr.read_double
end

#boundary ⇒ Object 



168
169
170
 
# File 'lib/ffi-geos/geometry.rb', line 168

def boundary
  cast_geometry_ptr(FFIGeos.GEOSBoundary_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#buffer(width, options = nil) ⇒ Object

:call-seq:

buffer(width)
buffer(width, options)
buffer(width, buffer_params)
buffer(width, quad_segs)

Calls buffer on the Geometry. Options can be passed as either a BufferParams object, as an equivalent Hash or as a quad_segs value. Default values can be found in Geos::Constants::BUFFER_PARAM_DEFAULTS.

Note that when using versions of GEOS prior to 3.3.0, only the quad_segs option is recognized when using Geometry#buffer and other options are ignored.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/ffi-geos/geometry.rb', line 110

def buffer(width, options = nil)
  options ||= {}
  params = case options
    when Hash
      Geos::BufferParams.new(options)
    when Geos::BufferParams
      options
    when Numeric
      Geos::BufferParams.new(quad_segs: options)
    else
      raise ArgumentError, 'Expected Geos::BufferParams, a Hash or a Numeric'
  end

  cast_geometry_ptr(FFIGeos.GEOSBufferWithParams_r(Geos.current_handle_pointer, ptr, params.ptr, width), srid_copy: srid)
end

#build_area ⇒ Object

Added in GEOS 3.8+



609
610
611
 
# File 'lib/ffi-geos/geometry.rb', line 609

def build_area
  cast_geometry_ptr(FFIGeos.GEOSBuildArea_r(Geos.current_handle_pointer, ptr))
end

#centroid ⇒ Object Also known as: center 



233
234
235
 
# File 'lib/ffi-geos/geometry.rb', line 233

def centroid
  cast_geometry_ptr(FFIGeos.GEOSGetCentroid_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#clip_by_rect(xmin, ymin, xmax, ymax) ⇒ Object Also known as: clip_by_rectangle

Available in GEOS 3.5.0+.



227
228
229
 
# File 'lib/ffi-geos/geometry.rb', line 227

def clip_by_rect(xmin, ymin, xmax, ymax)
  cast_geometry_ptr(FFIGeos.GEOSClipByRect_r(Geos.current_handle_pointer, ptr, xmin, ymin, xmax, ymax))
end

#constrained_delaunay_triangulation ⇒ Object 



641
642
643
 
# File 'lib/ffi-geos/geometry.rb', line 641

def constrained_delaunay_triangulation
  cast_geometry_ptr(FFIGeos.GEOSConstrainedDelaunayTriangulation_r(Geos.current_handle_pointer, ptr))
end

#contains?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


314
315
316
317
 
# File 'lib/ffi-geos/geometry.rb', line 314

def contains?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSContains_r(Geos.current_handle_pointer, ptr, geom.ptr))
end

#convex_hull ⇒ Object 



143
144
145
 
# File 'lib/ffi-geos/geometry.rb', line 143

def convex_hull
  cast_geometry_ptr(FFIGeos.GEOSConvexHull_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#coord_seq ⇒ Object 



82
83
84
 
# File 'lib/ffi-geos/geometry.rb', line 82

def coord_seq
  CoordinateSequence.new(FFIGeos.GEOSGeom_getCoordSeq_r(Geos.current_handle_pointer, ptr), false, self)
end

#coverage_union ⇒ Object

Added in GEOS 3.8+



197
198
199
 
# File 'lib/ffi-geos/geometry.rb', line 197

def coverage_union
  cast_geometry_ptr(FFIGeos.GEOSCoverageUnion_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#covered_by?(geom) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


350
351
352
353
 
# File 'lib/ffi-geos/geometry.rb', line 350

def covered_by?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSCoveredBy_r(Geos.current_handle_pointer, ptr, geom.ptr))
end

#covers?(geom) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


328
329
330
331
 
# File 'lib/ffi-geos/geometry.rb', line 328

def covers?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSCovers_r(Geos.current_handle_pointer, ptr, geom.ptr))
end

#crosses?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


304
305
306
307
 
# File 'lib/ffi-geos/geometry.rb', line 304

def crosses?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSCrosses_r(Geos.current_handle_pointer, ptr, geom.ptr))
end

#delaunay_triangulation(*args) ⇒ Object

:call-seq:

 delaunay_triangulation(options = {})
 delaunay_triangulation(tolerance, options = {})

Options:

* :tolerance
* :only_edges



630
631
632
633
634
635
636
637
 
# File 'lib/ffi-geos/geometry.rb', line 630

def delaunay_triangulation(*args)
  options = extract_options!(args)

  tolerance = args.first || options[:tolerance] || 0.0
  only_edges = bool_to_int(options[:only_edges])

  cast_geometry_ptr(FFIGeos.GEOSDelaunayTriangulation_r(Geos.current_handle_pointer, ptr, tolerance, only_edges))
end

#difference(geom, precision: nil) ⇒ Object 



147
148
149
150
151
152
153
154
155
 
# File 'lib/ffi-geos/geometry.rb', line 147

def difference(geom, precision: nil)
  check_geometry(geom)

  if precision
    cast_geometry_ptr(FFIGeos.GEOSDifferencePrec_r(Geos.current_handle_pointer, ptr, geom.ptr, precision), srid_copy: pick_srid_from_geoms(srid, geom.srid))
  else
    cast_geometry_ptr(FFIGeos.GEOSDifference_r(Geos.current_handle_pointer, ptr, geom.ptr), srid_copy: pick_srid_from_geoms(srid, geom.srid))
  end
end

#dimensions ⇒ Object 



70
71
72
 
# File 'lib/ffi-geos/geometry.rb', line 70

def dimensions
  FFIGeos.GEOSGeom_getDimensions_r(Geos.current_handle_pointer, ptr)
end

#disjoint?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


289
290
291
292
 
# File 'lib/ffi-geos/geometry.rb', line 289

def disjoint?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSDisjoint_r(Geos.current_handle_pointer, ptr, geom.ptr))
end

#distance(geom) ⇒ Object 



498
499
500
501
502
503
 
# File 'lib/ffi-geos/geometry.rb', line 498

def distance(geom)
  check_geometry(geom)
  double_ptr = FFI::MemoryPointer.new(:double)
  FFIGeos.GEOSDistance_r(Geos.current_handle_pointer, ptr, geom.ptr, double_ptr)
  double_ptr.read_double
end

#distance_indexed(geom) ⇒ Object Also known as: indexed_distance

Available in GEOS 3.7+.



507
508
509
510
511
512
 
# File 'lib/ffi-geos/geometry.rb', line 507

def distance_indexed(geom)
  check_geometry(geom)
  double_ptr = FFI::MemoryPointer.new(:double)
  FFIGeos.GEOSDistanceIndexed_r(Geos.current_handle_pointer, ptr, geom.ptr, double_ptr)
  double_ptr.read_double
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


394
395
396
 
# File 'lib/ffi-geos/geometry.rb', line 394

def empty?
  bool_result(FFIGeos.GEOSisEmpty_r(Geos.current_handle_pointer, ptr))
end

#end_point ⇒ Object 



478
479
480
 
# File 'lib/ffi-geos/geometry.rb', line 478

def end_point
  cast_geometry_ptr(FFIGeos.GEOSGeomGetEndPoint_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#envelope ⇒ Object 



246
247
248
 
# File 'lib/ffi-geos/geometry.rb', line 246

def envelope
  cast_geometry_ptr(FFIGeos.GEOSEnvelope_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#eql?(other) ⇒ Boolean Also known as: equals?

Returns:

  • (Boolean) 


368
369
370
371
 
# File 'lib/ffi-geos/geometry.rb', line 368

def eql?(other)
  check_geometry(other)
  bool_result(FFIGeos.GEOSEquals_r(Geos.current_handle_pointer, ptr, other.ptr))
end

#eql_almost?(other, decimal = 6) ⇒ Boolean Also known as: equals_almost?, almost_equals?

Returns:

  • (Boolean) 


387
388
389
390
 
# File 'lib/ffi-geos/geometry.rb', line 387

def eql_almost?(other, decimal = 6)
  check_geometry(other)
  bool_result(FFIGeos.GEOSEqualsExact_r(Geos.current_handle_pointer, ptr, other.ptr, 0.5 * (10 ** -decimal)))
end

#eql_exact?(other, tolerance) ⇒ Boolean Also known as: equals_exact?, exactly_equals?

Returns:

  • (Boolean) 


380
381
382
383
 
# File 'lib/ffi-geos/geometry.rb', line 380

def eql_exact?(other, tolerance)
  check_geometry(other)
  bool_result(FFIGeos.GEOSEqualsExact_r(Geos.current_handle_pointer, ptr, other.ptr, tolerance))
end

#extract_unique_points ⇒ Object Also known as: unique_points 



284
285
286
 
# File 'lib/ffi-geos/geometry.rb', line 284

def extract_unique_points
  cast_geometry_ptr(FFIGeos.GEOSGeom_extractUniquePoints_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#frechet_distance(geom, densify_frac = nil) ⇒ Object 



753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/ffi-geos/geometry.rb', line 753

def frechet_distance(geom, densify_frac = nil)
  check_geometry(geom)

  double_ptr = FFI::MemoryPointer.new(:double)

  if densify_frac
    FFIGeos.GEOSFrechetDistanceDensify_r(Geos.current_handle_pointer, ptr, geom.ptr, densify_frac, double_ptr)
  else
    FFIGeos.GEOSFrechetDistance_r(Geos.current_handle_pointer, ptr, geom.ptr, double_ptr)
  end

  double_ptr.read_double
end

#geom_type ⇒ Object

Returns the name of the Geometry type, i.e. “Point”, “Polygon”, etc.



46
47
48
 
# File 'lib/ffi-geos/geometry.rb', line 46

def geom_type
  FFIGeos.GEOSGeomType_r(Geos.current_handle_pointer, ptr)
end

#has_z? ⇒ Boolean

Returns:

  • (Boolean) 


438
439
440
 
# File 'lib/ffi-geos/geometry.rb', line 438

def has_z?
  bool_result(FFIGeos.GEOSHasZ_r(Geos.current_handle_pointer, ptr))
end

#hausdorff_distance(geom, densify_frac = nil) ⇒ Object 



516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/ffi-geos/geometry.rb', line 516

def hausdorff_distance(geom, densify_frac = nil)
  check_geometry(geom)

  double_ptr = FFI::MemoryPointer.new(:double)

  if densify_frac
    FFIGeos.GEOSHausdorffDistanceDensify_r(Geos.current_handle_pointer, ptr, geom.ptr, densify_frac, double_ptr)
  else
    FFIGeos.GEOSHausdorffDistance_r(Geos.current_handle_pointer, ptr, geom.ptr, double_ptr)
  end

  double_ptr.read_double
end

#initialize_copy(source) ⇒ Object 



31
32
33
34
35
36
37
38
39
 
# File 'lib/ffi-geos/geometry.rb', line 31

def initialize_copy(source)
  @ptr = FFI::AutoPointer.new(
    FFIGeos.GEOSGeom_clone_r(Geos.current_handle_pointer, source.ptr),
    self.class.method(:release)
  )

  # Copy over SRID since GEOS does not
  self.srid = source.srid
end

#interpolate(d, normalized = false) ⇒ Object 



460
461
462
463
464
465
466
467
468
 
# File 'lib/ffi-geos/geometry.rb', line 460

def interpolate(d, normalized = false)
  ret = if normalized
    FFIGeos.GEOSInterpolateNormalized_r(Geos.current_handle_pointer, ptr, d)
  else
    FFIGeos.GEOSInterpolate_r(Geos.current_handle_pointer, ptr, d)
  end

  cast_geometry_ptr(ret, srid_copy: srid)
end

#interpolate_normalized(d) ⇒ Object 



470
471
472
 
# File 'lib/ffi-geos/geometry.rb', line 470

def interpolate_normalized(d)
  interpolate(d, true)
end

#intersection(geom, precision: nil) ⇒ Object 



86
87
88
89
90
91
92
93
94
 
# File 'lib/ffi-geos/geometry.rb', line 86

def intersection(geom, precision: nil)
  check_geometry(geom)

  if precision
    cast_geometry_ptr(FFIGeos.GEOSIntersectionPrec_r(Geos.current_handle_pointer, ptr, geom.ptr, precision), srid_copy: pick_srid_from_geoms(srid, geom.srid))
  else
    cast_geometry_ptr(FFIGeos.GEOSIntersection_r(Geos.current_handle_pointer, ptr, geom.ptr), srid_copy: pick_srid_from_geoms(srid, geom.srid))
  end
end

#intersects?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


299
300
301
302
 
# File 'lib/ffi-geos/geometry.rb', line 299

def intersects?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSIntersects_r(Geos.current_handle_pointer, ptr, geom.ptr))
end

#largest_empty_circle(precision, boundary: nil) ⇒ Object 



735
736
737
 
# File 'lib/ffi-geos/geometry.rb', line 735

def largest_empty_circle(precision, boundary: nil)
  cast_geometry_ptr(FFIGeos.GEOSLargestEmptyCircle_r(Geos.current_handle_pointer, ptr, boundary ? boundary.ptr : nil, precision))
end

#length ⇒ Object 



490
491
492
493
494
495
496
 
# File 'lib/ffi-geos/geometry.rb', line 490

def length
  return 0 if empty?

  double_ptr = FFI::MemoryPointer.new(:double)
  FFIGeos.GEOSLength_r(Geos.current_handle_pointer, ptr, double_ptr)
  double_ptr.read_double
end

#line_merge ⇒ Object 



272
273
274
 
# File 'lib/ffi-geos/geometry.rb', line 272

def line_merge
  cast_geometry_ptr(FFIGeos.GEOSLineMerge_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#make_valid ⇒ Object

Added in GEOS 3.8+



616
617
618
 
# File 'lib/ffi-geos/geometry.rb', line 616

def make_valid
  cast_geometry_ptr(FFIGeos.GEOSMakeValid_r(Geos.current_handle_pointer, ptr))
end

#maximum_inscribed_circle(precision) ⇒ Object 



729
730
731
 
# File 'lib/ffi-geos/geometry.rb', line 729

def maximum_inscribed_circle(precision)
  cast_geometry_ptr(FFIGeos.GEOSMaximumInscribedCircle_r(Geos.current_handle_pointer, ptr, precision))
end

#minimum_bounding_circle ⇒ Object

Added in GEOS 3.8+. Does not yet support the radius or center arguments.



241
242
243
 
# File 'lib/ffi-geos/geometry.rb', line 241

def minimum_bounding_circle
  cast_geometry_ptr(FFIGeos.GEOSMinimumBoundingCircle_r(Geos.current_handle_pointer, ptr, nil, nil), srid_copy: srid)
end

#minimum_clearance ⇒ Object 



715
716
717
718
719
 
# File 'lib/ffi-geos/geometry.rb', line 715

def minimum_clearance
  double_ptr = FFI::MemoryPointer.new(:double)
  FFIGeos.GEOSMinimumClearance_r(Geos.current_handle_pointer, ptr, double_ptr)
  double_ptr.read_double
end

#minimum_clearance_line ⇒ Object 



723
724
725
 
# File 'lib/ffi-geos/geometry.rb', line 723

def minimum_clearance_line
  cast_geometry_ptr(FFIGeos.GEOSMinimumClearanceLine_r(Geos.current_handle_pointer, ptr))
end

#minimum_rotated_rectangle ⇒ Object 



709
710
711
 
# File 'lib/ffi-geos/geometry.rb', line 709

def minimum_rotated_rectangle
  cast_geometry_ptr(FFIGeos.GEOSMinimumRotatedRectangle_r(Geos.current_handle_pointer, ptr))
end

#minimum_width ⇒ Object 



741
742
743
 
# File 'lib/ffi-geos/geometry.rb', line 741

def minimum_width
  cast_geometry_ptr(FFIGeos.GEOSMinimumWidth_r(Geos.current_handle_pointer, ptr))
end

#nearest_points(geom) ⇒ Object

Available in GEOS 3.4+.



532
533
534
535
536
537
 
# File 'lib/ffi-geos/geometry.rb', line 532

def nearest_points(geom)
  check_geometry(geom)
  nearest_points_ptr = FFIGeos.GEOSNearestPoints_r(Geos.current_handle_pointer, ptr, geom.ptr)

  return CoordinateSequence.new(nearest_points_ptr) unless nearest_points_ptr.null?
end

#node ⇒ Object

Available in GEOS 3.3.4+



215
216
217
 
# File 'lib/ffi-geos/geometry.rb', line 215

def node
  cast_geometry_ptr(FFIGeos.GEOSNode_r(Geos.current_handle_pointer, ptr))
end

#normalize! ⇒ Object Also known as: normalize

Raises:



55
56
57
58
59
 
# File 'lib/ffi-geos/geometry.rb', line 55

def normalize!
  raise Geos::Geometry::CouldntNormalizeError, self.class if FFIGeos.GEOSNormalize_r(Geos.current_handle_pointer, ptr) == -1

  self
end

#num_coordinates ⇒ Object 



78
79
80
 
# File 'lib/ffi-geos/geometry.rb', line 78

def num_coordinates
  FFIGeos.GEOSGetNumCoordinates_r(Geos.current_handle_pointer, ptr)
end

#num_geometries ⇒ Object 



74
75
76
 
# File 'lib/ffi-geos/geometry.rb', line 74

def num_geometries
  FFIGeos.GEOSGetNumGeometries_r(Geos.current_handle_pointer, ptr)
end

#overlaps?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


319
320
321
322
 
# File 'lib/ffi-geos/geometry.rb', line 319

def overlaps?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSOverlaps_r(Geos.current_handle_pointer, ptr, geom.ptr))
end

#point_on_surface ⇒ Object Also known as: representative_point 



220
221
222
 
# File 'lib/ffi-geos/geometry.rb', line 220

def point_on_surface
  cast_geometry_ptr(FFIGeos.GEOSPointOnSurface_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#polygonize(*geoms) ⇒ Object 



578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/ffi-geos/geometry.rb', line 578

def polygonize(*geoms)
  geoms.each do |geom|
    raise ArgumentError unless geom.is_a?(Geos::Geometry)
  end

  ary = [ptr].concat(geoms.collect(&:ptr))
  ary_ptr = FFI::MemoryPointer.new(:pointer, ary.length)
  ary_ptr.write_array_of_pointer(ary)

  cast_geometry_ptr(FFIGeos.GEOSPolygonize_r(Geos.current_handle_pointer, ary_ptr, ary.length), srid_copy: srid).to_a
end

#polygonize_cut_edges ⇒ Object 



600
601
602
603
604
605
 
# File 'lib/ffi-geos/geometry.rb', line 600

def polygonize_cut_edges
  ary = FFI::MemoryPointer.new(:pointer)
  ary.write_array_of_pointer([ptr])

  cast_geometry_ptr(FFIGeos.GEOSPolygonizer_getCutEdges_r(Geos.current_handle_pointer, ary, 1), srid_copy: srid).to_a
end

#polygonize_full ⇒ Object

Returns a Hash with the following structure:

{
  rings: [ ... ],
  cuts: [ ... ],
  dangles: [ ... ],
  invalid_rings: [ ... ]
}



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/ffi-geos/geometry.rb', line 559

def polygonize_full
  cuts = FFI::MemoryPointer.new(:pointer)
  dangles = FFI::MemoryPointer.new(:pointer)
  invalid_rings = FFI::MemoryPointer.new(:pointer)

  rings = cast_geometry_ptr(FFIGeos.GEOSPolygonize_full_r(Geos.current_handle_pointer, ptr, cuts, dangles, invalid_rings), srid_copy: srid)

  cuts = cast_geometry_ptr(cuts.read_pointer, srid_copy: srid)
  dangles = cast_geometry_ptr(dangles.read_pointer, srid_copy: srid)
  invalid_rings = cast_geometry_ptr(invalid_rings.read_pointer, srid_copy: srid)

  {
    rings: rings.to_a,
    cuts: cuts.to_a,
    dangles: dangles.to_a,
    invalid_rings: invalid_rings.to_a
  }
end

#polygonize_valid ⇒ Object

Added in GEOS 3.8+



592
593
594
595
596
597
 
# File 'lib/ffi-geos/geometry.rb', line 592

def polygonize_valid
  ary = FFI::MemoryPointer.new(:pointer)
  ary.write_array_of_pointer([ptr])

  cast_geometry_ptr(FFIGeos.GEOSPolygonize_valid_r(Geos.current_handle_pointer, ary, 1), srid_copy: srid)
end

#precision ⇒ Object 



687
688
689
 
# File 'lib/ffi-geos/geometry.rb', line 687

def precision
  FFIGeos.GEOSGeom_getPrecision_r(Geos.current_handle_pointer, ptr)
end

#project(geom, normalized = false) ⇒ Object

Raises:

  • (TypeError) 


445
446
447
448
449
450
451
452
453
 
# File 'lib/ffi-geos/geometry.rb', line 445

def project(geom, normalized = false)
  raise TypeError, 'Expected Geos::Point type' unless geom.is_a?(Geos::Point)

  if normalized
    FFIGeos.GEOSProjectNormalized_r(Geos.current_handle_pointer, ptr, geom.ptr)
  else
    FFIGeos.GEOSProject_r(Geos.current_handle_pointer, ptr, geom.ptr)
  end
end

#project_normalized(geom) ⇒ Object 



455
456
457
 
# File 'lib/ffi-geos/geometry.rb', line 455

def project_normalized(geom)
  project(geom, true)
end

#relate(geom) ⇒ Object

Returns the Dimensionally Extended Nine-Intersection Model (DE-9IM) matrix of the geometries as a String.



252
253
254
255
 
# File 'lib/ffi-geos/geometry.rb', line 252

def relate(geom)
  check_geometry(geom)
  FFIGeos.GEOSRelate_r(Geos.current_handle_pointer, ptr, geom.ptr)
end

#relate_boundary_node_rule(geom, bnr = :mod2) ⇒ Object

Available in GEOS 3.3+.



265
266
267
268
269
 
# File 'lib/ffi-geos/geometry.rb', line 265

def relate_boundary_node_rule(geom, bnr = :mod2)
  check_geometry(geom)
  check_enum_value(Geos::RelateBoundaryNodeRules, bnr)
  FFIGeos.GEOSRelateBoundaryNodeRule_r(Geos.current_handle_pointer, ptr, geom.ptr, bnr)
end

#relate_pattern(geom, pattern) ⇒ Object

Checks the DE-9IM pattern against the geoms.



258
259
260
261
 
# File 'lib/ffi-geos/geometry.rb', line 258

def relate_pattern(geom, pattern)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSRelatePattern_r(Geos.current_handle_pointer, ptr, geom.ptr, pattern))
end

#reverse ⇒ Object 



747
748
749
 
# File 'lib/ffi-geos/geometry.rb', line 747

def reverse
  cast_geometry_ptr(FFIGeos.GEOSReverse_r(Geos.current_handle_pointer, ptr))
end

#ring? ⇒ Boolean

Returns:

  • (Boolean) 


434
435
436
 
# File 'lib/ffi-geos/geometry.rb', line 434

def ring?
  bool_result(FFIGeos.GEOSisRing_r(Geos.current_handle_pointer, ptr))
end

#shared_paths(geom) ⇒ Object 



546
547
548
549
 
# File 'lib/ffi-geos/geometry.rb', line 546

def shared_paths(geom)
  check_geometry(geom)
  cast_geometry_ptr(FFIGeos.GEOSSharedPaths_r(Geos.current_handle_pointer, ptr, geom.ptr), srid_copy: pick_srid_from_geoms(srid, geom.srid)).to_a
end

#simple? ⇒ Boolean

Returns:

  • (Boolean) 


430
431
432
 
# File 'lib/ffi-geos/geometry.rb', line 430

def simple?
  bool_result(FFIGeos.GEOSisSimple_r(Geos.current_handle_pointer, ptr))
end

#simplify(tolerance) ⇒ Object 



276
277
278
 
# File 'lib/ffi-geos/geometry.rb', line 276

def simplify(tolerance)
  cast_geometry_ptr(FFIGeos.GEOSSimplify_r(Geos.current_handle_pointer, ptr, tolerance), srid_copy: srid)
end

#snap(geom, tolerance) ⇒ Object Also known as: snap_to 



540
541
542
543
 
# File 'lib/ffi-geos/geometry.rb', line 540

def snap(geom, tolerance)
  check_geometry(geom)
  cast_geometry_ptr(FFIGeos.GEOSSnap_r(Geos.current_handle_pointer, ptr, geom.ptr, tolerance), srid_copy: pick_srid_from_geoms(srid, geom.srid))
end

#srid ⇒ Object 



62
63
64
 
# File 'lib/ffi-geos/geometry.rb', line 62

def srid
  FFIGeos.GEOSGetSRID_r(Geos.current_handle_pointer, ptr)
end

#srid=(s) ⇒ Object 



66
67
68
 
# File 'lib/ffi-geos/geometry.rb', line 66

def srid=(s)
  FFIGeos.GEOSSetSRID_r(Geos.current_handle_pointer, ptr, s)
end

#start_point ⇒ Object 



474
475
476
 
# File 'lib/ffi-geos/geometry.rb', line 474

def start_point
  cast_geometry_ptr(FFIGeos.GEOSGeomGetStartPoint_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#sym_difference(geom, precision: nil) ⇒ Object Also known as: symmetric_difference 



157
158
159
160
161
162
163
164
165
 
# File 'lib/ffi-geos/geometry.rb', line 157

def sym_difference(geom, precision: nil)
  check_geometry(geom)

  if precision
    cast_geometry_ptr(FFIGeos.GEOSSymDifferencePrec_r(Geos.current_handle_pointer, ptr, geom.ptr, precision), srid_copy: pick_srid_from_geoms(srid, geom.srid))
  else
    cast_geometry_ptr(FFIGeos.GEOSSymDifference_r(Geos.current_handle_pointer, ptr, geom.ptr), srid_copy: pick_srid_from_geoms(srid, geom.srid))
  end
end

#to_prepared ⇒ Object 



674
675
676
 
# File 'lib/ffi-geos/geometry.rb', line 674

def to_prepared
  Geos::PreparedGeometry.new(self)
end

#to_s ⇒ Object 



678
679
680
681
682
683
684
 
# File 'lib/ffi-geos/geometry.rb', line 678

def to_s
  writer = WktWriter.new
  wkt = writer.write(self)
  wkt = "#{wkt[0...120]} ... " if wkt.length > 120

  "#<Geos::#{geom_type}: #{wkt}>"
end

#topology_preserve_simplify(tolerance) ⇒ Object 



280
281
282
 
# File 'lib/ffi-geos/geometry.rb', line 280

def topology_preserve_simplify(tolerance)
  cast_geometry_ptr(FFIGeos.GEOSTopologyPreserveSimplify_r(Geos.current_handle_pointer, ptr, tolerance), srid_copy: srid)
end

#touches?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


294
295
296
297
 
# File 'lib/ffi-geos/geometry.rb', line 294

def touches?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSTouches_r(Geos.current_handle_pointer, ptr, geom.ptr))
end

#type_id ⇒ Object

Returns one of the values from Geos::GeomTypes.



51
52
53
 
# File 'lib/ffi-geos/geometry.rb', line 51

def type_id
  FFIGeos.GEOSGeomTypeId_r(Geos.current_handle_pointer, ptr)
end

#unary_union(precision = nil) ⇒ Object

Available in GEOS 3.3+



204
205
206
207
208
209
210
 
# File 'lib/ffi-geos/geometry.rb', line 204

def unary_union(precision = nil)
  if precision
    cast_geometry_ptr(FFIGeos.GEOSUnaryUnionPrec_r(Geos.current_handle_pointer, ptr, precision), srid_copy: srid)
  else
    cast_geometry_ptr(FFIGeos.GEOSUnaryUnion_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
  end
end

#union(geom = nil, precision: nil) ⇒ Object

Calling without a geom argument is equivalent to calling unary_union when using GEOS 3.3+ and is equivalent to calling union_cascaded in older versions.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/ffi-geos/geometry.rb', line 175

def union(geom = nil, precision: nil)
  if geom
    check_geometry(geom)

    if precision
      cast_geometry_ptr(FFIGeos.GEOSUnionPrec_r(Geos.current_handle_pointer, ptr, geom.ptr, precision), srid_copy: pick_srid_from_geoms(srid, geom.srid))
    else
      cast_geometry_ptr(FFIGeos.GEOSUnion_r(Geos.current_handle_pointer, ptr, geom.ptr), srid_copy: pick_srid_from_geoms(srid, geom.srid))
    end
  elsif respond_to?(:unary_union)
    unary_union
  else
    union_cascaded
  end
end

#union_cascaded ⇒ Object 



191
192
193
 
# File 'lib/ffi-geos/geometry.rb', line 191

def union_cascaded
  cast_geometry_ptr(FFIGeos.GEOSUnionCascaded_r(Geos.current_handle_pointer, ptr), srid_copy: srid)
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


398
399
400
 
# File 'lib/ffi-geos/geometry.rb', line 398

def valid?
  bool_result(FFIGeos.GEOSisValid_r(Geos.current_handle_pointer, ptr))
end

#valid_detail(flags = 0) ⇒ Object

Returns a Hash containing the following structure on invalid geometries:

{
  detail: "String explaining the problem",
  location: Geos::Point # centered on the problem
}

If the Geometry is valid, returns nil.



415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/ffi-geos/geometry.rb', line 415

def valid_detail(flags = 0)
  detail = FFI::MemoryPointer.new(:pointer)
  location = FFI::MemoryPointer.new(:pointer)
  valid = bool_result(
    FFIGeos.GEOSisValidDetail_r(Geos.current_handle_pointer, ptr, flags, detail, location)
  )

  return if valid

  {
    detail: detail.read_pointer.read_string,
    location: cast_geometry_ptr(location.read_pointer, srid_copy: srid)
  }
end

#valid_reason ⇒ Object

Returns a String describing whether or not the Geometry is valid.



403
404
405
 
# File 'lib/ffi-geos/geometry.rb', line 403

def valid_reason
  FFIGeos.GEOSisValidReason_r(Geos.current_handle_pointer, ptr)
end

#voronoi_diagram(*args) ⇒ Object

Available in GEOS 3.5.0+

:call-seq:

 voronoi_diagram(options = {})
 voronoi_diagram(tolerance, options = {})

Options:

* :tolerance
* :envelope
* :only_edges



658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/ffi-geos/geometry.rb', line 658

def voronoi_diagram(*args)
  options = extract_options!(args)

  tolerance = args.first || options[:tolerance] || 0.0

  envelope_ptr = if options[:envelope]
    check_geometry(options[:envelope])
    options[:envelope].ptr
  end

  only_edges = bool_to_int(options[:only_edges])

  cast_geometry_ptr(FFIGeos.GEOSVoronoiDiagram_r(Geos.current_handle_pointer, ptr, envelope_ptr, tolerance, only_edges))
end

#with_precision(grid_size, options = {}) ⇒ Object 



693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/ffi-geos/geometry.rb', line 693

def with_precision(grid_size, options = {})
  options = {
    no_topology: false,
    keep_collapsed: false
  }.merge(options)

  flags = options.reduce(0) do |memo, (key, value)|
    memo |= Geos::PrecisionOptions[key] if value
    memo
  end

  cast_geometry_ptr(FFIGeos.GEOSGeom_setPrecision_r(Geos.current_handle_pointer, ptr, grid_size, flags))
end

#within?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


309
310
311
312
 
# File 'lib/ffi-geos/geometry.rb', line 309

def within?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSWithin_r(Geos.current_handle_pointer, ptr, geom.ptr))
end