Class: Fidgit::Element Abstract

Inherits:

Object

• Object
• Fidgit::Element

show all

Includes:

Event

Defined in:

lib/fidgit/elements/element.rb

Overview

Constant Summary

DEFAULT_SCHEMA_FILE =

File.expand_path(File.join(__FILE__, '..', '..', '..', '..', 'config', 'default_schema.yml'))

VALID_ALIGN_H =

[:left, :center, :right, :fill]

VALID_ALIGN_V =

[:top, :center, :bottom, :fill]

Instance Attribute Summary (collapse)

• - (Object) align_h readonly

  Returns the value of attribute align_h.

• - (Object) align_v readonly

  Returns the value of attribute align_v.

• - (Object) background_color

  Returns the value of attribute background_color.

• - (Object) border_thickness readonly

  Returns the value of attribute border_thickness.

• - (Object) font

  Returns the value of attribute font.

• - (Object) padding_bottom readonly

  Returns the value of attribute padding_bottom.

• - (Object) padding_left readonly

  Returns the value of attribute padding_left.

• - (Object) padding_right readonly

  Returns the value of attribute padding_right.

• - (Object) padding_top readonly

  Returns the value of attribute padding_top.

• - (Object) parent readonly

  Returns the value of attribute parent.

• - (Object) tip

  Returns the value of attribute tip.

• - (Object) z readonly

  Returns the value of attribute z.

Class Method Summary (collapse)

• + (Object) new(*args, &block)
• + (Object) original_new
• + (Object) schema

Instance Method Summary (collapse)

• - (Object) default(*names)

  Get the default value from the schema.

• - (Boolean) drag?(button)

  Can the object be dragged?.

• - (Object) draw

  Redraw the element.

• - (Object) draw_frame(*args)
• - (Object) draw_rect(*args)
• - (Object) enabled=(value)
• - (Boolean) enabled?
• - (Object) height

  Height not including border.

• - (Object) height=(value)
• - (Boolean) hit?(x, y)

  Check if a point (screen coordinates) is over the element.

• - (Element) initialize(options = {}) { ... } constructor

  A new instance of Element.

• - (Object) max_height
• - (Object) max_width
• - (Object) min_height
• - (Object) min_width
• - (Object) outer_height

  Height including border thickness.

• - (Object) outer_width

  Width including border thickness.

• - (Object) recalc
• - (Object) to_s
• - (Object) update

  Update the element.

• - (Object) width

  Width not including border.

• - (Object) width=(value)
• - (Object) with(&block)

  Evaluate a block, just like it was a constructor block.

• - (Object) x
• - (Object) x=(value)
• - (Object) y
• - (Object) y=(value)

Methods included from Event

#events, included, new_event_handlers, #publish, #subscribe, #unsubscribe

145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

# File 'lib/fidgit/elements/element.rb', line 145

def initialize(options = {}, &block)
  options = {
    x: 0,
    y: 0,
    z: 0,
    tip: '',
    font_name: default(:font_name),
    font_height: default(:font_height),
    background_color: default(:background_color),
    border_color: default(:border_color),
    border_thickness: default(:border_thickness),
    enabled: true,
  }.merge! options

  @enabled = options[:enabled]

  @mouse_over = false

  # Alignment and min/max dimensions.
  @align_h = options[:align_h] || Array(options[:align]).last || default(:align_h)
  raise ArgumentError, "Invalid align_h: #{@align_h}" unless VALID_ALIGN_H.include? @align_h

  min_width = (options[:min_width] || options[:width] || 0)
  max_width = (options[:max_width] || options[:width] || Float::INFINITY)
  @width_range = min_width..max_width                                         

  @align_v = options[:align_v] || Array(options[:align]).first ||  default(:align_v)
  raise ArgumentError, "Invalid align_v: #{@align_v}" unless VALID_ALIGN_V.include? @align_v

  min_height = (options[:min_height] || options[:height] || 0)
  max_height = (options[:max_height] || options[:height] || Float::INFINITY)
  @height_range = min_height..max_height

  @background_color = options[:background_color].dup
  @border_color = options[:border_color].dup
  @border_thickness = options[:border_thickness]

  @padding_top = options[:padding_top]       || options[:padding_v] || options[:padding] ||  default(:padding_top)
  @padding_right = options[:padding_right]   || options[:padding_h] || options[:padding] ||  default(:padding_right)
  @padding_bottom = options[:padding_bottom] || options[:padding_v] || options[:padding] ||  default(:padding_bottom)
  @padding_left = options[:padding_left]     || options[:padding_h] || options[:padding] ||  default(:padding_left)
  self.parent = options[:parent]

  @z = options[:z]
  @tip = options[:tip].dup
  font_name = if options[:font_name].nil? or options[:font_name] == :default
                 Gosu::default_font_name
               else
                 options[:font_name].dup
               end

  @font = options[:font] || Gosu::Font[font_name, options[:font_height]]

  @rect = Chingu::Rect.new(options[:x], options[:y], options[:width] || 0, options[:height] || 0)
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def align_h
  @align_h
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def align_v
  @align_v
end

48
49
50

# File 'lib/fidgit/elements/element.rb', line 48

def background_color
  @background_color
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def border_thickness
  @border_thickness
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def font
  @font
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def padding_bottom
  @padding_bottom
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def padding_left
  @padding_left
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def padding_right
  @padding_right
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def padding_top
  @padding_top
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def parent
  @parent
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def tip
  @tip
end

45
46
47

# File 'lib/fidgit/elements/element.rb', line 45

def z
  @z
end

93
94
95
96
97
98

# File 'lib/fidgit/elements/element.rb', line 93

def new(*args, &block)
  obj = original_new(*args) # Block should be ignored.
  obj.send :post_init
  obj.send :post_init_block, &block if block_given?
  obj
end

91

# File 'lib/fidgit/elements/element.rb', line 91

alias_method :original_new, :new

88

# File 'lib/fidgit/elements/element.rb', line 88

def self.schema; @@schema ||= Schema.new(YAML.load(File.read(DEFAULT_SCHEMA_FILE)));; end

104
105
106

# File 'lib/fidgit/elements/element.rb', line 104

def default(*names)
  self.class.schema.default(self.class, names)
end

74

# File 'lib/fidgit/elements/element.rb', line 74

def drag?(button); false; end

222
223
224
225
226
227

# File 'lib/fidgit/elements/element.rb', line 222

def draw
  draw_background
  draw_border
  draw_foreground
  nil
end

238
239
240

# File 'lib/fidgit/elements/element.rb', line 238

def draw_frame(*args)
  $window.current_game_state.draw_frame(*args)
end

234
235
236

# File 'lib/fidgit/elements/element.rb', line 234

def draw_rect(*args)
  $window.current_game_state.draw_rect(*args)
end

78
79
80
81
82
83
84

# File 'lib/fidgit/elements/element.rb', line 78

def enabled=(value)
  if @mouse_over and enabled? and not value
    $window.current_game_state.unset_mouse_over
  end

  @enabled = value
end

76

# File 'lib/fidgit/elements/element.rb', line 76

def enabled?; @enabled; end

66

# File 'lib/fidgit/elements/element.rb', line 66

def height; rect.height; end

67

# File 'lib/fidgit/elements/element.rb', line 67

def height=(value); rect.height = [[value, @height_range.max].min, @height_range.min].max; end

217
218
219

# File 'lib/fidgit/elements/element.rb', line 217

def hit?(x, y)
  @rect.collide_point?(x, y)
end

69

# File 'lib/fidgit/elements/element.rb', line 69

def max_height; @height_range.max; end

61

# File 'lib/fidgit/elements/element.rb', line 61

def max_width; @width_range.max; end

68

# File 'lib/fidgit/elements/element.rb', line 68

def min_height; @height_range.min; end

60

# File 'lib/fidgit/elements/element.rb', line 60

def min_width; @width_range.min; end

71

# File 'lib/fidgit/elements/element.rb', line 71

def outer_height; rect.height + @border_thickness * 2; end

63

# File 'lib/fidgit/elements/element.rb', line 63

def outer_width; rect.width + @border_thickness * 2; end

208
209
210
211
212
213
214

# File 'lib/fidgit/elements/element.rb', line 208

def recalc
  old_width, old_height = width, height
  layout
  parent.recalc if parent and (width != old_width or height != old_height)

  nil
end

294
295
296

# File 'lib/fidgit/elements/element.rb', line 294

def to_s
  "#{self.class} (#{x}, #{y}) #{width}x#{height}"
end

230
231
232

# File 'lib/fidgit/elements/element.rb', line 230

def update
  nil
end

58

# File 'lib/fidgit/elements/element.rb', line 58

def width; rect.width; end

59

# File 'lib/fidgit/elements/element.rb', line 59

def width=(value); rect.width = [[value, @width_range.max].min, @width_range.min].max; end

275
276
277
278
279
280
281
282
283
284
285

# File 'lib/fidgit/elements/element.rb', line 275

def with(&block)
  raise ArgumentError.new("Must pass a block") unless block_given?
  case block.arity
    when 1
      yield self
    when 0
      instance_methods_eval(&block)
    else
      raise "block arity must be 0 or 1"
  end
end

51

# File 'lib/fidgit/elements/element.rb', line 51

def x; rect.x; end

52

# File 'lib/fidgit/elements/element.rb', line 52

def x=(value); rect.x = value; end

54

# File 'lib/fidgit/elements/element.rb', line 54

def y; rect.y; end

55

# File 'lib/fidgit/elements/element.rb', line 55

def y=(value); rect.y = value; end