zyps 0.7.3 → 0.7.4

data/bin/zyps

@@ -153,6 +153,9 @@ class Application < Wx::App
 		@log.debug "Set up a creature generator."
 		@generator = CreatureGenerator.new(:environment => @environment)
 		
+		@log.debug "Set the Utility module to cache distances and angles."
+		Utility.caching_enabled = true
+		
 		@log.debug "Set up a timer to update the environment."
 		milliseconds_per_frame = (1.0 / @options[:fps] * 1000).to_int
 		@log.debug "Timer will fire every #{milliseconds_per_frame} milliseconds."
@@ -190,6 +193,8 @@ class Application < Wx::App
 			#Copy from View to drawing area.
 			render(dc)
 		end
+		#Almost all distances and angles will be different next update, so clear the cache.
+		Utility.clear_caches
 		#Keeps dead objects from accumulating and causing hiccups later.
 		GC.start
 	end
@@ -644,7 +649,7 @@ class CreatureGenerator
 			:turn_angle => 90,
 			:breed_rate => 10,
 		}.merge(options)
-		@log.debug "options: #{@options.inspect}"
+		@log.debug "options: #{options.inspect}"
 		
 		@environment = options[:environment]
 		@default_size = options[:default_size]
@@ -692,7 +697,7 @@ class CreatureGenerator
 			:breed => false,
 			:eat => false,
 		}.merge(options)
-		@log.debug "options: #{@options.inspect}"
+		@log.debug "options: #{options.inspect}"
 		
 		#Create a creature.
 		creature = Creature.new(
@@ -707,35 +712,40 @@ class CreatureGenerator
 			color.blue += 1
 			creature.behaviors << Behavior.new(
 				:actions => [TurnAction.new(@turn_rate, @turn_angle)],
-				:conditions => [ProximityCondition.new(options[:action_proximity] * 2)]
+				:conditions => [ProximityCondition.new(options[:action_proximity] * 2)],
+				:condition_frequency => 20
 			)
 		end
 		if options[:approach]
 			color.red += 1
 			creature.behaviors << Behavior.new(
 				:actions => [ApproachAction.new(@approach_rate)],
-				:conditions => [ProximityCondition.new(options[:action_proximity])]
+				:conditions => [ProximityCondition.new(options[:action_proximity])],
+				:condition_frequency => 10
 			)
 		end
 		if options[:flee]
 			color.red += 0.5; color.green += 0.5 #Yellow.
 			creature.behaviors << Behavior.new(
 				:actions => [FleeAction.new(@flee_rate)],
-				:conditions => [ProximityCondition.new(options[:action_proximity] * 0.5)]
+				:conditions => [ProximityCondition.new(options[:action_proximity] * 0.5)],
+				:condition_frequency => 5
 			)
 		end
 		if options[:push]
 			color.red += 0.5; color.blue += 0.5 #Purple.
 			creature.behaviors << Behavior.new(
 				:actions => [PushAction.new(@push_strength)],
-				:conditions => [ProximityCondition.new(options[:action_proximity] * 0.25)]
+				:conditions => [ProximityCondition.new(options[:action_proximity] * 0.25)],
+				:condition_frequency => 2
 			)
 		end
 		if options[:pull]
 			color.blue += 0.75; color.green += 0.75 #Aqua.
 			creature.behaviors << Behavior.new(
 				:actions => [PullAction.new(@pull_strength)],
-				:conditions => [ProximityCondition.new(options[:action_proximity] * 0.75)]
+				:conditions => [ProximityCondition.new(options[:action_proximity] * 0.75)],
+				:condition_frequency => 7
 			)
 		end
 		if options[:breed]
@@ -743,7 +753,8 @@ class CreatureGenerator
 			color.blue -= 0.1
 			creature.behaviors << Behavior.new(
 				:actions => [BreedAction.new(@environment, @breed_rate)],
-				:conditions => [CollisionCondition.new] #The default ProximityCondition won't do.
+				:conditions => [CollisionCondition.new], #The default ProximityCondition won't do.
+				:condition_frequency => 1
 			)
 		end
 		if options[:eat]
@@ -751,15 +762,16 @@ class CreatureGenerator
 			creature.behaviors << Behavior.new(
 				:actions => [EatAction.new(@environment)],
 				:conditions => [
-					CollisionCondition.new, #The default ProximityCondition won't do.
-					StrengthCondition.new #The eater should be as strong or stronger than its dinner.
-				] 
+					StrengthCondition.new, #The eater should be as strong or stronger than its dinner.
+					CollisionCondition.new #The default ProximityCondition won't do.
+				],
+				:condition_frequency => 1
 			)
 		end
 		
 		creature.color = color
 		
-		@log.debug "Created creature: #{creature.inspect}"
+		@log.debug "Created creature: #{creature.to_s}"
 		
 		creature
 		

data/bin/zyps_demo

@@ -93,6 +93,12 @@ class Demo < Wx::App
 		@update_count = 0
 		@environment.add_observer(self)
 		
+		say "The Utility module calculates distances and angles between objects."
+		say "Utility is sometimes asked to compute the same distance or angle over and over."
+		say "We can speed this by returning a cached result instead of re-calculating it."
+		say "Let's turn this feature on."
+		Utility.caching_enabled = true
+		
 		say "We want to update the environment #{FRAMES_PER_SECOND} times per second."
 		milliseconds_per_frame = (1.0 / FRAMES_PER_SECOND * 1000).to_int
 		say "So, we'll set up a timer to fire every #{milliseconds_per_frame} milliseconds."
@@ -100,6 +106,7 @@ class Demo < Wx::App
 		timer = Wx::Timer.new(self, timer_id)
 		say "The timer will trigger the environment update."
 		say "Then it copies the updated view's buffer to our window."
+		say "We'll clear the cached values from the Utility module to save memory."
 		say "We also call the Ruby garbage collector with each update."
 		say "This keeps dead objects from accumulating and causing hiccups later."
 		evt_timer(timer_id) do
@@ -107,6 +114,7 @@ class Demo < Wx::App
 			window.paint do |surface|
 				surface.draw_bitmap(view.canvas.buffer, 0, 0, false)
 			end
+			Utility.clear_caches
 			GC.start
 		end
 		timer.start(milliseconds_per_frame)

data/lib/zyps/conditions.rb

@@ -67,7 +67,16 @@ end
 class CollisionCondition < Condition
 	#Returns an array of targets that have collided with the actor.
 	def select(actor, targets)
-		targets.find_all {|target| Utility.collided?(actor, target)}
+		return [] unless targets.length > 0
+		#The size of the largest other object
+		max_size = targets.map{|t| t.size}.max
+		#The maximum distance on a straight line the largest object and self could be and still be touching.
+		max_diff = Math.sqrt(actor.size / Math::PI) + Math.sqrt(max_size / Math::PI)
+		x_range = (actor.location.x - max_diff .. actor.location.x + max_diff)
+		y_range = (actor.location.y - max_diff .. actor.location.y + max_diff)
+		targets.select do | target |
+			x_range.include?(target.location.x) and y_range.include?(target.location.y) and Utility.collided?(actor, target)
+		end
 	end
 end
 

data/lib/zyps.rb

@@ -302,20 +302,44 @@ end
 #Likewise, the subject can change its own attributes, it can approach or flee from the target, it can spawn new Creatures or GameObjects (like bullets), or anything else.
 class Behavior
 
+	#An array of Condition subclasses.
+	#Condition#select(actor, targets) will be called on each.
 	attr_accessor :conditions
+	#An array of Action subclasses.
+	#Action#start(actor, targets) and action.do(actor, targets) will be called on each when all conditions are true.
+	#Action#stop(actor, targets) will be called when any condition is false.
 	attr_accessor :actions
+	#Number of updates before behavior is allowed to select a new group of targets to act on.
+	attr_accessor :condition_frequency
+	
+	#Will be used to distribute condition processing time between all Behaviors with the same condition_frequency.
+	@@condition_order = Hash.new {|h, k| h[k] = 0}
 	
 	#Takes a hash with these keys and defaults:
 	#	:actions => []
 	#	:conditions => []
+	#	:condition_frequency => 1
 	def initialize (options = {})
 		options = {
 			:actions => [],
-			:conditions => []
+			:conditions => [],
+			:condition_frequency => 1
 		}.merge(options)
-		self.actions, self.conditions = options[:actions], options[:conditions]
-		#Tracks current target.
-		@active_target = nil
+		self.actions = options[:actions]
+		self.conditions = options[:conditions]
+		self.condition_frequency = options[:condition_frequency]
+		#Tracks number of calls to perform() so conditions can be evaluated with appropriate frequency.
+		@condition_evaluation_count = 0
+		#Targets currently selected to act upon.
+		@current_targets = []
+	end
+	
+	def condition_frequency= (value)
+		#Condition frequency must be 1 or more.
+		@condition_frequency = (value >= 1 ? value : 1)
+		#This will be used to distribute condition evaluation time among all behaviors with this frequency.
+		@condition_order = @@condition_order[@condition_frequency]
+		@@condition_order[@condition_frequency] += 1
 	end
 	
 	#Make a deep copy.
@@ -336,19 +360,33 @@ class Behavior
 	#If no matching targets are found, calls Action#stop(actor, targets) on each Action.
 	def perform(actor, targets)
 		
-		choices = targets.clone
-		conditions.each {|condition| choices = condition.select(actor, choices)}
+		if condition_evaluation_turn?
+			@current_targets = targets.clone
+			conditions.each {|condition| @current_targets = condition.select(actor, @current_targets)}
+		end
 		actions.each do |action|
-			if ! choices.empty?
-				action.start(actor, choices) unless action.started?
-				action.do(actor, choices)
+			if ! @current_targets.empty?
+				action.start(actor, @current_targets) unless action.started?
+				action.do(actor, @current_targets)
 			else
-				action.stop(actor, targets) #Not choices; that array is empty.
+				action.stop(actor, targets) #Not @current_targets; that array is empty.
 			end
 		end
 		
+		
 	end
 	
+	private
+		
+		#Return true if it's our turn to choose targets, false otherwise.
+		def condition_evaluation_turn?
+			#Every condition_frequency turns (plus our turn order within the group), return true.
+			our_turn = ((@condition_evaluation_count + @condition_order) % @condition_frequency == 0) ? true : false
+			#Track number of calls to perform() for staggering condition evaluation.
+			@condition_evaluation_count += 1
+			our_turn
+		end
+	
 end
 
 
@@ -499,8 +537,29 @@ module Utility
 	
 	PI2 = Math::PI * 2.0 #:nodoc:
 	
+	#Empty cached return values.
+	def Utility.clear_caches
+		@@angles = Hash.new {|h, k| h[k] = {}}
+		@@distances = Hash.new {|h, k| h[k] = {}}
+	end
+	
+	#Initialize caches for return values.
+	Utility.clear_caches
+	
+	#Turn caching of return values on or off.
+	@@caching_enabled = false
+	def Utility.caching_enabled= (value)
+		@@caching_enabled = value
+		Utility.clear_caches if ! @@caching_enabled
+	end
+	
 	#Get the angle (in degrees) from one Location to another.
 	def Utility.find_angle(origin, target)
+		if @@caching_enabled
+			#Return cached angle if there is one.
+			return @@angles[origin][target] if @@angles[origin][target]
+			return @@angles[target][origin] if @@angles[target][origin]
+		end
 		#Get vector from origin to target.
 		x_difference = target.x - origin.x
 		y_difference = target.y - origin.y
@@ -509,16 +568,37 @@ module Utility
 		#Result will range from negative Pi to Pi, so correct it.
 		radians += PI2 if radians < 0
 		#Convert to degrees.
-		to_degrees(radians)
+		angle = to_degrees(radians)
+		#Cache angle if caching enabled.
+		if @@caching_enabled
+			@@angles[origin][target] = angle
+			#angle + 180 = angle from target to origin.
+			@@angles[target][origin] = (angle + 180 % 360)
+		end
+		#Return result.
+		angle
 	end
 	
 	#Get the distance from one Location to another.
 	def Utility.find_distance(origin, target)
+		if @@caching_enabled
+			#Return cached distance if there is one.
+			return @@distances[origin][target] if @@distances[origin][target]
+		end
 		#Get vector from origin to target.
 		x_difference = origin.x - target.x
 		y_difference = origin.y - target.y
 		#Get distance.
-		Math.sqrt(x_difference ** 2 + y_difference ** 2)
+		distance = Math.sqrt(x_difference ** 2 + y_difference ** 2)
+		#Cache distance if caching enabled.
+		if @@caching_enabled
+			#Origin to target distance = target to origin distance.
+			#Cache such that either will be found.
+			@@distances[origin][target] = distance
+			@@distances[target][origin] = distance
+		end
+		#Return result.
+		distance
 	end
 	
 	#Convert radians to degrees.

data/test/test_zyps.rb

@@ -402,6 +402,11 @@ end
 
 
 class TestUtility < Test::Unit::TestCase
+
+	
+	def setup
+		Utility.caching_enabled = true
+	end
 	
 	
 	def test_to_radians

metadata

@@ -1,81 +1,88 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: zyps
 version: !ruby/object:Gem::Version 
-  version: 0.7.3
-date: 2008-02-04 00:00:00 -07:00
-summary: A game library for Ruby
-require_paths: 
-- lib
-email: jay@mcgavren.com
-homepage: http://jay.mcgavren.com/zyps/
-rubyforge_project: zyps
-description: 
-autorequire: zyps
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.7.4
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Jay McGavren
+autorequire: zyps
+bindir: bin
+cert_chain: []
+
+date: 2008-02-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: wxruby
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.9.2
+    version: 
+description: 
+email: jay@mcgavren.com
+executables: 
+- zyps
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- COPYING.LESSER.txt
+- COPYING.txt
 files: 
 - COPYING.LESSER.txt
 - COPYING.txt
-- README.txt
 - README_windows.txt
+- README.txt
 - bin/zyps
 - bin/zyps_demo
 - lib/zyps
-- lib/zyps/actions.rb
-- lib/zyps/conditions.rb
-- lib/zyps/environmental_factors.rb
-- lib/zyps/remote.rb
 - lib/zyps/views
 - lib/zyps/views/canvas
 - lib/zyps/views/canvas/wx.rb
 - lib/zyps/views/trails.rb
+- lib/zyps/actions.rb
+- lib/zyps/environmental_factors.rb
+- lib/zyps/conditions.rb
+- lib/zyps/remote.rb
 - lib/zyps.rb
-- test/test_zyps.rb
 - test/zyps
-- test/zyps/test_actions.rb
 - test/zyps/test_behaviors.rb
-- test/zyps/test_conditions.rb
+- test/zyps/test_actions.rb
 - test/zyps/test_environmental_factors.rb
+- test/zyps/test_conditions.rb
 - test/zyps/test_remote.rb
-test_files: 
 - test/test_zyps.rb
+has_rdoc: true
+homepage: http://jay.mcgavren.com/zyps/
+post_install_message: 
 rdoc_options: 
 - --title
 - Zyps - A game library for Ruby
 - --main
 - README.txt
-extra_rdoc_files: 
-- README.txt
-- COPYING.LESSER.txt
-- COPYING.txt
-executables: 
-- zyps
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: wxruby
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.9.2
-    version: 
+rubyforge_project: zyps
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A game library for Ruby
+test_files: 
+- test/test_zyps.rb