scene 0.0.0.gemkeep → 0.0.2

data/README.md

@@ -0,0 +1,138 @@
+## Introduction
+
+Super Simple Scene is a gem that attempts to make things as easy as possible to get started with OpenGL. It handles all of the messy window setup and provides sensible defaults various things. Under the hood it uses the GLUT windowing system, which is well-known and widely documented. It has been tested in Ruby 1.8.7+ on Mac OSX Snow Leopard.
+
+<img src='http://i44.tinypic.com/veyp3.png' width="400" height="400" />
+
+## Getting Started
+
+**Install the gem:**
+
+```ruby
+gem install scene
+```
+
+**Require it in your project:**
+
+```ruby
+require 'scene'
+```
+
+You may need to require 'rubygems' too, if you are running an old version of Ruby.
+
+**Running the default scene:**
+
+```ruby
+Scene.display
+```
+
+Press H to display help in the terminal.
+
+**Creating your own scene:**
+
+```ruby
+class MyScene < Scene
+  
+  def initialize
+  end
+  
+  def display
+  end
+  
+  def timer(elapsed)
+  end
+  
+  def keyboard(key, x, y)
+  end
+  
+  def mouse(button, state, x, y)
+  end
+  
+  def reshape(width, height)
+  end
+  
+end
+
+MyScene.display
+```
+
+There is no need to instantiate the class, simply call display and Scene will handle everything for you.
+
+## Initialize
+
+Place any code that you wish to run before the first frame is displayed in the initializer. This can include overrides for the default window, or camera settings, e.g.
+
+```ruby
+def initialize
+  glutReshapeWindow(1000, 1000)  # Set the window size to 1000x1000 instead of 800x800
+  glClearColor(1, 1, 1, 1)       # Set the window background to white instead of black
+end
+```
+
+## Display
+
+The display method will be called every 10 milliseconds, or thereabouts- depending on your machine. There is no need to clear or swap buffers, Scene will handle that for you. The following will draw a red square:
+
+```ruby
+def display
+  glColor3f(1, 0, 0)
+  glBegin(GL_POLYGON)
+    glVertex3f(-1, -1, 0)
+    glVertex3f(-1, 1, 0)
+    glVertex3f(1, 1, 0)
+    glVertex3f(1, -1, 0)
+  glEnd
+end
+```
+
+The camera is positioned at 0, 0, -4 and is focussed on the origin by default. Feel free to change this in your initializer.
+
+## Timer
+
+The timer method is called after each frame is drawn. This is a good place to control animations, for example, you could rotate by x many degrees every time this method is called. Is is given the elapsed time since the previous timer method was called. This allows for building time-accurate animations. It is also a good indication of whether or not your machine is struggling to display the animation if it strays too far from 10ms.
+
+```ruby
+def timer(elapsed)
+  glRotatef(elapsed * 60, 1, 0, 0) # Rotate in the x-axis at a rate of 60 degrees per second
+end
+```
+
+## Keyboard
+
+The keyboard method is used for responding to keyboard events. It is given the character string and the mouse's x- and y-coordinates at the time of the key-press.
+
+```ruby
+def keyboard(key, x, y)
+  puts "You pressed #{key} when the mouse was at: #{x}, #{y}"
+  exit(0) if key == 'q'
+end
+```
+
+## Mouse
+
+The mouse method takes a button, state and coordinates. It may be more semantic to use the constant's provided by GLUT, e.g. GLUT_LEFT_BUTTON and GLUT_DOWN.
+
+```ruby
+def mouse(button, state, x, y)
+  puts "Button: #{button}, State: #{state}, Coordinates: #{x}, #{y}"
+end
+```
+
+## Reshape
+
+The reshape method allows you to specify what happens when the window is resized. Usually you will want to resize the viewport:
+
+```ruby
+def reshape(width, height)
+  min = [width, height].min
+  x = (width - min) / 2
+  y = (height - min) / 2
+  glViewport(x, y, min, min)
+end
+```
+
+## Contribution
+
+Please feel free to contribute, either through pull requests or feature requests here on Github.
+
+For news and latest updates, follow me on Twitter ([@cpatuzzo](https://twitter.com/#!/cpatuzzo)).

data/lib/scene.rb

@@ -0,0 +1,63 @@
+require 'scene/default_scene'
+require 'opengl'
+include Gl, Glu, Glut
+
+class Scene
+  
+  include DefaultScene
+  
+  def self.display
+    initialize
+    
+    glutDisplayFunc(Proc.new { display_proxy })
+    glutTimerFunc(10, Proc.new { timer_proxy }, 0)
+    glutKeyboardFunc(Proc.new { |key, x, y| keyboard_proxy(key, x, y) })
+    glutMouseFunc(Proc.new { |button, state, x, y| instance.mouse(button, state, x, y) })
+    glutReshapeFunc(Proc.new { |width, height| instance.reshape(width, height) })
+    
+    glutMainLoop
+  end
+  
+private
+  
+  def self.instance
+    @instance ||= new
+  end
+  
+  def self.initialize
+    glutInit
+    glutInitDisplayMode(GLUT_DOUBLE | GLUT_RGB | GLUT_DEPTH)
+    glutInitWindowSize(800, 800)
+    glutCreateWindow('Super Simple Scene')
+    
+    glClearColor(0, 0, 0, 0)
+    glEnable(GL_DEPTH_TEST)
+    
+    glMatrixMode(GL_PROJECTION)
+    gluPerspective(60, 1, 1, 10)
+    glMatrixMode(GL_MODELVIEW)
+    gluLookAt(0, 0, -4, 0, 0, 1, 0, 1, 0)
+    
+    instance # Allow initializer overrides
+  end
+  
+  def self.display_proxy
+    glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)
+    instance.display
+    glutSwapBuffers
+  end
+  
+  def self.timer_proxy
+    @time ||= Time.now.to_f
+    elapsed = Time.now.to_f - @time
+    @time = Time.now.to_f
+    instance.timer(elapsed)
+    glutPostRedisplay
+    glutTimerFunc(10, Proc.new { timer_proxy }, 0)
+  end
+  
+  def self.keyboard_proxy(key, x, y)
+    instance.keyboard(key.chr, x, y)
+  end
+  
+end

data/lib/scene/default_scene.rb

@@ -0,0 +1,88 @@
+module DefaultScene
+  
+  def display
+    right, left = -1, 1
+    bottom, top = -1, 1
+    front, back = -1, 1
+    
+    lbf = [left, bottom, front]
+    lbb = [left, bottom, back]
+    ltf = [left, top, front]
+    ltb = [left, top, back]
+    rbf = [right, bottom, front]
+    rbb = [right, bottom, back]
+    rtf = [right, top, front]
+    rtb = [right, top, back]
+    
+    right = [rbf, rbb, rtb, rtf]
+    left = [lbf, ltf, ltb, lbb]
+    bottom = [lbf, lbb, rbb, rbf]
+    top = [ltf, rtf, rtb, ltb]
+    front = [lbf, rbf, rtf, ltf]
+    back = [lbb, ltb, rtb, rbb]
+    
+    glLineWidth(5)
+    [right, left, bottom, top, front, back].each do |face|
+      glBegin(GL_POLYGON)
+      face.each do |vertex|
+        color = vertex
+        glColor3f(*color)
+        glVertex3f(*vertex)
+      end
+      glEnd
+      
+      if @show_outline
+        @outline ||= [rand, rand, rand]
+        glColor3f(*@outline)
+        glBegin(GL_LINE_LOOP)
+        face.each { |v| glVertex3f(*v) }
+        glEnd
+      end
+    end
+  end
+  
+  def timer(elapsed)
+    @show_outline = true if @show_outline.nil?
+    @axes ||= [1, 1, 1]
+    glRotatef(elapsed * 60, *@axes)
+    
+    @counter ||= 0
+    @counter += 1
+    if @counter == 100
+      @outline = [rand, rand, rand]
+      @counter = 0
+    end
+  end
+  
+  def keyboard(key, x, y)
+    case key
+    when 'q'
+      exit(0)
+    when 'h'
+      puts
+      puts 'H            : Display help'
+      puts 'Q            : Quit'
+      puts 'O            : Toggle outline'
+      puts 'Left click   : Inverse x-rotation'
+      puts 'Middle click : Inverse y-rotation'
+      puts 'Right click  : Inverse z-rotation'
+      puts
+      puts 'Visit https://github.com/cpatuzzo/scene for more information'
+    when 'o'
+      @show_outline = !@show_outline
+    end
+  end
+  
+  def mouse(button, state, x, y)
+    return unless state == GLUT_DOWN
+    @axes[button] *= -1
+  end
+  
+  def reshape(width, height)
+    min = [width, height].min
+    x = (width - min) / 2
+    y = (height - min) / 2
+    glViewport(x, y, min, min)
+  end
+  
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scene
 version: !ruby/object:Gem::Version 
-  hash: 1768045684
-  prerelease: 6
+  hash: 27
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 0
-  - gemkeep
-  version: 0.0.0.gemkeep
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Christopher Patuzzo
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-01 00:00:00 Z
+date: 2012-03-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: opengl
@@ -26,10 +25,14 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 3953727737
         segments: 
         - 0
-        version: "0"
+        - 7
+        - 0
+        - pre
+        - 1
+        version: 0.7.0.pre1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -54,8 +57,10 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- README.md
+- lib/scene/default_scene.rb
+- lib/scene.rb
 homepage: https://github.com/cpatuzzo/scene
 licenses: []
 
@@ -76,14 +81,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: