class RatatuiRuby::Rect

Defines a rectangular area in the terminal grid.

Geometry management involves passing groups of four integers (‘x, y, width, height`) repeatedly. This is verbose and prone to parameter mismatch errors.

This class encapsulates the geometry. It provides a standard primitive for passing area definitions between layout engines and rendering functions.

Use it when manual positioning is required or when querying layout results.

Examples

area = Rect.new(x: 0, y: 0, width: 80, height: 24)
puts area.width # => 80

Attributes

height [R]

Height in characters (Integer, coerced via to_int or to_i).

width [R]

Width in characters (Integer, coerced via to_int or to_i).

x [R]

X coordinate (column) of the top-left corner (Integer, coerced via to_int or to_i).

y [R]

Y coordinate (row) of the top-left corner (Integer, coerced via to_int or to_i).

Public Class Methods

new (x: 0, y: 0, width: 0, height: 0)

Source

# File lib/ratatui_ruby/schema/rect.rb, line 48
def initialize(x: 0, y: 0, width: 0, height: 0)
  super(
    x: Integer(x),
    y: Integer(y),
    width: Integer(width),
    height: Integer(height)
  )
end

Creates a new Rect.

All parameters accept any object responding to to_int or to_i (duck-typed).

x: Column index (Numeric).
y: Row index (Numeric).
width: Width in columns (Numeric).
height: Height in rows (Numeric).

Calls superclass method

Public Instance Methods

contains? (px, py)

Source

# File lib/ratatui_ruby/schema/rect.rb, line 71
def contains?(px, py)
  px >= x && px < x + width && py >= y && py < y + height
end

Tests whether a point is inside this rectangle.

Essential for hit testing mouse clicks against layout regions.

area = Rect.new(x: 10, y: 5, width: 20, height: 10)
area.contains?(15, 8) # => true
area.contains?(5, 8)  # => false

px: X coordinate to test (column).
py: Y coordinate to test (row).

Returns true if the point (px, py) is within the rectangle bounds.

intersection (other)

Source

# File lib/ratatui_ruby/schema/rect.rb, line 107
def intersection(other)
  return nil unless intersects?(other)

  new_x = [x, other.x].max
  new_y = [y, other.y].max
  new_right = [x + width, other.x + other.width].min
  new_bottom = [y + height, other.y + other.height].min

  Rect.new(x: new_x, y: new_y, width: new_right - new_x, height: new_bottom - new_y)
end

Returns the overlapping area between this rectangle and another.

Essential for calculating visible portions of widgets inside scroll views.

viewport = Rect.new(x: 0, y: 0, width: 80, height: 24)
widget = Rect.new(x: 70, y: 20, width: 20, height: 10)
visible = viewport.intersection(widget)
# => Rect(x: 70, y: 20, width: 10, height: 4)

other: Another Rect to intersect with.

Returns a new Rect representing the intersection, or nil if no overlap.

intersects? (other)

Source

# File lib/ratatui_ruby/schema/rect.rb, line 87
def intersects?(other)
  x < other.x + other.width &&
    x + width > other.x &&
    y < other.y + other.height &&
    y + height > other.y
end

Tests whether this rectangle overlaps with another.

Essential for determining if a widget is visible within a viewport or clipping area.

viewport = Rect.new(x: 0, y: 0, width: 80, height: 24)
widget = Rect.new(x: 70, y: 20, width: 20, height: 10)
viewport.intersects?(widget) # => true (partial overlap)

other: Another Rect to test against.

Returns true if the rectangles overlap.