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.



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

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.



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

def ptr
  @ptr
end

Class Method Details

.release(ptr) ⇒ Object

:nodoc:



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

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

Instance Method Details

#==(geom) ⇒ Object 



352
353
354
355
356
357
358
 
# File 'lib/ffi-geos/geometry.rb', line 352

def ==(geom)
  if geom.is_a?(Geos::Geometry)
    self.eql?(geom)
  else
    false
  end
end

#area ⇒ Object 



464
465
466
467
468
469
470
471
472
 
# File 'lib/ffi-geos/geometry.rb', line 464

def area
  if self.empty?
    0
  else
    double_ptr = FFI::MemoryPointer.new(:double)
    FFIGeos.GEOSArea_r(Geos.current_handle_pointer, self.ptr, double_ptr)
    double_ptr.read_double
  end
end

#boundary ⇒ Object 



162
163
164
 
# File 'lib/ffi-geos/geometry.rb', line 162

def boundary
  cast_geometry_ptr(FFIGeos.GEOSBoundary_r(Geos.current_handle_pointer, self.ptr), :srid_copy => self.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.new("Expected Geos::BufferParams, a Hash or a Numeric")
  end

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

#centroid ⇒ Object Also known as: center 



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

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

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

Available in GEOS 3.5.0+.



213
214
215
 
# File 'lib/ffi-geos/geometry.rb', line 213

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

#contains?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


292
293
294
295
 
# File 'lib/ffi-geos/geometry.rb', line 292

def contains?(geom)
  check_geometry(geom)
  bool_result(FFIGeos.GEOSContains_r(Geos.current_handle_pointer, self.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, self.ptr), :srid_copy => self.srid)
end

#coord_seq ⇒ Object 



85
86
87
 
# File 'lib/ffi-geos/geometry.rb', line 85

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

#covered_by?(geom) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

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

#covers?(geom) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


306
307
308
309
 
# File 'lib/ffi-geos/geometry.rb', line 306

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

#crosses?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#delaunay_triangulation(*args) ⇒ Object

:call-seq:

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

Options:

* :tolerance
* :only_edges



586
587
588
589
590
591
592
593
 
# File 'lib/ffi-geos/geometry.rb', line 586

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, self.ptr, tolerance, only_edges))
end

#difference(geom) ⇒ Object 



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

def difference(geom)
  check_geometry(geom)
  cast_geometry_ptr(FFIGeos.GEOSDifference_r(Geos.current_handle_pointer, self.ptr, geom.ptr), {
    :srid_copy => pick_srid_from_geoms(self.srid, geom.srid)
  })
end

#dimensions ⇒ Object 



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

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

#disjoint?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#distance(geom) ⇒ Object 



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

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

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#end_point ⇒ Object 



460
461
462
 
# File 'lib/ffi-geos/geometry.rb', line 460

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

#envelope ⇒ Object 



224
225
226
 
# File 'lib/ffi-geos/geometry.rb', line 224

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

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

Returns:

  • (Boolean) 


346
347
348
349
 
# File 'lib/ffi-geos/geometry.rb', line 346

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

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

Returns:

  • (Boolean) 


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

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

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

Returns:

  • (Boolean) 


360
361
362
363
 
# File 'lib/ffi-geos/geometry.rb', line 360

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

#extract_unique_points ⇒ Object Also known as: unique_points 



262
263
264
 
# File 'lib/ffi-geos/geometry.rb', line 262

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

#geom_type ⇒ Object

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



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

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

#has_z? ⇒ Boolean

Returns:

  • (Boolean) 


420
421
422
 
# File 'lib/ffi-geos/geometry.rb', line 420

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

#hausdorff_distance(geom, densify_frac = nil) ⇒ Object 



491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/ffi-geos/geometry.rb', line 491

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, self.ptr, geom.ptr, densify_frac, double_ptr)
  else
    FFIGeos.GEOSHausdorffDistance_r(Geos.current_handle_pointer, self.ptr, geom.ptr, double_ptr)
  end

  double_ptr.read_double
end

#initialize_copy(source) ⇒ Object 



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

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 



442
443
444
445
446
447
448
449
450
 
# File 'lib/ffi-geos/geometry.rb', line 442

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

  cast_geometry_ptr(ret, :srid_copy => self.srid)
end

#interpolate_normalized(d) ⇒ Object 



452
453
454
 
# File 'lib/ffi-geos/geometry.rb', line 452

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

#intersection(geom) ⇒ Object 



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

def intersection(geom)
  check_geometry(geom)
  cast_geometry_ptr(FFIGeos.GEOSIntersection_r(Geos.current_handle_pointer, self.ptr, geom.ptr), {
    :srid_copy => pick_srid_from_geoms(self.srid, geom.srid)
  })
end

#intersects?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#length ⇒ Object 



474
475
476
477
478
479
480
481
482
 
# File 'lib/ffi-geos/geometry.rb', line 474

def length
  if self.empty?
    0
  else
    double_ptr = FFI::MemoryPointer.new(:double)
    FFIGeos.GEOSLength_r(Geos.current_handle_pointer, self.ptr, double_ptr)
    double_ptr.read_double
  end
end

#line_merge ⇒ Object 



250
251
252
 
# File 'lib/ffi-geos/geometry.rb', line 250

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

#minimum_clearance ⇒ Object 



667
668
669
670
671
 
# File 'lib/ffi-geos/geometry.rb', line 667

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

#minimum_clearance_line ⇒ Object 



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

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

#minimum_rotated_rectangle ⇒ Object 



661
662
663
 
# File 'lib/ffi-geos/geometry.rb', line 661

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

#minimum_width ⇒ Object 



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

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

#nearest_points(geom) ⇒ Object

Available in GEOS 3.4+.



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

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

  if !ptr.null?
    CoordinateSequence.new(ptr)
  end
end

#node ⇒ Object

Available in GEOS 3.3.4+



201
202
203
 
# File 'lib/ffi-geos/geometry.rb', line 201

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

#normalize! ⇒ Object Also known as: normalize 



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

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

  self
end

#num_coordinates ⇒ Object 



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

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

#num_geometries ⇒ Object 



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

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

#overlaps?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


297
298
299
300
 
# File 'lib/ffi-geos/geometry.rb', line 297

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

#point_on_surface ⇒ Object Also known as: representative_point 



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

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

#polygonize ⇒ Object 



563
564
565
566
567
568
 
# File 'lib/ffi-geos/geometry.rb', line 563

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

  cast_geometry_ptr(FFIGeos.GEOSPolygonize_r(Geos.current_handle_pointer, ary, 1), :srid_copy => self.srid).to_a
end

#polygonize_cut_edges ⇒ Object 



570
571
572
573
574
575
 
# File 'lib/ffi-geos/geometry.rb', line 570

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

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

#polygonize_full ⇒ Object

Returns a Hash with the following structure:

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



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/ffi-geos/geometry.rb', line 540

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, self.ptr, cuts, dangles, invalid_rings), {
      :srid_copy => self.srid
    }
  )

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

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

#precision ⇒ Object 



639
640
641
 
# File 'lib/ffi-geos/geometry.rb', line 639

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

#project(geom, normalized = false) ⇒ Object

Raises:

  • (TypeError) 


427
428
429
430
431
432
433
434
435
 
# File 'lib/ffi-geos/geometry.rb', line 427

def project(geom, normalized = false)
  raise TypeError.new("Expected Geos::Point type") if !geom.is_a?(Geos::Point)

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

#project_normalized(geom) ⇒ Object 



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

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

#relate(geom) ⇒ Object

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



230
231
232
233
 
# File 'lib/ffi-geos/geometry.rb', line 230

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

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

Available in GEOS 3.3+.



243
244
245
246
247
 
# File 'lib/ffi-geos/geometry.rb', line 243

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

#relate_pattern(geom, pattern) ⇒ Object

Checks the DE-9IM pattern against the geoms.



236
237
238
239
 
# File 'lib/ffi-geos/geometry.rb', line 236

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

#ring? ⇒ Boolean

Returns:

  • (Boolean) 


416
417
418
 
# File 'lib/ffi-geos/geometry.rb', line 416

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

#shared_paths(geom) ⇒ Object 



525
526
527
528
529
530
 
# File 'lib/ffi-geos/geometry.rb', line 525

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

#simple? ⇒ Boolean

Returns:

  • (Boolean) 


412
413
414
 
# File 'lib/ffi-geos/geometry.rb', line 412

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

#simplify(tolerance) ⇒ Object 



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

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

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



517
518
519
520
521
522
 
# File 'lib/ffi-geos/geometry.rb', line 517

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

#srid ⇒ Object 



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

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

#srid=(s) ⇒ Object 



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

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

#start_point ⇒ Object 



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

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

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



154
155
156
157
158
159
 
# File 'lib/ffi-geos/geometry.rb', line 154

def sym_difference(geom)
  check_geometry(geom)
  cast_geometry_ptr(FFIGeos.GEOSSymDifference_r(Geos.current_handle_pointer, self.ptr, geom.ptr), {
    :srid_copy => pick_srid_from_geoms(self.srid, geom.srid)
  })
end

#to_prepared ⇒ Object 



624
625
626
 
# File 'lib/ffi-geos/geometry.rb', line 624

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

#to_s ⇒ Object 



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

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

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

#topology_preserve_simplify(tolerance) ⇒ Object 



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

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

#touches?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#type_id ⇒ Object

Returns one of the values from Geos::GeomTypes.



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

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

#unary_union ⇒ Object

Available in GEOS 3.3+



192
193
194
195
196
 
# File 'lib/ffi-geos/geometry.rb', line 192

def unary_union
  cast_geometry_ptr(FFIGeos.GEOSUnaryUnion_r(Geos.current_handle_pointer, self.ptr), {
    :srid_copy => self.srid
  })
end

#union(geom = 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.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/ffi-geos/geometry.rb', line 169

def union(geom = nil)
  if geom
    check_geometry(geom)
    cast_geometry_ptr(FFIGeos.GEOSUnion_r(Geos.current_handle_pointer, self.ptr, geom.ptr), {
      :srid_copy => pick_srid_from_geoms(self.srid, geom.srid)
    })
  else
    if self.respond_to?(:unary_union)
      self.unary_union
    else
      self.union_cascaded
    end
  end
end

#union_cascaded ⇒ Object 



184
185
186
187
188
 
# File 'lib/ffi-geos/geometry.rb', line 184

def union_cascaded
  cast_geometry_ptr(FFIGeos.GEOSUnionCascaded_r(Geos.current_handle_pointer, self.ptr), {
    :srid_copy => self.srid
  })
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


378
379
380
 
# File 'lib/ffi-geos/geometry.rb', line 378

def valid?
  bool_result(FFIGeos.GEOSisValid_r(Geos.current_handle_pointer, self.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.



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/ffi-geos/geometry.rb', line 395

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, self.ptr, flags, detail, location)
  )

  if !valid
    {
      :detail => detail.read_pointer.read_string,
      :location => cast_geometry_ptr(location.read_pointer, {
        :srid_copy => self.srid
      })
    }
  end
end

#valid_reason ⇒ Object

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



383
384
385
 
# File 'lib/ffi-geos/geometry.rb', line 383

def valid_reason
  FFIGeos.GEOSisValidReason_r(Geos.current_handle_pointer, self.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



608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/ffi-geos/geometry.rb', line 608

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, self.ptr, envelope_ptr, tolerance, only_edges))
end

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



645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/ffi-geos/geometry.rb', line 645

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, self.ptr, grid_size, flags))
end

#within?(geom) ⇒ Boolean

Returns:

  • (Boolean) 


287
288
289
290
 
# File 'lib/ffi-geos/geometry.rb', line 287

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