Class: CyberarmEngine::Element::Container

Inherits:
CyberarmEngine::Element show all
Includes:
Common
Defined in:
lib/cyberarm_engine/ui/elements/container.rb

Direct Known Subclasses

Flow, Slider, Stack

Constant Summary

Constants included from Theme

Theme::THEME

Instance Attribute Summary collapse

Attributes inherited from CyberarmEngine::Element

#background_canvas, #border_canvas, #enabled, #event_handler, #options, #parent, #style, #tip, #x, #y, #z

Instance Method Summary collapse

Methods included from Common

#current_state, #darken, #draw_rect, #fill, #get_asset, #get_image, #get_sample, #get_song, #lighten, #opacity, #pop_state, #previous_state, #push_state, #shift_state, #show_cursor, #show_cursor=, #window

Methods inherited from CyberarmEngine::Element

#background=, #blur, #button_down, #button_up, #clicked_left_mouse_button, #content_height, #content_width, #default_events, #dimensional_size, #draggable?, #draw, #enabled?, #enter, #focus, #height, #hide, #hit?, #inner_height, #inner_width, #inspect, #is_root?, #leave, #left_mouse_button, #max_scroll_height, #max_scroll_width, #noncontent_height, #noncontent_width, #outer_height, #outer_width, #released_left_mouse_button, #reposition, #root, #safe_style_fetch, #scroll_height, #scroll_width, #set_background, #set_border_color, #set_border_thickness, #set_margin, #set_padding, #set_static_position, #show, #stylize, #toggle, #update_background, #update_styles, #value=, #visible?, #width

Methods included from CyberarmEngine::Event

#event, #publish, #subscribe, #unsubscribe

Methods included from Theme

#deep_merge, #default, #theme_defaults

Constructor Details

#initialize(options = {}, block = nil) ⇒ Container

Returns a new instance of Container.



9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 9

def initialize(options = {}, block = nil)
  @gui_state = options.delete(:gui_state)
  super

  @scroll_position = Vector.new(0, 0)
  @scroll_speed = 40

  @text_color = options[:color]

  @children = []

  event(:window_size_changed)
end

Instance Attribute Details

#children ⇒ Object (readonly)

Returns the value of attribute children.



7
8
9
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 7

def children
  @children
end

#fill_color ⇒ Object

Returns the value of attribute fill_color.



6
7
8
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 6

def fill_color
  @fill_color
end

#gui_state ⇒ Object (readonly)

Returns the value of attribute gui_state.



7
8
9
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 7

def gui_state
  @gui_state
end

#scroll_position ⇒ Object (readonly)

Returns the value of attribute scroll_position.



7
8
9
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 7

def scroll_position
  @scroll_position
end

#stroke_color ⇒ Object

Returns the value of attribute stroke_color.



6
7
8
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 6

def stroke_color
  @stroke_color
end

Instance Method Details

#add(element) ⇒ Object 



29
30
31
32
33
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 29

def add(element)
  @children << element

  root.gui_state.request_recalculate
end

#apend(&block) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 48

def apend(&block)
  old_container = $__current_container__

  $__current_container__ = self
  block.call(self) if block

  $__current_container__ = old_container

  root.gui_state.request_recalculate
end

#build ⇒ Object 



23
24
25
26
27
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 23

def build
  @block.call(self) if @block

  root.gui_state.request_recalculate
end

#clear(&block) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 35

def clear(&block)
  @children.clear

  old_container = $__current_container__

  $__current_container__ = self
  block.call(self) if block

  $__current_container__ = old_container

  root.gui_state.request_recalculate
end

#debug_draw ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 65

def debug_draw
  super

  @children.each do |child|
    child.debug_draw
  end
end

#fits_on_line?(element) ⇒ Boolean

Flow

Returns:

  • (Boolean) 


148
149
150
151
152
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 148

def fits_on_line?(element) # Flow
  p [@options[:id], @width] if @options[:id]
  @current_position.x + element.outer_width <= max_width &&
    @current_position.x + element.outer_width <= window.width
end

#hit_element?(x, y) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 77

def hit_element?(x, y)
  @children.reverse_each do |child|
    next unless child.visible?

    case child
    when Container
      if element = child.hit_element?(x, y)
        return element
      end
    else
      return child if child.hit?(x, y)
    end
  end

  self if hit?(x, y)
end

#layout ⇒ Object 



135
136
137
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 135

def layout
  raise "Not overridden"
end

#max_width ⇒ Object 



139
140
141
142
143
144
145
146
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 139

def max_width
  _width = dimensional_size(@style.width, :width)
  if _width
    outer_width
  else
    window.width - (@parent ? @parent.style.margin_right + @style.margin_right : @style.margin_right)
  end
end

#mouse_wheel_down(sender, x, y) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 201

def mouse_wheel_down(sender, x, y)
  return unless @style.scroll

  return unless height < scroll_height

  if @scroll_position.y.abs < max_scroll_height
    @scroll_position.y -= @scroll_speed
    @scroll_position.y = -max_scroll_height if @scroll_position.y.abs > max_scroll_height
    recalculate

    return :handled
  end
end

#mouse_wheel_up(sender, x, y) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 189

def mouse_wheel_up(sender, x, y)
  return unless @style.scroll

  if @scroll_position.y < 0
    @scroll_position.y += @scroll_speed
    @scroll_position.y = 0 if @scroll_position.y > 0
    recalculate

    return :handled
  end
end

#move_to_next_line(element) ⇒ Object

Stack



182
183
184
185
186
187
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 182

def move_to_next_line(element) # Stack
  element.x = element.style.margin_left + @current_position.x
  element.y = element.style.margin_top  + @current_position.y

  @current_position.y += element.outer_height
end

#position_on_current_line(element) ⇒ Object

Flow



154
155
156
157
158
159
160
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 154

def position_on_current_line(element) # Flow
  element.x = element.style.margin_left + @current_position.x
  element.y = element.style.margin_top  + @current_position.y

  @current_position.x += element.outer_width
  @current_position.x = @style.margin_left if @current_position.x >= max_width
end

#position_on_next_line(child) ⇒ Object

Flow



172
173
174
175
176
177
178
179
180
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 172

def position_on_next_line(child) # Flow
  @current_position.x = @style.margin_left
  @current_position.y += tallest_neighbor(child, @current_position.y).outer_height

  child.x = child.style.margin_left + @current_position.x
  child.y = child.style.margin_top  + @current_position.y

  @current_position.x += child.outer_width
end

#recalculate ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 94

def recalculate
  @current_position = Vector.new(@style.margin_left + @style.padding_left, @style.margin_top + @style.padding_top)
  @current_position += @scroll_position

  return unless visible?

  Stats.increment(:gui_recalculations_last_frame, 1)

  stylize

  layout

  if is_root?
    @width  = @style.width  = window.width
    @height = @style.height = window.height
  else
    @width = 0
    @height = 0

    _width = dimensional_size(@style.width, :width)
    _height = dimensional_size(@style.height, :height)

    @width  = _width  || (@children.map { |c| c.x + c.outer_width }.max || 0).round
    @height = _height || (@children.map { |c| c.y + c.outer_height }.max || 0).round
  end

  # Move child to parent after positioning
  @children.each do |child|
    child.x += (@x + @style.border_thickness_left) - style.margin_left
    child.y += (@y + @style.border_thickness_top) - style.margin_top

    child.stylize
    child.recalculate
    child.reposition # TODO: Implement top,bottom,left,center, and right positioning

    Stats.increment(:gui_recalculations_last_frame, 1)
  end

  update_background
end

#render ⇒ Object 



59
60
61
62
63
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 59

def render
  Gosu.clip_to(@x, @y, width, height) do
    @children.each(&:draw)
  end
end

#scroll_top ⇒ Object 



215
216
217
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 215

def scroll_top
  @scroll_position.y
end

#scroll_top=(n) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 219

def scroll_top=(n)
  n = 0 if n <= 0
  @scroll_position.y = -n

  if max_scroll_height.positive?
    @scroll_position.y = -max_scroll_height if @scroll_position.y.abs > max_scroll_height
  else
    @scroll_position.y = 0
  end
end

#tallest_neighbor(querier, _y_position) ⇒ Object

Flow



162
163
164
165
166
167
168
169
170
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 162

def tallest_neighbor(querier, _y_position) # Flow
  response = querier
  @children.each do |child|
    response = child if child.outer_height > response.outer_height
    break if child == querier
  end

  response
end

#to_s ⇒ Object 



234
235
236
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 234

def to_s
  "#{self.class} x=#{x} y=#{y} width=#{width} height=#{height} children=#{@children.size}"
end

#update ⇒ Object 



73
74
75
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 73

def update
  @children.each(&:update)
end

#value ⇒ Object 



230
231
232
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 230

def value
  @children.map { |c| c.class }.join(", ")
end

#write_tree(indent = "", _index = 0) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/cyberarm_engine/ui/elements/container.rb', line 238

def write_tree(indent = "", _index = 0)
  puts self

  indent += "  "
  @children.each_with_index do |child, i|
    print "#{indent}#{i}: "

    if child.is_a?(Container)
      child.write_tree(indent)
    else
      puts child
    end
  end
end