rage 0.1 → 0.2

data/Rakefile

@@ -9,7 +9,7 @@ require 'rake/gempackagetask'
 
 
 GEM_NAME="rage"
-PKG_VERSION='0.1'
+PKG_VERSION='0.2'
 
 desc "Run all specs"
 Spec::Rake::SpecTask.new('spec') do |t|
@@ -22,19 +22,24 @@ Rake::RDocTask.new do |rd|
     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
 end
 
-PKG_FILES = FileList['bin/**/*', 'lib/**/*.rb', 'COPYING', 'LICENSE', 'Rakefile', 'README.rdoc', 'spec/**/*.rb' ]
+PKG_FILES = FileList['lib/**/*.rb', 'COPYING', 'LICENSE', 'Rakefile', 'README.rdoc', 'spec/**/*' ]
 
 SPEC = Gem::Specification.new do |s|
     s.name = GEM_NAME
     s.version = PKG_VERSION
     s.files = PKG_FILES
+    s.executables << 'rage-mesh-viewer'
 
     s.required_ruby_version = '>= 1.8.1'
     s.required_rubygems_version = Gem::Requirement.new(">= 1.3.3")
+    s.add_development_dependency('rspec', '~> 1.3.0')
+    s.add_dependency('rubysdl', '~> 2.1.1')
+    s.add_dependency('ruby-opengl', '~> 0.60.1')
+    s.add_dependency('rxsd', '~> 0.4.1')
 
     s.author = "Mohammed Morsi"
     s.email = "movitto@yahoo.com"
-    s.date = %q{2010-03-20}
+    s.date = %q{2010-09-05}
     s.description = %q{The Ruby Advanced Gaming Engine}
     s.summary = %q{The Ruby Advanced Gaming Engine}
     s.homepage = %q{http://morsi.org/projects/RAGE}

data/bin/{mesh-viewer.rb → rage-mesh-viewer}

@@ -13,7 +13,7 @@
 require 'rubygems'
 require 'optparse'
 
-require 'lib/rage'
+require 'rage'
 
 include RAGE
 

data/lib/rage.rb

@@ -25,6 +25,8 @@ require lib + '/rage/location'
 require lib + '/rage/loader'
 require lib + '/rage/color'
 require lib + '/rage/mesh'
+require lib + '/rage/text'
 require lib + '/rage/camera'
 require lib + '/rage/viewport'
+require lib + '/rage/audio'
 require lib + '/rage/dsl'

data/lib/rage/audio.rb

@@ -0,0 +1,53 @@
+# RAGE Audio Subsystem
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the GPLv3+ http://www.gnu.org/licenses/gpl.txt
+
+require 'singleton'
+
+module RAGE
+
+# TODO support different audio types
+
+# Manages all audio operations.
+# Currently uses SDL mixer to accomplish this
+class Audio
+  class_attr :audio_initialized
+
+  # pass in as the :times arg to specify continuous music
+  NONSTOP = -1
+
+  def self.play(file, args = {})
+    unless defined? @@audio_initialized
+      @@audio_initialized = true
+      # TODO allow different frequency / open options and channel allocations
+      SDL::Mixer.open(22050 * 4)
+      SDL::Mixer.allocate_channels(16)
+    end
+
+    audio = RAGE::Audio.new args.merge(:wave => SDL::Mixer::Wave.load(file))
+    audio.play
+  end
+
+  def initialize(args = {})
+    @times = 1
+
+    @wave = args[:wave] if args.has_key? :wave
+    @times = args[:times] if args.has_key? :times
+  end
+
+  def play
+    @channel = SDL::Mixer.play_channel(-1, @wave, @times)
+  end
+
+  def playing?
+    SDL::Mixer.play?(@channel)
+  end
+
+  def stop
+    SDL::Mixer.halt(@channel)
+  end
+
+end # module Audio
+
+end # module RAGE

data/lib/rage/camera.rb

@@ -26,7 +26,7 @@ class Camera
      depth = (Window.width + Window.height)/4
      @projection = [45, Window.width / Window.height, 1, depth]
 
-     # initialize lookat params
+     # initial position
      @pos    = [0, 0, 1]
 
      # initial rotation params

data/lib/rage/dsl.rb

@@ -6,31 +6,45 @@
 # Sets attributes on the Window w/ any specified arguments and then 
 # invokes block w/ the Window class. Finally Window is returned.
 def window(args = {}, &block)
-   Window.set_attrs args
-   block.call Window unless block.nil?
-   return Window
+   RAGE::Window.set_attrs args
+   block.call RAGE::Window unless block.nil?
+   return RAGE::Window
 end
 
 # Instantiate new viewport w/ specified args and invoke block, using
 # viewport as an arg. Finally return viewport
 def viewport(args = {}, &block)
-   vp = Viewport.new args
+   vp = RAGE::Viewport.new args
    block.call vp unless block.nil?
    return vp
 end
 
-# Load resource w/ specified args and invoke blockm using resource as an arg.
+# Load resource w/ specified args and invoke block using resource as an arg.
 # Finally return resource.
 def resource(args = {}, &block)
-   resource = ResourcesManager.instance.load_resource args
+   resource = RAGE::ResourcesManager.instance.load_resource args
    block.call resource unless block.nil?
    return resource
 end
 
+# Create a RAGEi::Text instance to display on screen and invoke block
+# using it as an arg. Finally return Text object
+def text(txt, args = {}, &block)
+  rtext = RAGE::Text.new args.merge(:text => txt)
+  block.call rtext unless block.nil?
+  return rtext
+end
+
+# Return input handlers manager, which can be used to register/remove
+# user input handlers
+def input_handlers
+  RAGE::InputHandler
+end
+
 # Set attributes on Game w/ specified args and invoke block
 # using Game as an arg. Finally return Game
 def game(args = {}, &block)
    #Game.set_attrs(args)
-   block.call Game unless block.nil?
-   return Game
+   block.call RAGE::Game unless block.nil?
+   return RAGE::Game
 end

data/lib/rage/game.rb

@@ -35,6 +35,8 @@ class Game
   def self.run
     Gl.glEnable( Gl::GL_TEXTURE_2D )
     Gl.glEnable(Gl::GL_DEPTH_TEST)
+    Gl.glEnable(Gl::GL_BLEND);
+    Gl.glBlendFunc(Gl::GL_SRC_ALPHA, Gl::GL_ONE_MINUS_SRC_ALPHA);
     Gl.glDepthMask(Gl::GL_TRUE)
 
     @@wireframe_mode = false

data/lib/rage/input.rb

@@ -5,29 +5,80 @@
 
 module RAGE
 
-# FIXME turn into callback interface
-
 # Handles and redirects user events to registered callbacks.
 class InputHandler
 
+  class_attr :handlers
+
+  def self.<<(handler)
+    set_defaults
+    @@handlers << handler
+  end
+
+  def self.clear
+    set_defaults
+    @@handlers.clear
+  end
+
   # Invoked during main game execution cycle to handle any SDL input events
   def self.handle(event)
+    set_defaults
+    @@handlers.each { |h| h.handle(event) }
+  end
 
-     @@left_button_pressed  = false unless defined? @@left_button_pressed
-     @@right_button_pressed = false unless defined? @@right_button_pressed
+  private
 
+    def self.set_defaults
+     # TODO at some point these default handlers should probably be removed
+     @@handlers ||= [InputHandlers::TerminationInputHandler, InputHandlers::CommonOpenGlInputHandler, InputHandlers::SimpleCameraInputHandler]
+    end
+
+end
+
+module InputHandlers
+
+# Input handler providing ability to Terminate game on quit related events, including
+# * SDL quit event (window close, etc)
+# * 'Q' or 'ESC' keys pressed
+class TerminationInputHandler
+  def self.handle(event)
      case event
      when SDL::Event2::Quit
         exit
-
      when SDL::Event2::KeyDown
         case event.sym
         when SDL::Key::Q, SDL::Key::ESCAPE
           exit
+        end
+     end
+  end
+end
+
+# Input handler providing common opengl related operations, including
+# * 'W' key toggles wireframe mode on / off
+class CommonOpenGlInputHandler
+  def self.handle(event)
+     case event
+     when SDL::Event2::KeyDown
+        case event.sym
         when SDL::Key::W
           Game.wireframe_mode= !Game.wireframe_mode
         end
+     end
+  end
+end
+
+# Input handler providing the following simple controls
+# * Mouse wheel in/out - zoom camera in/out
+# * Hold left mouse button & drag, rotate camera
+# * Hold right mouse button & drag, pan camera
+class SimpleCameraInputHandler
 
+  def self.handle(event)
+     @@left_button_pressed  = false unless defined? @@left_button_pressed
+     @@right_button_pressed = false unless defined? @@right_button_pressed
+
+     case event
      when SDL::Event::MouseMotion
         # get state of mouse buttons
         left_pressed  = ((event.state & SDL::Mouse::BUTTON_LMASK) != 0)
@@ -35,8 +86,8 @@ class InputHandler
 
         # if left button is down, rotate camera
         if left_pressed
-          xpos, ypos, zpos    = to_3d_coordinates(event.x, event.y)
-          oxpos, oypos, ozpos = to_3d_coordinates(event.x-event.xrel, event.y-event.yrel)
+          xpos, ypos, zpos    = RAGE::to_3d_coordinates(event.x, event.y)
+          oxpos, oypos, ozpos = RAGE::to_3d_coordinates(event.x-event.xrel, event.y-event.yrel)
 
           if xpos > oxpos
              Game.current_viewport.camera.xrotate += 1
@@ -84,8 +135,10 @@ class InputHandler
           Game.current_viewport.camera.pos[2]    -= 1
         end
 
-     end 
+     end
   end
-end
+end # class SimpleCameraInputHandler
 
-end
+end # module InputHandlers
+
+end # module RAGE

data/lib/rage/loader.rb

@@ -25,8 +25,8 @@ class Loader
 
     return data
 
-    rescue URI::InvalidURIError
-       raise Exceptions::InvalidResourceUri
+    #rescue URI::InvalidURIError
+    #   raise Exceptions::InvalidResourceUri
  end
 
 end # class loader

data/lib/rage/location.rb

@@ -14,6 +14,9 @@ class Location
    # Mesh which to draw at location
    attr_reader :mesh
 
+   # Text which to draw at location
+   attr_reader :text
+
    # TODO lights, other entities to draw at locations
    
    # Initialize Location with argument hash, which may include
@@ -21,11 +24,15 @@ class Location
    # * :y location coordinate
    # * :z location coordinate
    # * :mesh resource to draw at location
+   # * :text resource to draw at location
    def initialize(args = {})
+      @mesh = @text = nil
+
       @x = args.has_key?(:x) ? args[:x] : 0
       @y = args.has_key?(:y) ? args[:y] : 0
       @z = args.has_key?(:z) ? args[:z] : 0
       @mesh = args[:mesh]
+      @text = args[:text]
    end
 
    # Update location w/ args, which may include
@@ -59,7 +66,10 @@ class Location
      Gl.glTranslatef(x, y, z)
 
      # draw mesh
-     mesh.draw
+     mesh.draw unless mesh.nil?
+
+     # draw text
+     text.draw unless text.nil?
 
      Gl.glPopMatrix();
    end
@@ -137,5 +147,6 @@ def to_3d_coordinates(x2, y2)
   x3, y3, z3 = Glu.gluUnProject x2, y2, depth[0], model_view, projection, viewport
   return [x3, y3, z3]
 end
+module_function :to_3d_coordinates
 
 end

data/lib/rage/mesh.rb

@@ -44,17 +44,17 @@ class Mesh
 
      # FIXME get all transformations (and groups of) under scene
      @tf = @scene.collision.transform
-     @translation = @tf.translation.to_a :type => XSDFloat
-     @scale       = @tf.scale.to_a :type => XSDFloat
+     @translation = @tf.translation.to_xa :type => XSDFloat
+     @scale       = @tf.scale.to_xa :type => XSDFloat
      #diffuse     = tf.shape.appearance.material.diffuse_color.split.collect { |c| c.to_f }
      #specular    = tf.shape.appearance.material.specular_color.split.collect { |c| c.to_f }
      #emissive    = tf.shape.appearance.material.emissive_color.split.collect { |c| c.to_f }
      @coord_index  = @tf.shape.indexed_face_set.coord_index.
-                                     to_a(:type => String, :delim => ",").
-                                     collect { |coords| a = coords.to_a(:type => XSDInteger); a[0...a.size-1]}.flatten # cut off the last -1
+                                     to_xa(:type => String, :delim => ",").
+                                     collect { |coords| a = coords.to_xa(:type => XSDInteger); a[0...a.size-1]}.flatten # cut off the last -1
      @coord_point  = @tf.shape.indexed_face_set.coordinate.point.
-                                     to_a(:type => String, :delim => ",").
-                                     collect { |coords| coords.to_a :type => XSDFloat }.flatten
+                                     to_xa(:type => String, :delim => ",").
+                                     collect { |coords| coords.to_xa :type => XSDFloat }.flatten
   end
 
   # Create location w/ specified args, associated mesh w/ it and add it to the LocationsManager
@@ -71,6 +71,11 @@ class Mesh
     return @location
   end
 
+  # Return current location coordinates associated w/ the mesh
+  def coordinates
+    [@location.x, @location.y, @location.z]
+  end
+
 
   # Return center point of mesh from mesh translation provided in mesh 
   # and op_translation

data/lib/rage/resource.rb

@@ -35,6 +35,9 @@ class ResourcesManager
       uri  = args[:uri]
       data = Loader.load uri
       resource = Mesh.new(data)
+    elsif type == :text
+      text = args[:text]
+      resource = Text.new(:text => text)
     elsif type == :color
       color = args[:color]
       resource = Color.new(:rgb => color)

data/lib/rage/text.rb

@@ -0,0 +1,76 @@
+# Text Resource
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the GPLv3+ http://www.gnu.org/licenses/gpl.txt
+
+module RAGE
+
+# Represents text to draw onscreen.
+# Currently uses SDL_TTF to do so.
+class Text
+  attr_accessor :text
+
+  class_attr :ttf_initialized
+
+  def initialize(args = {})
+    unless defined? @@ttf_initialized
+      @@ttf_initialize = true
+      SDL::TTF.init
+    end
+
+    @text = args[:text]
+    @font = args[:font]
+    @font_file = args[:font_file]
+    @font_size = args[:font_size]
+
+    # TODO should make use of a font bank or such so fonts can be shared, also specify default font dirs (and allow more to be added)
+    @font = SDL::TTF.open(@font_file, @font_size) if @font.nil? && !@font_file.nil? && !@font_size.nil?
+
+    # TODO allow specification of many other font attributes
+  end
+
+  # Create location w/ specified args, associated text w/ it and add it to the LocationsManager
+  def show_at(args = {})
+    # XXX not a huge fan of storing location interally,
+    # but this is best way to do this for now
+    if ! defined? @location
+      args[:text] = self
+      @location = Location.new(args)
+      LocationsManager.instance.add @location
+    else
+      @location.update args
+    end
+    return @location
+  end
+
+  # Return current location coordinates associated w/ the text
+  def coordinates
+    [@location.x, @location.y, @location.z]
+  end
+
+  # Invoked during draw cycle to draw font
+  def draw
+    # FIXME allow font color to be set, also perhaps use other render method (solid doesn't seem to work tho)
+    surface = @font.render_blended_utf8(@text, 255, 255, 255)
+
+    texture = Gl::glGenTextures(1)[0]
+    Gl::glBindTexture(Gl::GL_TEXTURE_2D, texture);
+
+    Gl::glTexParameterf(Gl::GL_TEXTURE_2D, Gl::GL_TEXTURE_MIN_FILTER, Gl::GL_LINEAR);
+    Gl::glTexParameterf(Gl::GL_TEXTURE_2D, Gl::GL_TEXTURE_MAG_FILTER, Gl::GL_LINEAR);
+    Gl::glTexImage2D(Gl::GL_TEXTURE_2D, 0, Gl::GL_RGBA, surface.w, surface.h, 0, Gl::GL_RGBA, Gl::GL_UNSIGNED_BYTE, surface.pixels);
+
+    Gl::glBegin(Gl::GL_QUADS);
+    # FIXME had to switch the order of these as the text seemed backwards, look into this (used to be 00,01,11,10)
+    Gl::glTexCoord2d(0, 1); Gl::glVertex3d(*coordinates)
+    Gl::glTexCoord2d(1, 1); Gl::glVertex3d(@location.x+surface.w, @location.y, @location.z)
+    Gl::glTexCoord2d(1, 0); Gl::glVertex3d(@location.x+surface.w, @location.y+surface.h, @location.z);
+    Gl::glTexCoord2d(0, 0); Gl::glVertex3d(@location.x, @location.y+surface.h, @location.z);
+    Gl::glEnd();
+
+    Gl::glDeleteTextures([texture]);
+    #SDL.SDL_FreeSurface(surface);
+  end
+end
+
+end

data/lib/rage/window.rb

@@ -14,7 +14,7 @@ class Window
   # Viewports arrays
   class_attr :viewports
 
-  # Set attributes on window, which may include 
+  # Set attributes on window, which may include
   # * :width
   # * :height
   def self.set_attrs(args = {})
@@ -35,7 +35,9 @@ class Window
   def self.show
     SDL.init(SDL::INIT_VIDEO)
     SDL.setGLAttr(SDL::GL_DOUBLEBUFFER,1)
-    @@screen = SDL::Screen.open(width,height,32,SDL::OPENGL)
+    # make sdl pickup keys being held as multiple key events (TODO make this optional)
+    SDL::Key.enableKeyRepeat(SDL::Key::DEFAULT_REPEAT_DELAY / 2, SDL::Key::DEFAULT_REPEAT_INTERVAL / 2)
+    @@screen = SDL::Screen.open(width,height,32,SDL::OPENGL | SDL::SWSURFACE)
 
     @@black = ResourcesManager.instance.load_resource :type => :color, :color => [0,0,0]
   end

data/spec/content/cube.x3d

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.0//EN" "http://www.web3d.org/specifications/x3d-3.0.dtd">
+<X3D version="3.0" profile="Immersive" xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance" xsd:noNamespaceSchemaLocation="http://www.web3d.org/specifications/x3d-3.0.xsd">
+<head>
+	<meta name="filename" content="cube.x3d" />
+	<meta name="generator" content="Blender 249" />
+	<meta name="translator" content="X3D exporter v1.55 (2006/01/17)" />
+</head>
+<Scene>
+<NavigationInfo headlight="FALSE" visibilityLimit="0.0" type='"EXAMINE","ANY"' avatarSize="0.25, 1.75, 0.75" />
+<Background groundColor="0.057 0.221 0.4" skyColor="0.057 0.221 0.4" />
+
+<Collision enabled="false">
+	<Transform DEF="Cube" translation="0.000000 0.000000 0.000000" scale="9.065643 9.065643 9.065643" rotation="-1.000000 0.000000 0.000000 1.570796">
+	<Shape>
+		<IndexedFaceSet solid="true" coordIndex="0 1 2 3 -1, 4 7 6 5 -1, 0 4 5 1 -1, 1 5 6 2 -1, 2 6 7 3 -1, 4 0 3 7 -1, ">
+			<Coordinate DEF="coord_Cube" 
+				point="1.000000 1.000000 -1.000000, 1.000000 -1.000000 -1.000000, -1.000000 -1.000000 -1.000000, -1.000000 1.000000 -1.000000, 1.000000 0.999999 1.000000, 0.999999 -1.00000 1.000000, -1.000000 -1.000000 1.000000, -1.000000 1.000000 1.000000, " />			
+		</IndexedFaceSet>
+	</Shape>
+</Transform>
+</Collision>
+
+
+</Scene>
+</X3D>

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rage
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Mohammed Morsi
@@ -9,26 +14,90 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-20 00:00:00 -04:00
+date: 2010-09-05 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubysdl
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-opengl
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 237
+        segments: 
+        - 0
+        - 60
+        - 1
+        version: 0.60.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rxsd
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  type: :runtime
+  version_requirements: *id004
 description: The Ruby Advanced Gaming Engine
 email: movitto@yahoo.com
-executables: []
-
+executables: 
+- rage-mesh-viewer
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
-- bin/mesh-viewer.rb
 - lib/rage/color.rb
+- lib/rage/text.rb
 - lib/rage/resource.rb
 - lib/rage/input.rb
 - lib/rage/dsl.rb
 - lib/rage/viewport.rb
 - lib/rage/window.rb
+- lib/rage/audio.rb
 - lib/rage/location.rb
 - lib/rage/common.rb
 - lib/rage/camera.rb
@@ -43,6 +112,8 @@ files:
 - spec/spec_helper.rb
 - spec/location_spec.rb
 - spec/mesh_spec.rb
+- spec/content/cube.x3d
+- bin/rage-mesh-viewer
 has_rdoc: true
 homepage: http://morsi.org/projects/RAGE
 licenses: []
@@ -53,21 +124,31 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 53
+      segments: 
+      - 1
+      - 8
+      - 1
       version: 1.8.1
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 29
+      segments: 
+      - 1
+      - 3
+      - 3
       version: 1.3.3
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: The Ruby Advanced Gaming Engine