class

Opal::UI::CharacterGrid

Inherits Opal::UI::Control < Opal::UI::InputHookable < Opal::UI::Element < Opal::UI::Themable < Reference < Object

Interactive, highly configurable 2D character grid control. Renders regular horizontal and vertical grid lines with customizable intervals, glyph styles (solid, heavy, double, dashed, dotted, crosses, etc.), major/minor lines, panning offsets, interval scaling (zoom), mouse dragging, and coordinate rulers.

Constructors

new(interval_x : Int32 = 8, interval_y : Int32 = 4, offset_x : Int32 = 0, offset_y : Int32 = 0, style : Symbol | Graphics::GridStylePreset | Graphics::GridGlyphs = :solid, fg : Color = Color.hex("#6272A4"), bg : Color = Color.none, intersection_fg : Color | Nil = Color.hex("#8BE9FD"), major_interval_x : Int32 | Nil = nil, major_interval_y : Int32 | Nil = nil, major_fg : Color | Nil = Color.hex("#BD93F9"), show_horizontal : Bool = true, show_vertical : Bool = true, show_coordinates : Bool = false, show_border : Bool = true, border_color : Color = Color.hex("#6272A4"), border_style : Symbol = :rounded, title : String | Nil = "Character Grid", width : Int32 | Nil = 30, height : Int32 | Nil = 12)

Instance methods

adjust_interval(d_x : Int32, d_y : Int32) : Nil

Adjusts grid intervals (zoom)

bg

bg=(bg : Color)

border_color

border_color=(border_color : Color)

border_style

border_style=(border_style : Symbol)

current_style

current_style=(current_style : Graphics::GridStylePreset)

cycle_colors

Cycles between built-in color palettes

cycle_style

Cycles through all 10 available presets

fg

fg=(fg : Color)

glyphs

glyphs=(glyphs : Graphics::GridGlyphs)

handle_key(key : Terminal::KeyEvent) : Bool

Default key event handler. Override in subclasses if not using @default_input_proc.

handle_mouse(event : Terminal::MouseEvent) : Bool

Default mouse event handler. Override in subclasses if not using @default_input_proc.

height

height=(height : Int32)

initial_interval_x

initial_interval_x=(initial_interval_x : Int32)

initial_interval_y

initial_interval_y=(initial_interval_y : Int32)

intersection_fg

intersection_fg=(intersection_fg : Color | Nil)

interval_x

interval_x=(interval_x : Int32)

interval_y

interval_y=(interval_y : Int32)

last_h

last_h=(last_h : Int32)

last_w

last_w=(last_w : Int32)

last_x

last_x=(last_x : Int32)

last_y

last_y=(last_y : Int32)

major_fg

major_fg=(major_fg : Color | Nil)

major_interval_x

major_interval_x=(major_interval_x : Int32 | Nil)

major_interval_y

major_interval_y=(major_interval_y : Int32 | Nil)

offset_x

offset_x=(offset_x : Int32)

offset_y

offset_y=(offset_y : Int32)

on_interval_change

on_interval_change=(on_interval_change : Proc(Int32, Int32, Nil) | Nil)

on_pan

Callbacks

on_pan=(on_pan : Proc(Int32, Int32, Nil) | Nil)

Callbacks

on_style_change

on_style_change=(on_style_change : Proc(Graphics::GridStylePreset, Nil) | Nil)

pan(dx : Int32, dy : Int32) : Nil

Pans the grid view by (dx, dy)

preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)

render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil

render(buffer : Buffer) : Nil

reset

Resets pan offsets and intervals to initial creation values

set_style(preset : Graphics::GridStylePreset | Symbol | String) : Nil

Changes the active grid style preset

show_border=(show_border : Bool)

show_border?

show_coordinates=(show_coordinates : Bool)

show_coordinates?

show_horizontal=(show_horizontal : Bool)

show_horizontal?

show_vertical=(show_vertical : Bool)

show_vertical?

title

title=(title : String | Nil)

width

width=(width : Int32)