gosu 0.7.10.1

data/examples/RMagickIntegration.rb

@@ -0,0 +1,449 @@
+# A (too) simple Gorilla-style shooter for two players.
+# Shows how Gosu and RMagick can be used together to generate a map, implement
+# a dynamic landscape and generally look great.
+# Also shows a very minimal, yet effective way of designing a game's object system.
+
+# Doesn't make use of Gosu's Z-ordering. Not many different things to draw, it's
+# easy to get the order right without it.
+
+# Known issues:
+# * Collision detection of the missiles is lazy, allows shooting through thin walls.
+# * The look of dead soldiers is, err, by accident. Soldier.png needs to be
+#   designed in a less obfuscated way :)
+
+begin
+  # In case you use Gosu via RubyGems.
+  require 'rubygems'
+rescue LoadError
+  # In case you don't.
+end
+
+require 'gosu'
+require 'RMagick'
+
+NULL_PIXEL = Magick::Pixel.from_color('none')
+
+# The class for this game's map.
+# Design:
+# * Dynamic map creation at startup, holding it as RMagick Image in @image
+# * Testing for solidity by testing @image's pixel values
+# * Drawing by (re)creating an array of Gosu::Image instances, each representing
+#   a part of the large @image
+# * Blasting holes into the map is implemented by drawing and erasing portions
+#   of @image, then setting the corresponding Gosu::Image instances to nil, so
+#   they will be recreated in Map#draw
+# Note: The splitting is done because recreating such a large Gosu::Image for
+#       every map change would be a very noticeable delay!
+
+class Map
+  WIDTH, HEIGHT = 800, 600
+  TILE_SIZE = 100
+  TILES_X = WIDTH / TILE_SIZE
+  TILES_Y = HEIGHT / TILE_SIZE
+  
+  def initialize(window)
+    # We'll need the window later for re-creating Gosu images.
+    @window = window
+
+    # Let's start with something simple and load the sky via RMagick.
+    # Loading JPEG files isn't possible with Gosu, so say wow!
+    sky = Magick::Image.read("media/Sky.jpg").first
+    @sky = Gosu::Image.new(window, sky, true)
+    
+    # This is the one large RMagick image that represents the map.
+    @image = Magick::Image.new(WIDTH, HEIGHT) { self.background_color = 'none' }
+    
+    # Set up a Draw object that fills with an earth texture.
+    earth = Magick::Image.read('media/Earth.png').first.resize(1.5)
+    gc = Magick::Draw.new
+    gc.pattern('earth', 0, 0, earth.columns, earth.rows) { gc.composite(0, 0, 0, 0, earth) }    
+    gc.fill('earth')
+    gc.stroke('#603000').stroke_width(1.5)
+    # Draw a smooth bezier island onto the map!
+    polypoints = [0, HEIGHT]
+    0.upto(TILES_X) do |x|
+      polypoints += [x * TILE_SIZE, HEIGHT * 0.2 + rand(HEIGHT * 0.8)]
+    end
+    polypoints += [WIDTH, HEIGHT]
+    gc.bezier(*polypoints)
+    gc.draw(@image)
+    
+    # Create a bright-dark gradient fill, an image from it and change the map's
+    # brightness with it.
+    fill = Magick::GradientFill.new(0, HEIGHT * 0.4, WIDTH, HEIGHT * 0.4, '#fff', '#666')
+    gradient = Magick::Image.new(WIDTH, HEIGHT, fill)
+    gradient = @image.composite(gradient, 0, 0, Magick::InCompositeOp)
+    @image.composite!(gradient, 0, 0, Magick::MultiplyCompositeOp)
+
+    # Finally, place the star in the middle of the map, just onto the ground.
+    star = Magick::Image.read('media/LargeStar.png').first
+    star_y = 0
+    star_y += 20 until solid?(WIDTH / 2, star_y)
+    @image.composite!(star, (WIDTH - star.columns) / 2, star_y - star.rows * 0.85,
+      Magick::DstOverCompositeOp)
+
+    # Creates an X*Y array for the Gosu images.
+    # (Initialized to nil automatically).
+    @gosu_images = Array.new(TILES_X) { Array.new(TILES_Y) }
+  end
+  
+  def solid?(x, y)
+    # Map is open at the top.
+    return false if y < 0
+    # Map is closed on all other sides.
+    return true if x < 0 or x >= 800 or y >= 600
+    # Inside of the map, determine solidity from the map image.
+    @image.pixel_color(x, y) != NULL_PIXEL
+  end
+  
+  def draw
+    # Sky background.
+    @sky.draw(0, 0, 0)
+    # All the tiles.
+    TILES_Y.times do |y|
+      TILES_X.times do |x|
+        # Recreate images that haven't been created yet, or need to be recreated
+        # due to map changes.
+        if @gosu_images[x][y].nil? then
+          part = @image.crop(x * TILE_SIZE, y * TILE_SIZE, TILE_SIZE, TILE_SIZE)
+          @gosu_images[x][y] = Gosu::Image.new(@window, part, true)
+        end
+        # At last - draw it!
+        @gosu_images[x][y].draw(x * TILE_SIZE, y * TILE_SIZE, 0)
+      end
+    end
+  end
+
+  # Radius of a crater.
+  RADIUS = 25
+  # Radius of a crater, SHadow included.
+  SH_RADIUS = 45
+  
+  def blast(x, y)
+    # This code assumes at most 2x2 tiles are affected by a blast, so
+    # don't change the RADIUS to 200 or something ;)
+    # Calculate the x/y indices of the two to four affected tiles.
+    # (left/right and top/bottom might be the same).
+    
+    left = (x - SH_RADIUS) / TILE_SIZE
+    right = (x + SH_RADIUS) / TILE_SIZE
+    top = (y - SH_RADIUS) / TILE_SIZE
+    bottom = (y + SH_RADIUS) / TILE_SIZE
+
+    # Set affected images to nil.
+    # A 'double-free' doesn't hurt if e.g. left == right! However, we have to watch out
+    # for out-of-bounds errors.
+    
+    @gosu_images[left][top] = nil unless left < 0 or top < 0
+    @gosu_images[right][top] = nil unless right >= TILES_X or top < 0
+    @gosu_images[left][bottom] = nil unless left < 0 or bottom >= TILES_Y
+    @gosu_images[right][bottom] = nil unless right >= TILES_X or bottom >= TILES_Y
+
+    # Create the crater image (basically a circle shape that is used to erase
+    # parts of the map) and the crater shadow image, if they don't exist
+    # already.
+    
+    if @crater_image.nil? then
+      @crater_image = Magick::Image.new(2 * RADIUS, 2 * RADIUS) { self.background_color = 'none' }
+      gc = Magick::Draw.new
+      gc.fill('black').circle(RADIUS, RADIUS, RADIUS, 0)
+      gc.draw(@crater_image)
+      @crater_shadow = @crater_image.shadow(0, 0, (SH_RADIUS - RADIUS) / 2, 1)
+    end
+    
+    # Draw the shadow (twice for more intensity), then erase a circle from the map.
+    @image.composite!(@crater_shadow, x - SH_RADIUS, y - SH_RADIUS, Magick::AtopCompositeOp)
+    @image.composite!(@crater_shadow, x - SH_RADIUS, y - SH_RADIUS, Magick::AtopCompositeOp)
+    @image.composite!(@crater_image, x - RADIUS, y - RADIUS, Magick::DstOutCompositeOp)
+  end
+end
+
+# Player class.
+# Note that applies to the whole game:
+# All objects implement an informal interface.
+# draw: Draws the object (obviously)
+# update: Moves the object etc., returns false if the object is to be deleted
+# hit_by?(missile): Returns true if an object is hit by the missile, causing
+#                   it to explode on this object. 
+
+class Player
+  # Magic numbers considered harmful! This is the height of the
+  # player as used for collision detection.
+  HEIGHT = 14
+  
+  attr_reader :x, :y, :dead
+  
+  def initialize(window, x, y, color)
+    # Only load the images once for all instances of this class.
+    @@images ||= Gosu::Image.load_tiles(window, "media/Soldier.png", 40, 50, false)
+    
+    @window, @x, @y, @color = window, x, y, color
+    @vy = 0
+    
+    # -1: left, +1: right
+    @dir = -1
+
+    # Aiming angle.
+    @angle = 90
+  end
+  
+  def draw
+    if dead then
+      # Poor, broken soldier.
+      @@images[0].draw_rot(x, y, 0, 290 * @dir, 0.5, 0.65, @dir * 0.5, 0.5, @color)
+      @@images[2].draw_rot(x, y, 0, 160 * @dir, 0.95, 0.5, 0.5, @dir * 0.5, @color)
+    else
+      # Was moved last frame?
+      if @show_walk_anim
+        # Yes: Display walking animation.
+        frame = Gosu::milliseconds / 200 % 2
+      else
+        # No: Stand around (boring).
+        frame = 0
+      end
+      
+      # Draw feet, then chest.
+      @@images[frame].draw(x - 10 * @dir, y - 20, 0, @dir * 0.5, 0.5, @color)
+      angle = @angle
+      angle = 180 - angle if @dir == -1
+      @@images[2].draw_rot(x, y - 5, 0, angle, 1, 0.5, 0.5, @dir * 0.5, @color)
+    end
+  end
+  
+  def update
+    # First, assume that no walking happened this frame.
+    @show_walk_anim = false
+    
+    # Gravity.
+    @vy += 1
+    
+    if @vy > 1 then
+      # Move upwards until hitting something.
+      @vy.times do
+        if @window.map.solid?(x, y + 1)
+          @vy = 0
+          break
+        else
+          @y += 1
+        end
+      end
+    else
+      # Move downwards until hitting something.
+      (-@vy).times do
+        if @window.map.solid?(x, y - HEIGHT - 1)
+          @vy = 0
+          break
+        else
+          @y -= 1
+        end
+      end
+    end
+    
+    # Soldiers are never deleted (they may die, though, but that is a different
+    # concept).
+    true
+  end
+  
+  def aim_up
+    @angle -= 2 unless @angle < 10
+  end
+  
+  def aim_down
+    @angle += 2 unless @angle > 170
+  end
+  
+  def try_walk(dir)
+    @show_walk_anim = true
+    @dir = dir
+    # First, magically move up (so soldiers can run up hills)
+    2.times { @y -= 1 unless @window.map.solid?(x, y - HEIGHT - 1) }
+    # Now move into the desired direction.
+    @x += dir unless @window.map.solid?(x + dir, y) or
+                     @window.map.solid?(x + dir, y - HEIGHT) 
+    # To make up for unnecessary movement upwards, sink downward again.
+    2.times { @y += 1 unless @window.map.solid?(x, y + 1) }
+  end
+  
+  def try_jump
+    @vy = -12 if @window.map.solid?(x, y + 1)
+  end
+  
+  def shoot
+    @window.objects << Missile.new(@window, x + 10 * @dir, y - 10, @angle * @dir)
+  end
+  
+  def hit_by?(missile)
+    if Gosu::distance(missile.x, missile.y, x, y) < 30 then
+      # Was hit :(
+      @dead = true
+      return true
+    else
+      return false
+    end    
+  end
+end
+
+# Implements the same interface as Player, except it'S a missile!
+
+class Missile
+  attr_reader :x, :y, :vx, :vy
+  
+  def initialize(window, x, y, angle)
+    # All missile instances use the same sound.
+    @@explosion_sound ||= Gosu::Sample.new(window, "media/Explosion.wav")
+    
+    # Horizontal/vertical velocity.
+    @vx, @vy = Gosu::offset_x(angle, 20).to_i, Gosu::offset_y(angle, 20).to_i
+    
+    @window, @x, @y = window, x + @vx, y + @vy
+  end
+  
+  def update
+    # Movement, gravity
+    @x += @vx
+    @y += @vy
+    @vy += 1
+    # Hit anything?
+    if @window.map.solid?(x, y) or @window.objects.any? { |o| o.hit_by?(self) } then
+      # Create great particles.
+      5.times { @window.objects << Particle.new(@window, x - 25 + rand(51), y - 25 + rand(51)) }
+      @window.map.blast(x, y)
+      # Weeee, stereo sound!
+      @@explosion_sound.play_pan((2 * @x - Map::WIDTH) / Map::WIDTH)
+      return false
+    else
+      return true
+    end
+  end
+  
+  def draw
+    # Just draw a small quad.
+    @window.draw_quad(x-2, y-2, 0xff800000, x+2, y-2, 0xff800000, 
+      x-2, y+2, 0xff800000, x+2, y+2, 0xff800000, 0)
+  end
+  
+  def hit_by?(missile)
+    # Missiles can't be hit by other missiles!
+    false
+  end
+end
+
+# Very minimal object that just draws a fading particle.
+
+class Particle
+  def initialize(window, x, y)
+    # All Particle instances use the same image
+    @@image ||= Gosu::Image.new(window, 'media/Smoke.png', false)
+    
+    @x, @y = x, y
+    @color = Gosu::Color.new(255, 255, 255, 255)
+  end
+  
+  def update
+    @y -= 5
+    @x = @x - 1 + rand(3)
+    @color.alpha -= 5
+    
+    # Remove if faded completely.
+    @color.alpha > 0
+  end
+  
+  def draw
+    @@image.draw(@x - 25, @y - 25, 0, 1, 1, @color)
+  end
+  
+  def hit_by?(missile)
+    # Smoke can't be hit!
+    false
+  end
+end
+
+# Finally, the class that ties it all together.
+# Very straightforward implementation.
+
+class GameWindow < Gosu::Window
+  attr_reader :map, :objects
+  
+  def initialize()
+    super(800, 600, false)
+    self.caption = "Medal of Anna - Gosu & RMagick Integration Demo"
+
+    # Texts to display in the appropriate situations.
+    @player_instructions = []
+    @player_won_messages = []
+    2.times do |plr|
+      @player_instructions << Gosu::Image.from_text(self,
+        "It is the #{ plr == 0 ? 'green' : 'red' } toy soldier's turn.\n" +
+        "(Arrow keys to walk and aim, Return to jump, Space to shoot)",
+        Gosu::default_font_name, 25, 0, width, :center)
+      @player_won_messages << Gosu::Image.from_text(self,
+        "The #{ plr == 0 ? 'green' : 'red' } toy soldier has won!",
+        Gosu::default_font_name, 25, 5, width, :center)
+    end
+
+    # Create everything!
+    @map = Map.new(self)
+    @players = [Player.new(self, 200, 40, 0xff308000), Player.new(self, 600, 40, 0xff803000)]
+    @objects = @players.dup
+    
+    # Let any player start.
+    @current_player = rand(2)
+    # Currently not waiting for a missile to hit something.
+    @waiting = false
+  end
+  
+  def draw
+    # Draw the main game.
+    @map.draw
+    @objects.each { |o| o.draw }
+    
+    # If any text should be displayed, draw it - and add a nice black border around it
+    # by drawing it four times, with a little offset in each direction.
+    
+    cur_text = @player_instructions[@current_player] if not @waiting
+    cur_text = @player_won_messages[1 - @current_player] if @players[@current_player].dead
+    
+    if cur_text then
+      x, y = 0, 30
+      cur_text.draw(x - 1, y, 0, 1, 1, 0xff000000)
+      cur_text.draw(x + 1, y, 0, 1, 1, 0xff000000)
+      cur_text.draw(x, y - 1, 0, 1, 1, 0xff000000)
+      cur_text.draw(x, y + 1, 0, 1, 1, 0xff000000)
+      cur_text.draw(x, y, 0, 1, 1, 0xffffffff)
+    end
+  end
+  
+  def update
+    # if waiting for the next player's turn, continue to do so until the missile has
+    # hit something.
+    @waiting &&= !@objects.grep(Missile).empty?
+     
+    # Remove all objects whose update method returns false. 
+    @objects.reject! { |o| o.update == false }
+
+    # If it's a player's turn, forward controls.
+    if not @waiting and not @players[@current_player].dead then
+      player = @players[@current_player]
+      player.aim_up if button_down? Gosu::KbUp
+      player.aim_down if button_down? Gosu::KbDown
+      player.try_walk(-1) if button_down? Gosu::KbLeft
+      player.try_walk(1) if button_down? Gosu::KbRight
+      player.try_jump if button_down? Gosu::KbReturn
+    end
+  end
+  
+  def button_down(id)
+    if id == Gosu::KbSpace and not @waiting and not @players[@current_player].dead then
+      # Shoot! This is handled in button_down because holding space shouldn't
+      # auto-fire - the shots would come from different players.
+      @players[@current_player].shoot
+      @current_player = 1 - @current_player
+      @waiting = true
+    end
+    # Very important feature! ;)
+    close if id == Gosu::KbEscape
+  end
+end
+
+# So far we have only defined how everything *should* work - now set it up and run it!
+GameWindow.new.show

data/examples/TextInput.cpp

@@ -0,0 +1,170 @@
+// This example demonstrates the use of the TextInput functionality.
+// One can tab through, or click into the text fields and change it's contents.
+
+// At its most basic form, you only need to create a new TextInput instance and
+// pass it to your window via setTextInput. Until you call this function again,
+// passing 0, the TextInput object will build a text that can be accessed via
+// TextInput::text().
+
+// The TextInput object also maintains the position of the caret as the index
+// of the character that it's left to via the caretPos() member function.
+// Furthermore, if there is a selection, the selectionStart() member yields its
+// beginning, using the same indexing scheme. If there is no selection,
+// selectionStart() is equal to caretPos().
+
+// A TextInput object is purely abstract, though; drawing the input field is left
+// to the user. In this case, we are subclassing TextInput to add this code.
+// As with most of Gosu, how this is handled is completely left open; the scheme
+// presented here is not mandatory! Gosu only aims to provide enough code for
+// games (or intermediate UI toolkits) to be built upon it.
+
+#include <Gosu/Gosu.hpp>
+#include <boost/scoped_ptr.hpp>
+
+class TextField : public Gosu::TextInput
+{
+    Gosu::Window& window;
+    Gosu::Font& font;
+    double x, y;
+    
+public:
+    // Some constants that define our appearance.
+    // (Can't use Gosu::Color that easily as a class constant, thanks to C++.)
+    static const unsigned long INACTIVE_COLOR  = 0xcc666666;
+    static const unsigned long ACTIVE_COLOR    = 0xccff6666;
+    static const unsigned long SELECTION_COLOR = 0xcc0000ff;
+    static const unsigned long CARET_COLOR     = 0xffffffff;
+    static const int PADDING = 5;
+    
+    TextField(Gosu::Window& window, Gosu::Font& font, double x, double y)
+    : window(window), font(font), x(x), y(y)
+    {
+        // Start with a self-explanatory text in each field.
+        setText(L"Click to change text");
+    }
+    
+    void draw() const
+    {
+        // Depending on whether this is the currently selected input or not, change the
+        // background's color.
+        Gosu::Color backgroundColor;
+        if (window.input().textInput() == this)
+            backgroundColor = ACTIVE_COLOR;
+        else
+            backgroundColor = INACTIVE_COLOR;
+        window.graphics().drawQuad(x - PADDING,           y - PADDING,            backgroundColor,
+                                   x + width() + PADDING, y - PADDING,            backgroundColor,
+                                   x - PADDING,           y + height() + PADDING, backgroundColor,
+                                   x + width() + PADDING, y + height() + PADDING, backgroundColor, 0);
+    
+        // Calculate the position of the caret and the selection start.
+        double posX = x + font.textWidth(text().substr(0, caretPos()));
+        double selX = x + font.textWidth(text().substr(0, selectionStart()));
+
+        // Draw the selection background, if any; if not, sel_x and pos_x will be
+        // the same value, making this quad empty.
+        window.graphics().drawQuad(selX, y,            SELECTION_COLOR,
+                                   posX, y,            SELECTION_COLOR,
+                                   selX, y + height(), SELECTION_COLOR,
+                                   posX, y + height(), SELECTION_COLOR, 0);
+
+        // Draw the caret; again, only if this is the currently selected field.
+        if (window.input().textInput() == this)
+          window.graphics().drawLine(posX, y,            CARET_COLOR,
+                                     posX, y + height(), CARET_COLOR, 0);
+
+        // Finally, draw the text itself!
+        font.draw(text(), x, y, 0);
+    }
+    
+    // This text field grows with the text that's being entered.
+    // (Without clipping, one has to be a bit creative about this ;) )
+    double width() const
+    {
+        return font.textWidth(text());
+    }
+    
+    double height() const
+    {
+        return font.height();
+    }
+    
+    bool isUnderPoint(double mouseX, double mouseY)
+    {
+        return mouseX > x - PADDING && mouseX < x + width() + PADDING &&
+            mouseY > y - PADDING and mouseY < y + height() + PADDING;
+    }
+};
+
+// Helper magic to get size of static array, MUCH safer than sizeof hackery.
+template<typename T, std::size_t Len>
+std::size_t lengthof(const T(&) [Len])
+{
+    return Len;
+}
+
+class TextInputWindow : public Gosu::Window
+{
+    boost::scoped_ptr<Gosu::Font> font;
+    boost::scoped_ptr<TextField> textFields[3];
+    boost::scoped_ptr<Gosu::Image> cursor;
+
+public:
+    TextInputWindow()
+    : Gosu::Window(300, 200, false)
+    {
+        setCaption(L"Text Input Example");
+    
+        font.reset(new Gosu::Font(graphics(), Gosu::defaultFontName(), 20));
+        
+        for (int index = 0; index < lengthof(textFields); ++index)
+            textFields[index].reset(new TextField(*this, *font, 50, 30 + index * 50));
+        
+        cursor.reset(new Gosu::Image(graphics(), L"media/Cursor.png", false));
+    }
+
+    void draw()
+    {
+        for (int i = 0; i < lengthof(textFields); ++i)
+            textFields[i]->draw();
+            
+        cursor->draw(input().mouseX(), input().mouseY(), 0);
+    }
+  
+    void buttonDown(Gosu::Button btn)
+    {
+        if (btn == Gosu::kbTab)
+        {
+            // Tab key will not be 'eaten' by text fields; use for switching through
+            // text fields.
+            int index = -1;
+            for (int i = 0; i < lengthof(textFields); ++i)
+                if (input().textInput() == textFields[i].get())
+                    index = i;
+            input().setTextInput(textFields[(index + 1) % lengthof(textFields)].get());
+        }
+        else if (btn == Gosu::kbEscape)
+        {
+            // Escape key will not be 'eaten' by text fields; use for deselecting.
+            if (input().textInput())
+                input().setTextInput(0);
+            else
+                close();
+        }
+        else if (btn == Gosu::msLeft)
+        {
+            // Mouse click: Select text field based on mouse position.
+            input().setTextInput(0);
+            for (int i = 0; i < lengthof(textFields); ++i)
+                if (textFields[i]->isUnderPoint(input().mouseX(), input().mouseY()))
+                    input().setTextInput(textFields[i].get());
+        }
+    }
+};
+
+int main(int argc, char* argv[])
+{
+    TextInputWindow win;
+    win.show();
+    return 0;
+}