class
Opal::UI::TargetSelector2D
- Opal::UI::TargetSelector2D
- Opal::UI::Control
- Opal::UI::Element
- Reference
- Object
Overview
Interactive 2D continuous target/coordinate selector. Supports custom X/Y continuous domains, procedural background shader blocks, static buffer backgrounds, custom reticle glyphs, mouse dragging, and arrow-key stepping.
Defined in:
opal/ui/components/target_selector_2d.crConstructors
- .new(x_range : Range(Float64, Float64) = 0.0..1.0, y_range : Range(Float64, Float64) = 0.0..1.0, initial_x : Float64 | Nil = nil, initial_y : Float64 | Nil = nil, reticle_char : Char = '⌖', show_coordinates : Bool = true, border : Bool = true, width : Int32 | Nil = 24, height : Int32 | Nil = 10, background_shader : Proc(Float64, Float64, Color) | Nil = nil)
- .new(x_range : Range(Float64, Float64) = 0.0..1.0, y_range : Range(Float64, Float64) = 0.0..1.0, initial_x : Float64 | Nil = nil, initial_y : Float64 | Nil = nil, reticle_char : Char = '⌖', show_coordinates : Bool = true, border : Bool = true, width : Int32 | Nil = 24, height : Int32 | Nil = 10, &block : Float64, Float64 -> Color)
Instance Method Summary
-
#background_buffer : Buffer | Nil
Optional pre-rendered background buffer
-
#background_buffer=(background_buffer : Buffer | Nil)
Optional pre-rendered background buffer
- #background_color : Color
- #background_color=(background_color : Color)
-
#background_shader : Proc(Float64, Float64, Color) | Nil
Optional procedural background generator: receives normalized (u, v) in [0.0..1.0] and returns a Color
-
#background_shader=(background_shader : Proc(Float64, Float64, Color) | Nil)
Optional procedural background generator: receives normalized (u, v) in [0.0..1.0] and returns a Color
- #border=(border : Bool)
- #border? : Bool
- #border_color : Color
- #border_color=(border_color : Color)
- #confirmed? : Bool
-
#handle_key(key : Terminal::KeyEvent) : Bool
Default key event handler.
-
#handle_mouse(event : Terminal::MouseEvent) : Bool
Default mouse event handler.
- #height : Int32
- #height=(height : Int32)
- #last_h : Int32
- #last_h=(last_h : Int32)
- #last_w : Int32
- #last_w=(last_w : Int32)
- #last_x : Int32
- #last_x=(last_x : Int32)
- #last_y : Int32
- #last_y=(last_y : Int32)
-
#normalized_coords : Tuple(Float64, Float64)
Returns normalized (u, v) in [0.0..1.0]
-
#on_change : Proc(Float64, Float64, Nil) | Nil
Callbacks
-
#on_change=(on_change : Proc(Float64, Float64, Nil) | Nil)
Callbacks
- #on_confirm : Proc(Float64, Float64, Nil) | Nil
- #on_confirm=(on_confirm : Proc(Float64, Float64, Nil) | Nil)
- #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
- #reticle_char : Char
- #reticle_char=(reticle_char : Char)
- #reticle_color : Color
- #reticle_color=(reticle_color : Color)
-
#set_from_normalized(u : Float64, v : Float64) : Nil
Sets coordinates from normalized (u, v) in [0.0..1.0]
-
#set_values(x : Float64, y : Float64) : Nil
Sets current coordinate values and triggers on_change if changed
- #show_coordinates : Bool
- #show_coordinates=(show_coordinates : Bool)
- #step_x : Float64
- #step_x=(step_x : Float64)
- #step_y : Float64
- #step_y=(step_y : Float64)
- #width : Int32
- #width=(width : Int32)
- #x_max : Float64
- #x_max=(x_max : Float64)
- #x_min : Float64
- #x_min=(x_min : Float64)
- #x_val : Float64
- #x_val=(x_val : Float64)
- #y_max : Float64
- #y_max=(y_max : Float64)
- #y_min : Float64
- #y_min=(y_min : Float64)
- #y_val : Float64
- #y_val=(y_val : Float64)
Constructor methods inherited from class Opal::UI::Control
new
new
Instance methods inherited from module Opal::UI::InputHookable
custom_inputs=(custom_inputs : Bool)
custom_inputs=,
custom_inputs? : Bool
custom_inputs?,
default_input_proc : Proc(InputEvent, Bool) | Nil
default_input_proc,
default_input_proc=(default_input_proc : Proc(InputEvent, Bool) | Nil)
default_input_proc=,
fallback_to_defaults!(enabled : Bool = true) : self
fallback_to_defaults!,
fallback_to_defaults=(fallback_to_defaults : Bool)
fallback_to_defaults=,
fallback_to_defaults? : Bool
fallback_to_defaults?,
focus : self
focus,
focused=(focused : Bool)
focused=,
focused? : Bool
focused?,
handle_default_input(event : InputEvent) : Bool
handle_default_input,
handle_input(event : InputEvent) : Bool
handle_input,
handle_key(key : Terminal::KeyEvent) : Bool
handle_key,
handle_mouse(event : Terminal::MouseEvent) : Bool
handle_mouse,
input_hook : Proc(InputEvent, Bool) | Nil
input_hook,
input_hook=(input_hook : Proc(InputEvent, Bool) | Nil)
input_hook=,
on_input(&block : self, InputEvent -> Bool) : self
on_input,
puppet(&block : self, InputEvent -> Bool) : self
puppet,
reset_inputs : self
reset_inputs,
setup_default_inputs : Nil
setup_default_inputs,
unfocus : self
unfocus,
use_custom_inputs!(enabled : Bool = true) : self
use_custom_inputs!
Instance methods inherited from class Opal::UI::Element
add_class(name : String) : self
add_class,
children : Array(Element)
children,
classes : Set(String)
classes,
classes=(classes : Set(String))
classes=,
has_class?(name : String) : Bool
has_class?,
id : String | Nil
id,
id=(id : String | Nil)
id=,
preferred_print_size(available_w : Int32) : Tuple(Int32, Int32)
preferred_print_size,
preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)
preferred_size,
print(io : IO = STDOUT, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil
print,
query(selector : String) : Array(Element)query(klass : T.class) : Array(T) forall T query, query_one(selector : String) : Element
query_one(klass : T.class) : T forall T query_one, query_one?(selector : String) : Element | Nil
query_one?(klass : T.class) : T | Nil forall T query_one?, remove_class(name : String) : self remove_class, render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil render, render_print(buffer : Buffer, width : Int32, height : Int32) : Nil render_print, to_print_s(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_print_s, to_string(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_string
Instance methods inherited from module Opal::UI::Themable
current_theme : Theme
current_theme,
style(&block : self -> Nil) : self
style,
theme : Theme | Nil
theme,
theme=(theme : Theme | Nil)
theme=,
with_theme(new_theme : Theme | Symbol | String) : self
with_theme
Constructor Detail
def self.new(x_range : Range(Float64, Float64) = 0.0..1.0, y_range : Range(Float64, Float64) = 0.0..1.0, initial_x : Float64 | Nil = nil, initial_y : Float64 | Nil = nil, reticle_char : Char = '⌖', show_coordinates : Bool = true, border : Bool = true, width : Int32 | Nil = 24, height : Int32 | Nil = 10, background_shader : Proc(Float64, Float64, Color) | Nil = nil)
#
def self.new(x_range : Range(Float64, Float64) = 0.0..1.0, y_range : Range(Float64, Float64) = 0.0..1.0, initial_x : Float64 | Nil = nil, initial_y : Float64 | Nil = nil, reticle_char : Char = '⌖', show_coordinates : Bool = true, border : Bool = true, width : Int32 | Nil = 24, height : Int32 | Nil = 10, &block : Float64, Float64 -> Color)
#
Instance Method Detail
Optional pre-rendered background buffer
Optional procedural background generator: receives normalized (u, v) in [0.0..1.0] and returns a Color
Optional procedural background generator: receives normalized (u, v) in [0.0..1.0] and returns a Color
def handle_key(key : Terminal::KeyEvent) : Bool
#
Description copied from module Opal::UI::InputHookable
Default key event handler. Override in subclasses if not using @default_input_proc.
def handle_mouse(event : Terminal::MouseEvent) : Bool
#
Description copied from module Opal::UI::InputHookable
Default mouse event handler. Override in subclasses if not using @default_input_proc.
def set_from_normalized(u : Float64, v : Float64) : Nil
#
Sets coordinates from normalized (u, v) in [0.0..1.0]
def set_values(x : Float64, y : Float64) : Nil
#
Sets current coordinate values and triggers on_change if changed