rubygame 2.2.0-mswin32

data/lib/rubygame/color/models/hsl.rb

@@ -0,0 +1,153 @@
+#--
+#	Rubygame -- Ruby code and bindings to SDL to facilitate game creation
+#	Copyright (C) 2007  John Croisant
+#
+#	This library 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 2.1 of the License, or (at your option) any later version.
+#
+#	This library 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
+#	Lesser General Public License for more details.
+#
+#	You should have received a copy of the GNU Lesser General Public
+#	License along with this library; if not, write to the Free Software
+#	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+require 'rubygame/color/models/base'
+
+module Rubygame
+	module Color
+
+		# Represents color in the HSL (Hue, Saturation, Luminosity) color space.
+		class ColorHSL
+			include ColorBase
+			
+			attr_reader :h, :s, :l, :a
+
+			# call-seq:
+			#   new( [h,s,l,a] )  ->  ColorHSL
+			#   new( [h,s,l] )  ->  ColorHSL
+			#   new( color )  ->  ColorHSL
+			# 
+			# Create a new instance from an Array or an existing color
+			# (of any type). If the alpha (opacity) component is omitted
+			# from the array, full opacity will be used.
+			# 
+			# All color components range from 0.0 to 1.0.
+			# 
+			def initialize( color )
+				if color.kind_of?(Array)
+					@h, @s, @l, @a = color.collect { |i| i.to_f }
+					@a = 1.0 unless @a
+				elsif color.respond_to?(:to_rgba_ary)
+					@h, @s, @l, @a = self.class.rgba_to_hsla( *color.to_rgba_ary )
+				end
+			end
+
+			# Return an Array with the red, green, blue, and alpha components
+			# of the color (converting the color to the RGBA model first).
+			def to_rgba_ary
+				return self.class.hsla_to_rgba( @h, @s, @l, @a )
+			end
+			
+			def to_s
+				"#<#{self.class} [#{@h}, #{@s}, #{@l}, #{@a}]>"
+			end
+			alias :inspect :to_s
+			
+			class << self
+
+				def new_from_rgba( rgba )
+					new( rgba_to_hsla(*rgba) )
+				end
+				
+				def new_from_sdl_rgba( rgba )
+					new_from_rgba( rgba.collect { |i| i / 255.0 } )
+				end
+				
+				# Convert the red, green, blue, and alpha to the
+				# equivalent hue, saturation, luminosity, and alpha.
+				def rgba_to_hsla( r, g, b, a ) # :nodoc:
+					rgb_arr = [r, g, b]
+					max     = rgb_arr.max
+					min     = rgb_arr.min
+
+					# Calculate lightness.
+					l = (max + min) / 2.0
+
+					# Calculate saturation.
+					if l == 0.0 or max == min
+						s = 0
+					elsif 0 < l and l <= 0.5 
+						s = (max - min) / (max + min)
+					else # l > 0.5
+						s = (max - min) / (2 - (max + min))
+					end
+					
+					# Calculate hue.
+					if min == max 
+						h = 0 
+						# Undefined in this case, but set it to zero
+					elsif max == r and g >= b
+						h = (1.quo(6) * (g - b) / (max - min)) + 0
+					elsif max == r and g < b
+						h = (1.quo(6) * (g - b) / (max - min)) + 1.0
+					elsif max == g
+						h = (1.quo(6) * (b - r) / (max - min)) + 1.quo(3)
+					elsif max == b
+						h = (1.quo(6) * (r - g) / (max - min)) + 2.quo(3)
+					else 
+						raise "Should never happen"
+					end 
+					
+					return [h,s,l,a]
+				end
+				
+				# Convert the hue, saturation, luminosity, and alpha
+				# to the equivalent red, green, blue, and alpha.
+				def hsla_to_rgba( h, s, l, a ) # :nodoc:
+					# If the color is achromatic, return already with the lightness value for all components
+					if s == 0.0
+						return [l, l, l, a]
+					end
+
+					# Otherwise, we have to do the long, hard calculation
+
+					# q helper value
+					q = (l < 0.5) ? (l * (1.0 + s)) : (l + s - l * s)
+
+					# p helper value
+					p = (2.0 * l) - q
+
+					r = calculate_component( p, q, h + 1.quo(3) )
+					g = calculate_component( p, q, h            )
+					b = calculate_component( p, q, h - 1.quo(3) )
+
+					return [r,g,b,a]
+				end
+
+				private
+				
+				# Perform some arcane math to calculate a color component.
+				def calculate_component(p, q, tc) # :nodoc:
+					tc %= 1.0
+					if tc < 1.quo(6)
+						p + (q - p) * tc * 6.0
+					elsif tc < 0.5
+						q
+					elsif tc < 2.quo(3)
+						p + (q - p) * (2.quo(3) - tc) * 6.0
+					else
+						p 
+					end
+				end
+				
+			end
+
+		end
+	end
+end

data/lib/rubygame/color/models/hsv.rb

@@ -0,0 +1,149 @@
+#--
+#	Rubygame -- Ruby code and bindings to SDL to facilitate game creation
+#	Copyright (C) 2007  John Croisant
+#
+#	This library 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 2.1 of the License, or (at your option) any later version.
+#
+#	This library 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
+#	Lesser General Public License for more details.
+#
+#	You should have received a copy of the GNU Lesser General Public
+#	License along with this library; if not, write to the Free Software
+#	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+require 'rubygame/color/models/base'
+
+module Rubygame
+	module Color
+
+		# Represents color in the HSV (Hue, Saturation, Value) color space.
+		class ColorHSV
+			include ColorBase
+
+			attr_reader :h, :s, :v, :a
+
+			# call-seq:
+			#   new( [h,s,v,a] )  ->  ColorHSV
+			#   new( [h,s,v] )  ->  ColorHSV
+			#   new( color )  ->  ColorHSV
+			# 
+			# Create a new instance from an Array or an existing color
+			# (of any type). If the alpha (opacity) component is omitted
+			# from the array, full opacity will be used.
+			# 
+			# All color components range from 0.0 to 1.0.
+			# 
+			def initialize( color )
+				if color.kind_of?(Array)
+					@h, @s, @v, @a = color.collect { |i| i.to_f }
+					@a = 1.0 unless @a
+				elsif color.respond_to?(:to_rgba_ary)
+					@h, @s, @v, @a = self.class.rgba_to_hsva( *color.to_rgba_ary )
+				end
+			end
+			
+			# Return an Array with the red, green, blue, and alpha components
+			# of the color (converting the color to the RGBA model first).
+			def to_rgba_ary
+				return self.class.hsva_to_rgba( @h, @s, @v, @a )
+			end
+			
+			def to_s
+				"#<#{self.class} [#{@h}, #{@s}, #{@v}, #{@a}]>"
+			end
+			alias :inspect :to_s
+			
+			class << self
+				
+				def new_from_rgba( rgba )
+					new( rgba_to_hsva(*rgba) )
+				end
+				
+				def new_from_sdl_rgba( rgba )
+					new_from_rgba( rgba.collect { |i| i / 255.0 } )
+				end
+				
+				# Convert the red, green, blue, and alpha to the
+				# equivalent hue, saturation, value, and alpha.
+				def rgba_to_hsva( r, g, b, a ) # :nodoc:
+					rgb_arr = [r, g, b]
+					max     = rgb_arr.max
+					min     = rgb_arr.min
+
+					# Calculate hue.
+					if min == max 
+						h = 0 
+						# Undefined in this case, but set it to zero
+					elsif max == r and g >= b
+						h = (1.quo(6) * (g - b) / (max - min)) + 0
+					elsif max == r and g < b
+						h = (1.quo(6) * (g - b) / (max - min)) + 1.0
+					elsif max == g
+						h = (1.quo(6) * (b - r) / (max - min)) + 1.quo(3)
+					elsif max == b
+						h = (1.quo(6) * (r - g) / (max - min)) + 2.quo(3)
+					else 
+						raise "Should never happen"
+					end
+
+					# Calulate value.
+					v = max
+
+					# Calculate saturation.
+					if max == 0.0
+						s = 0.0
+					else
+						s = 1.0 - (min / max)
+					end  
+					
+					return [h,s,v,a]
+				end
+
+				# Convert the hue, saturation, value, and alpha
+				# to the equivalent red, green, blue, and alpha.
+				def hsva_to_rgba( h, s, v, a ) # :nodoc:
+					# Determine what part of the "color hexagon" the hue is in.
+					hi = (h * 6).floor % 6
+
+					# Fractional part
+					f  = (h * 6) - hi
+
+					# Helper values
+					p  = v * (1.0 - s)
+					q  = v * (1.0 - (f * s))
+					t  = v * (1.0 - ((1.0 - f) * s))
+
+					# Finally calculate the rgb values
+					r, g, b = calculate_rgb(hi, v, p, t, q)
+
+					return [r, g, b, a]
+				end
+
+				private
+				
+				def calculate_rgb(hi, v, p, t, q) # :nodoc:
+					case hi
+					when 0
+						return v, t, p
+					when 1
+						return q, v, p
+					when 2
+						return p, v, t
+					when 3
+						return p, q, v
+					when 4
+						return t, p, v
+					when 5
+						return v, p, q
+					end
+				end
+			end
+		end
+	end
+end

data/lib/rubygame/color/models/rgb.rb

@@ -0,0 +1,78 @@
+#--
+#	Rubygame -- Ruby code and bindings to SDL to facilitate game creation
+#	Copyright (C) 2007  John Croisant
+#
+#	This library 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 2.1 of the License, or (at your option) any later version.
+#
+#	This library 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
+#	Lesser General Public License for more details.
+#
+#	You should have received a copy of the GNU Lesser General Public
+#	License along with this library; if not, write to the Free Software
+#	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+require 'rubygame/color/models/base'
+
+module Rubygame
+	module Color
+
+		# Represents color in the RGB (Red, Green, Blue) color space.
+		class ColorRGB
+			include ColorBase
+			
+			attr_reader :r, :g, :b, :a
+
+			# call-seq:
+			#   new( [r,g,b,a] )  ->  ColorRGB
+			#   new( [r,g,b] )  ->  ColorRGB
+			#   new( color )  ->  ColorRGB
+			# 
+			# Create a new instance from an Array or an existing color
+			# (of any type). If the alpha (opacity) component is omitted
+			# from the array, full opacity will be used.
+			# 
+			# All color components range from 0.0 to 1.0.
+			# 
+			def initialize( color )
+				if color.kind_of?(Array)
+					@r, @g, @b, @a = color.collect { |i| i.to_f }
+					@a = 1.0 unless @a
+				elsif color.respond_to?(:to_rgba_ary)
+					@r, @g, @b, @a = color.to_rgba_ary
+				end
+			end
+			
+			# Converts the color to an RGBA array of integers 
+			# ranging from 0 to 255, as SDL wants.
+			def to_sdl_rgba_ary
+				self.to_rgba_ary.collect { |i| (i * 255).to_i }
+			end
+			
+			def to_rgba_ary
+				return [@r, @g, @b, @a]
+			end
+			
+			def to_s
+				"#<#{self.class} [#{@r}, #{@g}, #{@b}, #{@a}]>"
+			end
+			alias :inspect :to_s
+			
+			class << self
+				def new_from_rgba( rgba )
+					new( rgba )
+				end
+
+				def new_from_sdl_rgba( rgba )
+					new_from_rgba( rgba.collect { |i| i / 255.0 } )
+				end
+			end
+			
+		end
+	end
+end

data/lib/rubygame/color/palettes/css.rb

@@ -0,0 +1,49 @@
+#--
+#	Rubygame -- Ruby code and bindings to SDL to facilitate game creation
+#	Copyright (C) 2007  John Croisant
+#
+#	This library 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 2.1 of the License, or (at your option) any later version.
+#
+#	This library 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
+#	Lesser General Public License for more details.
+#
+#	You should have received a copy of the GNU Lesser General Public
+#	License along with this library; if not, write to the Free Software
+#	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+require 'rubygame/color'
+require 'rubygame/color/palettes/palette'
+require 'rubygame/color/palettes/x11'
+
+module Rubygame
+	module Color
+
+		# :enddoc:
+		
+		# The CSS module contains all the colors in the CSS/HTML palette
+		# by symbol name, e.g. :alice_blue, :dark_olive_green, etc.
+		# 
+		# NOTE: The CSS palette is identical to the X11 palette except for
+		# four colors: gray, green, maroon, and purple. 
+		# 
+		# Differences between CSS and X11 derived from
+		# http://en.wikipedia.org/wiki/X11_color_names
+		# as accessed on 2007-12-17
+		# 
+		CSS = Palette.new({
+			:gray =>                     ColorRGB.new( [0.50196, 0.50196, 0.50196] ),
+			:green =>                    ColorRGB.new( [0.00000, 0.50196, 0.00000] ),
+			:maroon =>                   ColorRGB.new( [0.50196, 0.00000, 0.00000] ),
+			:purple =>                   ColorRGB.new( [0.50196, 0.00000, 0.50196] )
+		})
+		
+		CSS.include X11
+		
+	end
+end

data/lib/rubygame/color/palettes/palette.rb

@@ -0,0 +1,100 @@
+#--
+#	Rubygame -- Ruby code and bindings to SDL to facilitate game creation
+#	Copyright (C) 2007  John Croisant
+#
+#	This library 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 2.1 of the License, or (at your option) any later version.
+#
+#	This library 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
+#	Lesser General Public License for more details.
+#
+#	You should have received a copy of the GNU Lesser General Public
+#	License along with this library; if not, write to the Free Software
+#	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+class Rubygame::Color::Palette
+
+	# Create a new Palette with the given name => color pairs.
+	def initialize( colors = {} )
+		@includes = []
+		
+		@colors = {}
+		colors.each_pair do |name, color|
+			@colors[sanitize_name(name)] = color
+		end
+	end
+
+	# Retrieve a color by name from this palette.
+	# 
+	# The name can be a Symbol or String. See #sanitize_name.
+	# 
+	# If the color cannot be found in this palette, search
+	# each of the #included palettes (recursively, depth-first,
+	# to a maximum depth of 5 levels).
+	# 
+	# If the color is not found in this palette or any included
+	# palettes, raise IndexError.
+	# 
+	def []( name )
+		c = lookup( sanitize_name( name ) )
+		raise IndexError, "unknown color #{name}" unless c
+		return c
+	end
+	
+	# Store a color by name in this palette. See #sanitize_name
+	def []=( name, color )
+		name = sanitize_name( name )
+		@colors[name] = color
+	end
+	
+	# Include another palette in this one. If a color cannot be
+	# found in this palette, the included palette(s) will be searched.
+	# See also #uninclude.
+	# 
+	# Has no effect if the palette is already included.
+	def include( palette )
+		@includes += [palette] unless @includes.include? palette
+	end
+	
+	# Remove the other palette from this one, so that it won't be
+	# searched for missing colors anymore. Has no effect if the
+	# other palette hasn't been #included.
+	def uninclude( palette )
+		@includes -= [palette]
+	end
+	
+	protected
+
+	# Recursive color lookup
+	def lookup( name, max_depth=5 ) # :nodoc:
+		return nil if max_depth < 0
+
+		color = @colors[name]
+
+		unless color
+			@includes.each { |palette|
+				c = palette.lookup(name, max_depth-1)
+				color = c if c
+			}
+		end
+
+		return color
+	end
+	
+	private
+
+	# Takes either a Symbol or a String, and converts it to a
+	# lowercase Symbol with spaces converted to underscores.
+	# 
+	# E.g. "Alice Blue" and :ALICE_BLUE both become :alice_blue.
+	# 
+	def sanitize_name( name )
+		name.to_s.gsub(' ','_').downcase.intern
+	end
+
+end