class PerfectShape::Point

Point class includes point-specific operations like ‘#==`, `point_distance` and a fuzzy `contain?` matcher

Public Class Methods

new(x_or_point = nil, y_arg = nil, x: nil, y: nil) click to toggle source
Calls superclass method PerfectShape::PointLocation::new
# File lib/perfect_shape/point.rb, line 56
def initialize(x_or_point = nil, y_arg = nil, x: nil, y: nil)
  if x_or_point.is_a?(Array)
    x, y = x_or_point
    super(x: x, y: y)
  elsif x_or_point && y_arg
    super(x: x_or_point, y: y_arg)
  else
    x ||= 0
    y ||= 0
    super(x: x, y: y)
  end
end
normalize_point(x_or_point, y = nil) click to toggle source

Normalizes point args whether two-number Array or x, y args returning normalized point array of two BigDecimal’s

@param x_or_point The point or X coordinate of the point to test. @param y The Y coordinate of the point to test.

@return Array of x and y BigDecimal’s representing point

# File lib/perfect_shape/point.rb, line 44
def normalize_point(x_or_point, y = nil)
  x = x_or_point
  x, y = x if y.nil? && x_or_point.is_a?(Array) && x_or_point.size == 2
  x = x.is_a?(BigDecimal) ? x : BigDecimal(x.to_s)
  y = y.is_a?(BigDecimal) ? y : BigDecimal(y.to_s)
  [x, y]
end
point_distance(x, y, px, py) click to toggle source
# File lib/perfect_shape/point.rb, line 29
def point_distance(x, y, px, py)
  x = x.is_a?(BigDecimal) ? x : BigDecimal(x.to_s)
  y = y.is_a?(BigDecimal) ? y : BigDecimal(y.to_s)
  px = px.is_a?(BigDecimal) ? px : BigDecimal(px.to_s)
  py = py.is_a?(BigDecimal) ? py : BigDecimal(py.to_s)
  BigDecimal(Math.sqrt((px - x)**2 + (py - y)**2).to_s)
end

Public Instance Methods

contain?(x_or_point, y = nil, outline: true, distance_tolerance: 0) click to toggle source

Checks if points match, with distance tolerance (0 by default)

@param x The X coordinate of the point to test. @param y The Y coordinate of the point to test. @param distance_tolerance The distance from point to tolerate (0 by default)

@return true if the point is close enough within distance tolerance, false if the point is too far.

# File lib/perfect_shape/point.rb, line 85
def contain?(x_or_point, y = nil, outline: true, distance_tolerance: 0)
  x, y = Point.normalize_point(x_or_point, y)
  return unless x && y
  distance_tolerance = BigDecimal(distance_tolerance.to_s)
  point_distance(x, y) <= distance_tolerance
end
intersect?(rectangle) click to toggle source
# File lib/perfect_shape/point.rb, line 99
def intersect?(rectangle)
  rectangle.contain?(self.to_a)
end
max_x() click to toggle source
# File lib/perfect_shape/point.rb, line 69
def max_x
  x
end
max_y() click to toggle source
# File lib/perfect_shape/point.rb, line 73
def max_y
  y
end
point_distance(x_or_point, y = nil) click to toggle source
# File lib/perfect_shape/point.rb, line 92
def point_distance(x_or_point, y = nil)
  x, y = Point.normalize_point(x_or_point, y)
  return unless x && y
  
  Point.point_distance(self.x, self.y, x, y)
end
to_a() click to toggle source

Convert to pair Array of x,y coordinates

# File lib/perfect_shape/point.rb, line 104
def to_a
  [self.x, self.y]
end