class SFML::Rect

An axis-aligned rectangle. Mirrors sfFloatRect / sfIntRect — those structs are just (position: Vector2, size: Vector2). We deliberately keep one Ruby class for both the float and int variants since pattern-matching case bounds in {position: {x:, y:}, size: {x: w, y: h}} is what users reach for either way.

r = SFML::Rect.new([10, 20], [100, 50]) r.contains?([50, 30]) #=> true r.right #=> 110

Used by Text#local_bounds, Text#global_bounds, Sprite#texture_rect, etc.

Attributes

position [R]

The position, size components.

size [R]

The position, size components.

Public Class Methods

new (position, size)

Source

# File lib/sfml/system/rect.rb, line 18
def initialize(position, size)
  @position = position.is_a?(Vector2) ? position : Vector2.new(*position)
  @size     = size.is_a?(Vector2) ? size : Vector2.new(*size)
  freeze
end

position and size may each be a Vector2 OR a [x, y] Array.

Public Instance Methods

== (other)

Source

# File lib/sfml/system/rect.rb, line 57
def ==(other)
  other.is_a?(Rect) && @position == other.position && @size == other.size
end

Value equality — same position + same size.

bottom (= @position.y + @size.y)

Source

# File lib/sfml/system/rect.rb, line 38
def bottom = @position.y + @size.y

# `true` if `point` (Vector2 or `[x, y]`) is inside this rect.
# The right and bottom edges are exclusive.
def contains?(point)
  px, py = point.is_a?(Vector2) ? [point.x, point.y] : [point[0], point[1]]
  px >= left && px < right && py >= top && py < bottom
end

# `true` if this rect overlaps `other` at all (any non-empty
# intersection counts).
def intersects?(other)
  left   < other.right  &&
    right  > other.left  &&
    top    < other.bottom &&
    bottom > other.top
end

# Value equality — same position + same size.
def ==(other)
  other.is_a?(Rect) && @position == other.position && @size == other.size
end
alias eql? ==
# Hash key support.
def hash = [@position, @size].hash

# `[x, y, width, height]`.
def to_a = [x, y, width, height]

# `{position:, size:}`.
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x], struct[:size][:y]),

contains? (point)

Source

# File lib/sfml/system/rect.rb, line 42
def contains?(point)
  px, py = point.is_a?(Vector2) ? [point.x, point.y] : [point[0], point[1]]
  px >= left && px < right && py >= top && py < bottom
end

true if point (Vector2 or [x, y]) is inside this rect. The right and bottom edges are exclusive.

deconstruct (= [x, y, width, height])

Source

# File lib/sfml/system/rect.rb, line 71
  def deconstruct = [x, y, width, height]

  # Pattern-match support for `in {position:, size:}`.
  def deconstruct_keys(_keys) = { position: @position, size: @size }

  # String representation for debugging.
  def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
  alias inspect to_s

  # Returns the self.
  def self.from_native(struct) # :nodoc:
    new(
      Vector2.new(struct[:position][:x], struct[:position][:y]),
      Vector2.new(struct[:size][:x], struct[:size][:y]),
    )
  end
end

Pattern-match support for in [x, y, w, h].

deconstruct_keys (_keys)

Source

# File lib/sfml/system/rect.rb, line 74
    def deconstruct_keys(_keys) = { position: @position, size: @size }

    # String representation for debugging.
    def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
    alias inspect to_s

    # Returns the self.
    def self.from_native(struct) # :nodoc:
      new(
        Vector2.new(struct[:position][:x], struct[:position][:y]),
        Vector2.new(struct[:size][:x], struct[:size][:y]),
      )
    end
  end
end

Pattern-match support for in {position:, size:}.

hash (= [@position, @size].hash)

Source

# File lib/sfml/system/rect.rb, line 62
def hash = [@position, @size].hash

# `[x, y, width, height]`.
def to_a = [x, y, width, height]

# `{position:, size:}`.
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x], struct[:size][:y]),
  )

Hash key support.

height (= @size.y)

Source

# File lib/sfml/system/rect.rb, line 31
def height = @size.y
alias left x
alias top  y

# X of the right edge (`x + width`).
def right  = @position.x + @size.x
# Y of the bottom edge (`y + height`).
def bottom = @position.y + @size.y

# `true` if `point` (Vector2 or `[x, y]`) is inside this rect.
# The right and bottom edges are exclusive.
def contains?(point)
  px, py = point.is_a?(Vector2) ? [point.x, point.y] : [point[0], point[1]]
  px >= left && px < right && py >= top && py < bottom
end

# `true` if this rect overlaps `other` at all (any non-empty
# intersection counts).
def intersects?(other)
  left   < other.right  &&
    right  > other.left  &&
    top    < other.bottom &&
    bottom > other.top
end

# Value equality — same position + same size.
def ==(other)
  other.is_a?(Rect) && @position == other.position && @size == other.size
end
alias eql? ==
# Hash key support.
def hash = [@position, @size].hash

# `[x, y, width, height]`.
def to_a = [x, y, width, height]

# `{position:, size:}`.
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x], struct[:size][:y

intersects? (other)

Source

# File lib/sfml/system/rect.rb, line 49
def intersects?(other)
  left   < other.right  &&
    right  > other.left  &&
    top    < other.bottom &&
    bottom > other.top
end

true if this rect overlaps other at all (any non-empty intersection counts).

right (= @position.x + @size.x)

Source

# File lib/sfml/system/rect.rb, line 36
def right  = @position.x + @size.x
# Y of the bottom edge (`y + height`).
def bottom = @position.y + @size.y

# `true` if `point` (Vector2 or `[x, y]`) is inside this rect.
# The right and bottom edges are exclusive.
def contains?(point)
  px, py = point.is_a?(Vector2) ? [point.x, point.y] : [point[0], point[1]]
  px >= left && px < right && py >= top && py < bottom
end

# `true` if this rect overlaps `other` at all (any non-empty
# intersection counts).
def intersects?(other)
  left   < other.right  &&
    right  > other.left  &&
    top    < other.bottom &&
    bottom > other.top
end

# Value equality — same position + same size.
def ==(other)
  other.is_a?(Rect) && @position == other.position && @size == other.size
end
alias eql? ==
# Hash key support.
def hash = [@position, @size].hash

# `[x, y, width, height]`.
def to_a = [x, y, width, height]

# `{position:, size:}`.
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x], struct[:size][:y])

X of the right edge (x + width).

to_a (= [x, y, width, height])

Source

# File lib/sfml/system/rect.rb, line 65
def to_a = [x, y, width, height]

# `{position:, size:}`.
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x], struct[:size][:y]),
  )

[x, y, width, height].

to_h (= { position: @position, size: @size })

Source

# File lib/sfml/system/rect.rb, line 68
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x], struct[:size][:y]),
  )
end

{position:, size:}.

to_s (= "Rect(x=

Source

# File lib/sfml/system/rect.rb, line 77
  def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
  alias inspect to_s

  # Returns the self.
  def self.from_native(struct) # :nodoc:
    new(
      Vector2.new(struct[:position][:x], struct[:position][:y]),
      Vector2.new(struct[:size][:x], struct[:size][:y]),
    )
  end
end

String representation for debugging.

width (= @size.x)

Source

# File lib/sfml/system/rect.rb, line 29
def width  = @size.x
# Height.
def height = @size.y
alias left x
alias top  y

# X of the right edge (`x + width`).
def right  = @position.x + @size.x
# Y of the bottom edge (`y + height`).
def bottom = @position.y + @size.y

# `true` if `point` (Vector2 or `[x, y]`) is inside this rect.
# The right and bottom edges are exclusive.
def contains?(point)
  px, py = point.is_a?(Vector2) ? [point.x, point.y] : [point[0], point[1]]
  px >= left && px < right && py >= top && py < bottom
end

# `true` if this rect overlaps `other` at all (any non-empty
# intersection counts).
def intersects?(other)
  left   < other.right  &&
    right  > other.left  &&
    top    < other.bottom &&
    bottom > other.top
end

# Value equality — same position + same size.
def ==(other)
  other.is_a?(Rect) && @position == other.position && @size == other.size
end
alias eql? ==
# Hash key support.
def hash = [@position, @size].hash

# `[x, y, width, height]`.
def to_a = [x, y, width, height]

# `{position:, size:}`.
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x], struct[:size]

x (= @position.x)

Source

# File lib/sfml/system/rect.rb, line 25
def x      = @position.x
# Top-left Y.
def y      = @position.y
# Width.
def width  = @size.x
# Height.
def height = @size.y
alias left x
alias top  y

# X of the right edge (`x + width`).
def right  = @position.x + @size.x
# Y of the bottom edge (`y + height`).
def bottom = @position.y + @size.y

# `true` if `point` (Vector2 or `[x, y]`) is inside this rect.
# The right and bottom edges are exclusive.
def contains?(point)
  px, py = point.is_a?(Vector2) ? [point.x, point.y] : [point[0], point[1]]
  px >= left && px < right && py >= top && py < bottom
end

# `true` if this rect overlaps `other` at all (any non-empty
# intersection counts).
def intersects?(other)
  left   < other.right  &&
    right  > other.left  &&
    top    < other.bottom &&
    bottom > other.top
end

# Value equality — same position + same size.
def ==(other)
  other.is_a?(Rect) && @position == other.position && @size == other.size
end
alias eql? ==
# Hash key support.
def hash = [@position, @size].hash

# `[x, y, width, height]`.
def to_a = [x, y, width, height]

# `{position:, size:}`.
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x],

Top-left X.

y (= @position.y)

Source

# File lib/sfml/system/rect.rb, line 27
def y      = @position.y
# Width.
def width  = @size.x
# Height.
def height = @size.y
alias left x
alias top  y

# X of the right edge (`x + width`).
def right  = @position.x + @size.x
# Y of the bottom edge (`y + height`).
def bottom = @position.y + @size.y

# `true` if `point` (Vector2 or `[x, y]`) is inside this rect.
# The right and bottom edges are exclusive.
def contains?(point)
  px, py = point.is_a?(Vector2) ? [point.x, point.y] : [point[0], point[1]]
  px >= left && px < right && py >= top && py < bottom
end

# `true` if this rect overlaps `other` at all (any non-empty
# intersection counts).
def intersects?(other)
  left   < other.right  &&
    right  > other.left  &&
    top    < other.bottom &&
    bottom > other.top
end

# Value equality — same position + same size.
def ==(other)
  other.is_a?(Rect) && @position == other.position && @size == other.size
end
alias eql? ==
# Hash key support.
def hash = [@position, @size].hash

# `[x, y, width, height]`.
def to_a = [x, y, width, height]

# `{position:, size:}`.
def to_h = { position: @position, size: @size }

# Pattern-match support for `in [x, y, w, h]`.
def deconstruct = [x, y, width, height]

# Pattern-match support for `in {position:, size:}`.
def deconstruct_keys(_keys) = { position: @position, size: @size }

# String representation for debugging.
def to_s = "Rect(x=#{x}, y=#{y}, w=#{width}, h=#{height})"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(
    Vector2.new(struct[:position][:x], struct[:position][:y]),
    Vector2.new(struct[:size][:x], struct[