Class: Ruby2D::Window

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby2d/window.rb,
ext/ruby2d/ruby2d-opal.rb

Defined Under Namespace

Classes: ControllerAxisEvent, ControllerButtonEvent, ControllerEvent, EventDescriptor, KeyEvent, MouseEvent

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Window

Returns a new instance of Window.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ruby2d/window.rb', line 16

def initialize(args = {})

  # This window instance, stored so it can be called by the class methods
  @@window = self

  # Title of the window
  @title = args[:title]  || "Ruby 2D"

  # Window background color
  @background = Color.new([0.0, 0.0, 0.0, 1.0])

  # Window icon
  @icon = nil

  # Window size and characteristics
  @width  = args[:width]  || 640
  @height = args[:height] || 480
  @resizable = false
  @borderless = false
  @fullscreen = false
  @highdpi = false

  # Size of the window's viewport (the drawable area)
  @viewport_width, @viewport_height = nil, nil

  # Size of the computer's display
  @display_width, @display_height = nil, nil

  # Total number of frames that have been rendered
  @frames = 0

  # Frames per second upper limit, and the actual FPS
  @fps_cap = args[:fps_cap] || 60
  @fps = @fps_cap

  # Vertical synchronization, set to prevent screen tearing (recommended)
  @vsync = args[:vsync] || true

  # Mouse X and Y position in the window
  @mouse_x, @mouse_y = 0, 0

  # Controller axis and button mappings file
  @controller_mappings = File.expand_path('~') + "/.ruby2d/controllers.txt"

  # Renderable objects currently in the window, like a linear scene graph
  @objects = []

  # Unique ID for the input event being registered
  @event_key = 0

  # Registered input events
  @events = {
    key: {},
    key_down: {},
    key_held: {},
    key_up: {},
    mouse: {},
    mouse_up: {},
    mouse_down: {},
    mouse_scroll: {},
    mouse_move: {},
    controller: {},
    controller_axis: {},
    controller_button_down: {},
    controller_button_up: {}
  }

  # The window update block
  @update_proc = Proc.new {}

  # Whether diagnostic messages should be printed
  @diagnostics = false
end

Class Method Details

.add(o) ⇒ Object 



128
129
130
 
# File 'lib/ruby2d/window.rb', line 128

def add(o)
  @@window.add(o)
end

.background ⇒ Object 



94
 
# File 'lib/ruby2d/window.rb', line 94

def background;      get(:background)      end

.borderless ⇒ Object 



102
 
# File 'lib/ruby2d/window.rb', line 102

def borderless;      get(:borderless)      end

.clear ⇒ Object 



136
137
138
 
# File 'lib/ruby2d/window.rb', line 136

def clear
  @@window.clear
end

.close ⇒ Object 



148
149
150
 
# File 'lib/ruby2d/window.rb', line 148

def close
  @@window.close
end

.current ⇒ Object 



92
 
# File 'lib/ruby2d/window.rb', line 92

def current;         get(:window)          end

.diagnostics ⇒ Object 



110
 
# File 'lib/ruby2d/window.rb', line 110

def diagnostics;     get(:diagnostics)     end

.display_height ⇒ Object 



100
 
# File 'lib/ruby2d/window.rb', line 100

def display_height;  get(:display_height)  end

.display_width ⇒ Object 



99
 
# File 'lib/ruby2d/window.rb', line 99

def display_width;   get(:display_width)   end

.fps ⇒ Object 



106
 
# File 'lib/ruby2d/window.rb', line 106

def fps;             get(:fps)             end

.fps_cap ⇒ Object 



107
 
# File 'lib/ruby2d/window.rb', line 107

def fps_cap;         get(:fps_cap)         end

.frames ⇒ Object 



105
 
# File 'lib/ruby2d/window.rb', line 105

def frames;          get(:frames)          end

.fullscreen ⇒ Object 



103
 
# File 'lib/ruby2d/window.rb', line 103

def fullscreen;      get(:fullscreen)      end

.get(sym) ⇒ Object 



112
113
114
 
# File 'lib/ruby2d/window.rb', line 112

def get(sym)
  @@window.get(sym)
end

.height ⇒ Object 



96
 
# File 'lib/ruby2d/window.rb', line 96

def height;          get(:height)          end

.highdpi ⇒ Object 



104
 
# File 'lib/ruby2d/window.rb', line 104

def highdpi;         get(:highdpi)         end

.mouse_x ⇒ Object 



108
 
# File 'lib/ruby2d/window.rb', line 108

def mouse_x;         get(:mouse_x)         end

.mouse_y ⇒ Object 



109
 
# File 'lib/ruby2d/window.rb', line 109

def mouse_y;         get(:mouse_y)         end

.off(event_descriptor) ⇒ Object 



124
125
126
 
# File 'lib/ruby2d/window.rb', line 124

def off(event_descriptor)
  @@window.off(event_descriptor)
end

.on(event, &proc) ⇒ Object 



120
121
122
 
# File 'lib/ruby2d/window.rb', line 120

def on(event, &proc)
  @@window.on(event, &proc)
end

.remove(o) ⇒ Object 



132
133
134
 
# File 'lib/ruby2d/window.rb', line 132

def remove(o)
  @@window.remove(o)
end

.resizable ⇒ Object 



101
 
# File 'lib/ruby2d/window.rb', line 101

def resizable;       get(:resizable)       end

.set(opts) ⇒ Object 



116
117
118
 
# File 'lib/ruby2d/window.rb', line 116

def set(opts)
  @@window.set(opts)
end

.show ⇒ Object 



144
145
146
 
# File 'lib/ruby2d/window.rb', line 144

def show
  @@window.show
end

.title ⇒ Object 



93
 
# File 'lib/ruby2d/window.rb', line 93

def title;           get(:title)           end

.update(&proc) ⇒ Object 



140
141
142
 
# File 'lib/ruby2d/window.rb', line 140

def update(&proc)
  @@window.update(&proc)
end

.viewport_height ⇒ Object 



98
 
# File 'lib/ruby2d/window.rb', line 98

def viewport_height; get(:viewport_height) end

.viewport_width ⇒ Object 



97
 
# File 'lib/ruby2d/window.rb', line 97

def viewport_width;  get(:viewport_width)  end

.width ⇒ Object 



95
 
# File 'lib/ruby2d/window.rb', line 95

def width;           get(:width)           end

Instance Method Details

#add(o) ⇒ Object

Add an object to the window



206
207
208
209
210
211
212
213
214
215
 
# File 'lib/ruby2d/window.rb', line 206

def add(o)
  case o
  when nil
    raise Error, "Cannot add '#{o.class}' to window!"
  when Array
    o.each { |x| add_object(x) }
  else
    add_object(o)
  end
end

#add_controller_mappings ⇒ Object

Add controller mappings from file



322
323
324
325
326
327
328
 
# File 'lib/ruby2d/window.rb', line 322

def add_controller_mappings
  unless RUBY_ENGINE == 'opal'
    if File.exists? @controller_mappings
      ext_add_controller_mappings(@controller_mappings)
    end
  end
end

#clear ⇒ Object

Clear all objects from the window



232
233
234
 
# File 'lib/ruby2d/window.rb', line 232

def clear
  @objects.clear
end

#close ⇒ Object

Close the window



367
368
369
 
# File 'lib/ruby2d/window.rb', line 367

def close
  ext_close
end

#controller_callback(which, type, axis, value, button) ⇒ Object

Controller callback method, called by the native and web extentions



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/ruby2d/window.rb', line 331

def controller_callback(which, type, axis, value, button)
  # All controller events
  @events[:controller].each do |id, e|
    e.call(ControllerEvent.new(which, type, axis, value, button))
  end

  case type
  # When controller axis motion, like analog sticks
  when :axis
    @events[:controller_axis].each do |id, e|
      e.call(ControllerAxisEvent.new(which, axis, value))
    end
  # When controller button is pressed
  when :button_down
    @events[:controller_button_down].each do |id, e|
      e.call(ControllerButtonEvent.new(which, button))
    end
  # When controller button is released
  when :button_up
    @events[:controller_button_up].each do |id, e|
      e.call(ControllerButtonEvent.new(which, button))
    end
  end
end

#ext_show ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'ext/ruby2d/ruby2d-opal.rb', line 263

def ext_show
  $R2D_WINDOW = self

  `
  var width  = #{$R2D_WINDOW.get(:width)};
  var height = #{$R2D_WINDOW.get(:height)};

  var vp_w = #{$R2D_WINDOW.get(:viewport_width)};
  var viewport_width = vp_w != Opal.nil ? vp_w : width;

  var vp_h = #{$R2D_WINDOW.get(:viewport_height)};
  var viewport_height = vp_h != Opal.nil ? vp_h : height;

  win = S2D.CreateWindow(
    #{$R2D_WINDOW.get(:title)}, width, height, update, render, "ruby2d-app", {}
  );

  win.viewport.width  = viewport_width;
  win.viewport.height = viewport_height;
  win.on_key          = on_key;
  win.on_mouse        = on_mouse;

  S2D.Show(win);
  `
end

#get(sym) ⇒ Object

Retrieve an attribute of the window



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
 
# File 'lib/ruby2d/window.rb', line 156

def get(sym)
  case sym
  when :window;          self
  when :title;           @title
  when :background;      @background
  when :width;           @width
  when :height;          @height
  when :viewport_width;  @viewport_width
  when :viewport_height; @viewport_height
  when :display_width, :display_height
    ext_get_display_dimensions
    if sym == :display_width
      @display_width
    else
      @display_height
    end
  when :resizable;       @resizable
  when :borderless;      @borderless
  when :fullscreen;      @fullscreen
  when :highdpi;         @highdpi
  when :frames;          @frames
  when :fps;             @fps
  when :fps_cap;         @fps_cap
  when :mouse_x;         @mouse_x
  when :mouse_y;         @mouse_y
  when :diagnostics;     @diagnostics
  end
end

#key_callback(type, key) ⇒ Object

Key callback method, called by the native and web extentions



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/ruby2d/window.rb', line 263

def key_callback(type, key)
  key = key.downcase

  # All key events
  @events[:key].each do |id, e|
    e.call(KeyEvent.new(type, key))
  end

  case type
  # When key is pressed, fired once
  when :down
    @events[:key_down].each do |id, e|
      e.call(KeyEvent.new(type, key))
    end
  # When key is being held down, fired every frame
  when :held
    @events[:key_held].each do |id, e|
      e.call(KeyEvent.new(type, key))
    end
  # When key released, fired once
  when :up
    @events[:key_up].each do |id, e|
      e.call(KeyEvent.new(type, key))
    end
  end
end

#mouse_callback(type, button, direction, x, y, delta_x, delta_y) ⇒ Object

Mouse callback method, called by the native and web extentions



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/ruby2d/window.rb', line 291

def mouse_callback(type, button, direction, x, y, delta_x, delta_y)
  # All mouse events
  @events[:mouse].each do |id, e|
    e.call(MouseEvent.new(type, button, direction, x, y, delta_x, delta_y))
  end

  case type
  # When mouse button pressed
  when :down
    @events[:mouse_down].each do |id, e|
      e.call(MouseEvent.new(type, button, nil, x, y, nil, nil))
    end
  # When mouse button released
  when :up
    @events[:mouse_up].each do |id, e|
      e.call(MouseEvent.new(type, button, nil, x, y, nil, nil))
    end
  # When mouse motion / movement
  when :scroll
    @events[:mouse_scroll].each do |id, e|
      e.call(MouseEvent.new(type, nil, direction, nil, nil, delta_x, delta_y))
    end
  # When mouse scrolling, wheel or trackpad
  when :move
    @events[:mouse_move].each do |id, e|
      e.call(MouseEvent.new(type, nil, nil, x, y, delta_x, delta_y))
    end
  end
end

#new_event_key ⇒ Object

Generate a new event key (ID)



243
244
245
 
# File 'lib/ruby2d/window.rb', line 243

def new_event_key
  @event_key = @event_key.next
end

#off(event_descriptor) ⇒ Object

Remove an event handler



258
259
260
 
# File 'lib/ruby2d/window.rb', line 258

def off(event_descriptor)
  @events[event_descriptor.type].delete(event_descriptor.id)
end

#on(event, &proc) ⇒ Object

Set an event handler



248
249
250
251
252
253
254
255
 
# File 'lib/ruby2d/window.rb', line 248

def on(event, &proc)
  unless @events.has_key? event
    raise Error, "`#{event}` is not a valid event type"
  end
  event_id = new_event_key
  @events[event][event_id] = proc
  EventDescriptor.new(event, event_id)
end

#remove(o) ⇒ Object

Remove an object from the window



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/ruby2d/window.rb', line 218

def remove(o)
  if o == nil
    raise Error, "Cannot remove '#{o.class}' from window!"
  end

  if i = @objects.index(o)
    @objects.delete_at(i)
    true
  else
    false
  end
end

#set(opts) ⇒ Object

Set a window attribute



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/ruby2d/window.rb', line 186

def set(opts)
  # Store new window attributes, or ignore if nil
  @title           = opts[:title]           || @title
  if Color.is_valid? opts[:background]
    @background    = Color.new(opts[:background])
  end
  @icon            = opts[:icon]            || @icon
  @width           = opts[:width]           || @width
  @height          = opts[:height]          || @height
  @fps_cap         = opts[:fps_cap]         || @fps_cap
  @viewport_width  = opts[:viewport_width]  || @viewport_width
  @viewport_height = opts[:viewport_height] || @viewport_height
  @resizable       = opts[:resizable]       || @resizable
  @borderless      = opts[:borderless]      || @borderless
  @fullscreen      = opts[:fullscreen]      || @fullscreen
  @highdpi         = opts[:highdpi]         || @highdpi
  @diagnostics     = opts[:diagnostics]     || @diagnostics
end

#show ⇒ Object

Show the window



362
363
364
 
# File 'lib/ruby2d/window.rb', line 362

def show
  ext_show
end

#update(&proc) ⇒ Object

Set an update callback



237
238
239
240
 
# File 'lib/ruby2d/window.rb', line 237

def update(&proc)
  @update_proc = proc
  true
end

#update_callback ⇒ Object

Update callback method, called by the native and web extentions



357
358
359
 
# File 'lib/ruby2d/window.rb', line 357

def update_callback
  @update_proc.call
end