zyps 0.6.3 → 0.7.0

data/lib/zyps/views/canvas/gtk2.rb

@@ -0,0 +1,152 @@
+# Copyright 2007 Jay McGavren, jay@mcgavren.com.
+# 
+# This file is part of Zyps.
+# 
+# Zyps is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+require 'gtk2'
+
+
+module Zyps
+
+
+#Called by View objects for use in Ruby-GNOME2 applications.
+#Assign an instance to a View, then add the drawing_area attribute to a GUI container object.
+#The drawing area will be updated whenever the View is.
+class GTK2Canvas
+
+
+	#A Gtk::DrawingArea that will be painted on.
+	attr_reader :drawing_area
+	#Dimensions of the drawing area.
+	#Control should normally be left to the owner View object.
+	attr_reader :width, :height
+
+	def initialize
+	
+		#Will be resized later.
+		@width = 1
+		@height = 1
+
+		#Create a drawing area.
+		@drawing_area = Gtk::DrawingArea.new
+		#Set to correct size.
+		resize
+		
+		#Whenever the drawing area needs updating...
+		@drawing_area.signal_connect("expose_event") do
+			#Copy buffer bitmap to canvas.
+			@drawing_area.window.draw_drawable(
+				@drawing_area.style.fg_gc(@drawing_area.state), #Gdk::GC (graphics context) to use when drawing.
+				buffer, #Gdk::Drawable source to copy onto canvas.
+				0, 0, #Pull from upper left of source.
+				0, 0, #Copy to upper left of canvas.
+				-1, -1 #-1 width and height signals to copy entire source over.
+			)
+		end
+		
+	end
+
+	def width= (pixels) #:nodoc:
+		@width = pixels
+		resize
+	end
+	
+	def height= (pixels) #:nodoc:
+		@height = pixels
+		resize
+	end
+	
+	
+	#Takes a hash with these keys and defaults:
+	#	:color => nil
+	#	:border_width => 1
+	#	:filled => true
+	#	:x => nil
+	#	:y => nil
+	#	:width => nil
+	#	:height => nil
+	def draw_rectangle(options = {})
+		options = {
+			:filled => true
+		}.merge(options)
+		graphics_context = Gdk::GC.new(buffer)
+		graphics_context.rgb_fg_color = convert_color(options[:color])
+		buffer.draw_rectangle(
+			graphics_context,
+			options[:filled],
+			options[:x], options[:y],
+			options[:width], options[:height]
+		)
+	end
+
+	
+	#Takes a hash with these keys and defaults:
+	#	:color => nil
+	#	:width => nil
+	#	:x1 => nil
+	#	:y1 => nil
+	#	:x2 => nil
+	#	:y2 => nil
+	def draw_line(options = {})
+		graphics_context = Gdk::GC.new(buffer)
+		graphics_context.rgb_fg_color = convert_color(options[:color])
+		graphics_context.set_line_attributes(
+			options[:width].ceil,
+			Gdk::GC::LINE_SOLID,
+			Gdk::GC::CAP_ROUND,
+			Gdk::GC::JOIN_MITER #Only used for polygons.
+		)
+		buffer.draw_line(
+			graphics_context,
+			options[:x1], options[:y1],
+			options[:x2], options[:y2]
+		)
+	end
+	
+	
+	#Draw all objects to the drawing area.
+	def render
+		@drawing_area.queue_draw_area(0, 0, @width, @height)
+	end
+				
+	
+	private
+	
+		#Converts a Zyps Color to a Gdk::Color.
+		def convert_color(color)
+			Gdk::Color.new(
+				color.red * 65535,
+				color.green * 65535,
+				color.blue * 65535
+			)
+		end
+	
+	
+		def resize
+			@drawing_area.set_size_request(@width, @height)
+			@buffer = nil #Causes buffer to reset its size next time it's accessed.
+		end
+	
+		
+		def buffer
+			@buffer ||= Gdk::Pixmap.new(@drawing_area.window, @width, @height, -1)
+		end
+	
+	
+end
+
+
+end #module Zyps

data/lib/zyps/views/canvas/wx.rb

@@ -0,0 +1,191 @@
+# Copyright 2007 Jay McGavren, jay@mcgavren.com.
+# 
+# This file is part of Zyps.
+# 
+# Zyps is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+require 'wx'
+
+
+module Zyps
+
+
+#Called by View objects for use in wxRuby applications.
+#Assign an instance to a View, then add the drawing_area attribute to a GUI container object.
+#The drawing area will be updated whenever the View is.
+class WxCanvas
+
+
+	#A wxWidgets window that will be painted on.
+	attr_reader :drawing_area
+	#Dimensions of the drawing area.
+	#Control should normally be left to the owner View object.
+	attr_reader :width, :height
+
+	#Takes the wxRuby GUI object that will be its parent.
+	def initialize (parent)
+	
+		#Will be resized later.
+		@width = 1
+		@height = 1
+
+		#Create a drawing area.
+		@drawing_area = Wx::Window.new(parent)
+		#Set to correct size.
+		resize
+		
+		#Whenever the drawing area needs updating...
+		@drawing_area.evt_paint do |event|
+			render
+		end
+		
+		#Arrays of shapes that will be painted when render() is called.
+		@rectangle_queue = []
+		@line_queue = []
+		
+		#Hash of Wx::Pens used to draw in various colors and widths.
+		@pens = Hash.new {|h, k| h[k] = Hash.new}
+		#Hash of Wx::Brushes for various colors.
+		@brushes = Hash.new
+		
+	end
+
+	def width= (pixels) #:nodoc:
+		@width = pixels
+		resize
+	end
+	
+	def height= (pixels) #:nodoc:
+		@height = pixels
+		resize
+	end
+	
+	
+	#Takes a hash with these keys and defaults:
+	#	:color => nil
+	#	:border_width => 1
+	#	:filled => true
+	#	:x => nil
+	#	:y => nil
+	#	:width => nil
+	#	:height => nil
+	def draw_rectangle(options = {})
+		options = {
+			:filled => true,
+			:border_width => 1
+		}.merge(options)
+		@rectangle_queue << options
+	end
+
+	
+	
+	#Takes a hash with these keys and defaults:
+	#	:color => nil
+	#	:width => nil
+	#	:x1 => nil
+	#	:y1 => nil
+	#	:x2 => nil
+	#	:y2 => nil
+	def draw_line(options = {})
+		@line_queue << options
+	end
+		
+	
+	#Draw all objects to the drawing area.
+	def render
+		buffer.draw do |surface|
+			#Draw all queued rectangles.
+			render_rectangles(surface)
+			#Draw all queued lines.
+			render_lines(surface)
+		end
+		#Copy offscreen bitmap to screen.
+		@drawing_area.paint do |dc|
+			#Copy the buffer to the viewable window.
+			dc.draw_bitmap(buffer, 0, 0, false)
+		end
+	end
+				
+	
+	private
+
+	
+		#Converts a Zyps Color to the toolkit's color class.
+		def convert_color(color)
+			Wx::Colour.new(
+				(color.red * 255).floor,
+				(color.green * 255).floor,
+				(color.blue * 255).floor
+			)
+		end
+	
+	
+		#Resize buffer and drawing area.
+		def resize
+			@drawing_area.set_size(Wx::Size.new(@width, @height))
+			@buffer = nil #Causes buffer to reset its size next time it's accessed.
+		end
+	
+		
+		#The Wx::Bitmap to draw to.
+		def buffer
+			@buffer ||= Wx::Bitmap.new(@width, @height)
+		end
+
+		
+		#Draw all queued rectangles to the given GC.
+		def render_rectangles(surface)
+			while options = @rectangle_queue.shift do
+				surface.pen = get_pen(options[:color], options[:border_width]) #Used for border.
+				if options[:filled]
+					surface.brush = get_brush(options[:color])
+				else
+					surface.brush = Wx::TRANSPARENT_BRUSH
+				end
+				surface.draw_rectangle(
+					options[:x], options[:y],
+					options[:width], options[:height]
+				)
+			end
+		end
+
+			
+		#Draw all queued lines to the given GC.
+		def render_lines(surface)
+			surface.pen.cap = Wx::CAP_ROUND
+			while options = @line_queue.shift do
+				surface.pen = get_pen(options[:color], options[:width])
+				surface.draw_line(
+					options[:x1].floor, options[:y1].floor,
+					options[:x2].floor, options[:y2].floor
+				)
+			end
+		end
+		
+		
+		def get_pen(color, width)
+			@pens[[color.red, color.green, color.blue]][width] ||= Wx::Pen.new(convert_color(color), width.ceil)
+		end
+
+
+		def get_brush(color)
+			@brushes[[color.red, color.green, color.blue]] ||= Wx::Brush.new(convert_color(color), Wx::SOLID)
+		end
+
+		
+end
+
+
+end #module Zyps

data/lib/zyps/views/trails.rb

@@ -16,7 +16,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-require 'gtk2'
+require 'zyps'
 
 
 module Zyps
@@ -25,39 +25,44 @@ module Zyps
 #A view of game objects.
 class TrailsView
 
-	#A Gtk::DrawingArea to render objects on.
+	#A GUI toolkit-specific drawing area that will be used to render the view.
+	#See WxCanvas and GTK2Canvas.
 	attr_reader :canvas
 	#Dimensions of the view.
 	attr_reader :width, :height
 	#Number of line segments to draw for each object.
 	attr_accessor :trail_length
+	#Whether view should be erased before re-drawing.
+	attr_accessor :erase_flag
 
-	def initialize (width = 600, height = 400, trail_length = 5)
+	#Takes a hash with these keys and defaults:
+	#	:canvas => nil
+	#	:width => 600
+	#	:height => 400
+	#	:trail_length => 5
+	#	:erase_flag => true
+	def initialize (options = {})
 	
-		@width, @height, @trail_length, = width, height, trail_length
-	
-		#Create a drawing area.
-		@canvas = Gtk::DrawingArea.new
-		#Set to correct size.
-		resize
-		
-		#Whenever the drawing area needs updating...
-		@canvas.signal_connect("expose_event") do
-			#Copy buffer bitmap to canvas.
-			@canvas.window.draw_drawable(
-				@canvas.style.fg_gc(@canvas.state), #Gdk::GC (graphics context) to use when drawing.
-				buffer, #Gdk::Drawable source to copy onto canvas.
-				0, 0, #Pull from upper left of source.
-				0, 0, #Copy to upper left of canvas.
-				-1, -1 #-1 width and height signals to copy entire source over.
-			)
-		end
+		options = {
+			:width => 600,
+			:height => 400,
+			:trail_length => 5,
+			:erase_flag => true
+		}.merge(options)
+		@width = options[:width]
+		@height = options[:height]
+		@trail_length = options[:trail_length]
+		@erase_flag = options[:erase_flag]
+		@canvas = options[:canvas]
 		
+		#Set canvas's size to match view's.
+		resize if @canvas
+	
 		#Track a list of locations for each object.
 		@locations = Hash.new {|h, k| h[k] = Array.new}
 		
 	end
-	
+
 	def width= (pixels) #:nodoc:
 		@width = pixels
 		resize
@@ -66,7 +71,12 @@ class TrailsView
 		@height = pixels
 		resize
 	end
-
+	def canvas= (canvas) #:nodoc:
+		@canvas = canvas
+		resize
+	end
+	
+	
 	#Takes an Environment, and draws it to the canvas.
 	#Tracks the position of each GameObject over time so it can draw a trail behind it.
 	#The head will match the object's Color exactly, fading to black at the tail.
@@ -74,14 +84,14 @@ class TrailsView
 	def update(environment)
 	
 		#Clear the background on the buffer.
-		graphics_context = Gdk::GC.new(buffer)
-		graphics_context.rgb_fg_color = Gdk::Color.new(0, 0, 0)
-		buffer.draw_rectangle(
-			graphics_context,
-			true, #Filled.
-			0, 0, #Lower-left corner.
-			@width, @height #Upper-right corner.
-		)
+		if @erase_flag
+			@canvas.draw_rectangle(
+				:color => Color.new(0, 0, 0),
+				:filled => true,
+				:x => 0, :y => 0,
+				:width => @width, :height => @height
+			)
+		end
 		
 		#For each GameObject in the environment:
 		environment.objects.each do |object|
@@ -91,7 +101,7 @@ class TrailsView
 			#Add the object's current location to the list.
 			@locations[object.identifier] << [object.location.x, object.location.y]
 			#If the list is larger than the number of tail segments, delete the first position.
-			@locations[object.identifier].shift if @locations[object.identifier].length > @trail_length
+			@locations[object.identifier].shift while @locations[object.identifier].length > @trail_length
 			
 			#For each location in this object's list:
 			@locations[object.identifier].each_with_index do |location, index|
@@ -102,50 +112,37 @@ class TrailsView
 				#Divide the current segment number by trail segment count to get the multiplier to use for brightness and width.
 				multiplier = index.to_f / @locations[object.identifier].length.to_f
 				
-				#Set the drawing color to use the object's colors, adjusted by the multiplier.
-				graphics_context.rgb_fg_color = Gdk::Color.new( #Don't use Gdk::GC.foreground= here, as that requires a color to be in the color map already.
-					object.color.red * multiplier * 65535,
-					object.color.green * multiplier * 65535,
-					object.color.blue * multiplier * 65535
-				)
-				
-				#Multiply the actual drawing width by the current multiplier to get the current drawing width.
-				graphics_context.set_line_attributes(
-					(object_radius * 2 * multiplier).ceil,
-					Gdk::GC::LINE_SOLID,
-					Gdk::GC::CAP_ROUND, #Line ends drawn as semicircles.
-					Gdk::GC::JOIN_MITER #Only used for polygons.
-				)
-				
 				#Get previous location so we can draw a line from it.
 				previous_location = @locations[object.identifier][index - 1]
 				
-				#Draw a line with the current width from the prior location to the current location.
-				buffer.draw_line(
-					graphics_context,
-					previous_location[0], previous_location[1],
-					location[0], location[1]
+				@canvas.draw_line(
+					:color => Color.new(
+						object.color.red * multiplier,
+						object.color.green * multiplier,
+						object.color.blue * multiplier
+					),
+					:width => object_radius * 2 * multiplier,
+					:x1 => previous_location[0], :y1 => previous_location[1],
+					:x2 => location[0], :y2 => location[1]
 				)
 				
 			end
 			
 		end
 		
-		@canvas.queue_draw_area(0, 0, @width, @height)
+		@canvas.render
 		
 	end
 	
 	
 	private
 	
+
 		def resize
-			@canvas.set_size_request(@width, @height)
-			@buffer = nil #Causes buffer to reset its size next time it's accessed.
-		end
-		
-		def buffer
-			@buffer ||= Gdk::Pixmap.new(@canvas.window, @width, @height, -1)
+			@canvas.width = @width
+			@canvas.height = @height
 		end
+
 	
 end