zyps 0.6.3 → 0.7.0

data/bin/zyps_demo

@@ -18,196 +18,225 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
+gems_loaded = false
 begin
+	require 'logger'
+	require 'wx'
 	require 'zyps'
 	require 'zyps/actions'
 	require 'zyps/conditions'
 	require 'zyps/environmental_factors'
 	require 'zyps/views/trails'
+	require 'zyps/views/canvas/wx'
 rescue LoadError
-	require 'rubygems'
-	require 'zyps'
-	require 'zyps/actions'
-	require 'zyps/conditions'
-	require 'zyps/views/trails'
+	if gems_loaded == false
+		require 'rubygems'
+		gems_loaded = true
+		retry
+	else
+		raise
+	end
 end
 
 
 include Zyps
 
 
-class Demo
+LOG_LEVEL = Logger::WARN
+LOG_HANDLE = STDOUT
+
+
+class Demo < Wx::App
+
 
 	#The view width.
 	WIDTH = 400
 	#The view height.
 	HEIGHT = 300
-	#Number of frames to draw per demo.
-	FRAME_COUNT = 80
 	#Number of frames per second.
 	FRAMES_PER_SECOND = 30
 	#Default size of game objects.
 	DEFAULT_OBJECT_SIZE = 78.5 #5 units in radius.
 
-	#Set up a window, a canvas, and an object environment, then run the given block.
-	def demo
-
-		#Create a window, and set GTK up to quit when it is closed.
-		window = Gtk::Window.new
-		window.signal_connect("delete_event") {false}
-		window.signal_connect("destroy") {Gtk.main_quit}
-		
-		#Add view to window.
-		@view = TrailsView.new(WIDTH, HEIGHT)
-		window.add(@view.canvas)
-		window.show_all
+	
+	#Initialize an Environment and a View.  Then run the demos.
+	def on_init
+	
+		@log = Logger.new(LOG_HANDLE)
+		@log.level = LOG_LEVEL
+		@log.progname = self
+		
+		say "We're using wxRuby as the GUI framework for this demo."
+		say "First, we need to create a Frame (window) to hold everything."
+		frame = Wx::Frame.new(nil, :size => [WIDTH, HEIGHT], :title => "Zyps Demo")
+		frame.evt_close {|event| exit}
+		frame.show
+		
+		say "Zyps environments are displayed using Views."
+		say "A TrailsView shows game objects with little light trails behind them."
+		view = TrailsView.new(
+			:width => WIDTH,
+			:height => HEIGHT
+		)
+		say "We also assign the View a Canvas to draw to."
+		say "Since our framework is wxWidgets, we'll use a WxCanvas."
+		view.canvas = WxCanvas.new(frame)
 		
-		#Create environment.
+		say "The world is called an Environment in Zyps.  Let's create a new one."
 		@environment = Environment.new
-		
-		#Point view at environment.
-		@environment.add_observer(@view)
-		
-		#Run the given block.
-		yield
-		
-		#Activate the GUI.
-		Gtk.main
-		
-		#A divider for explanation text between demos.
-		say("-" * 30)
+		say "We tell the View to display our Environment by adding it as an Observer."
+		@environment.add_observer(view)
+		say "We'll also add this application as an observer, to track the number of updates."
+		@update_count = 0
+		@environment.add_observer(self)
+		
+		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."
+		timer_id = Wx::ID_HIGHEST + 1
+		timer = Wx::Timer.new(self, timer_id)
+		say "The timer will trigger the environment update."
+		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
+			@environment.interact
+			GC.start
+		end
+		timer.start(milliseconds_per_frame)
 		
 	end
-
-
-	#Animate an environment for a given number of frames.
-	def animate(frame_count)
 	
-		#A clock to track frames to draw this second.
-		clock = Clock.new
-		time_per_frame = 1.0 / FRAMES_PER_SECOND
-		
-		begin
-			(1..frame_count).each do |i|
-				@environment.interact
-				#Determine how much time is left in this frame.
-				time_left_in_frame = (time_per_frame) - clock.elapsed_time
-				#Sleep for the remaining time.
-				if time_left_in_frame > 0
-					sleep time_left_in_frame
-				#Skip a frame if things are going too slow.
-				else
-					sleep time_per_frame
-				end
-			end
-		rescue Exception => exception
-			puts exception, exception.backtrace
+	
+	#Watch for environment updates.
+	#After a certain number, run the next demo.
+	def update(environment)
+		case @update_count
+			when 0:
+				say "-" * 30
+				test_render
+			when 100:
+				test_render_2
+				say "-" * 30
+			when 200:
+				@environment.objects = []
+				test_environmental_factors
+			when 300:
+				test_environmental_factors_2
+				say "-" * 30
+			when 400:
+				@environment.objects = []
+				@environment.environmental_factors = []
+				test_behaviors
+			when 500:
+				test_behaviors_2
+				say "-" * 30
+			when 600:
+				@environment.objects = []
+				test_change_color
+				say "-" * 30
+			when 800:
+				@environment.objects = []
+				test_accelerate
+				say "-" * 30
+			when 1000:
+				@environment.objects = []
+				test_turn
+				say "-" * 30
+			when 1200:
+				@environment.objects = []
+				test_approach
+				say "-" * 30
+			when 1400:
+				@environment.objects = []
+				test_flee
+				say "-" * 30
+			when 1600:
+				@environment.objects = []
+				test_eat
+				say "-" * 30
+			when 1800:
+				finish
 		end
-		
+		@update_count += 1
 	end
 
-
+	
 	#Populate an environment with the given number of creatures.
 	def populate(environment, count = 50)
+		@log.debug "Add #{count} creatures to #{environment}."
 		count.times do |i|
 			multiplier = i / count.to_f
 			environment.objects << Creature.new(
-				i, #Name.
-				Location.new(multiplier * @view.width, multiplier * @view.height),
-				Color.new(multiplier, 1 - multiplier, multiplier / 2 + 0.5),
-				Vector.new(100 * multiplier, multiplier * 360),
-				0, #Age.
-				DEFAULT_OBJECT_SIZE #Size.
+				:name => i,
+				:location => Location.new(multiplier * WIDTH, multiplier * HEIGHT),
+				:color => Color.new(multiplier, 1 - multiplier, multiplier / 2 + 0.5),
+				:vector => Vector.new(100 * multiplier, multiplier * 360),
+				:size => DEFAULT_OBJECT_SIZE
 			)
 		end
 	end
-
 	
-	#Explain what's going on to the user.
-	def say(phrase)
-		puts phrase
-	end
-
-
+	
 	#Demonstrates drawing an environment and changing its size.
 	def test_render
-				
-		thread = Thread.new do
-		
-			say("The things that populate an environment are called GameObjects.  Each object has:")
-			object = GameObject.new
-			say("...a name")
-			object.name = "Huey"
-			say("...a size")
-			object.size = DEFAULT_OBJECT_SIZE
-			say("...a Location with x and y coordiates")
-			object.location = Location.new(@view.width/2, @view.height/2)
-			say("...a Color with red, green and blue components ranging from 0 to 1")
-			object.color = Color.new(1, 0, 0)
-			say("...and a Vector giving its speed and an angle from 0 to 360.")
-			object.vector = Vector.new(10, 45)
-			
-			say("Once your object is ready, add it to the environment.")
-			@environment.objects << object
-		
-			say("Add a view as an observer of an Environment, and it will draw the objects.")
-			say("Call an environment's interact() method to have the objects in it move around.")
-			say("Our demo's animate() method does this for us.")
-			animate(FRAME_COUNT)
-			
-			say("Let's add a couple more objects with different colors and vectors.")
-			@environment.objects << GameObject.new(
-				"Duey", #Name.
-				Location.new(@view.width/2, @view.height/2),
-				Color.new(0, 1, 0),
-				Vector.new(20, 135),
-				0, #Age.
-				DEFAULT_OBJECT_SIZE * 2 #Size.
-			)
-			@environment.objects << GameObject.new(
-				"Louie", #Name.
-				Location.new(@view.width/2, @view.height/2),
-				Color.new(0, 0, 1),
-				Vector.new(30, 225),
-				0, #Age.
-				DEFAULT_OBJECT_SIZE * 3 #Size.
-			)
-			animate(FRAME_COUNT)
-			
-			say("The viewing area can be resized at any time via its width and height attributes.")
-			@view.width += 100
-			@view.height += 100
-			animate(FRAME_COUNT)
-			
-			say("TrailsView lets you set the length of the trails as well.")
-			@view.trail_length = 50
-			animate(FRAME_COUNT)
-			
-		end
-		
-	end
 
+		say("The things in an Environment are called GameObjects.  Each object has:")
+		object = GameObject.new
+		say("...a name")
+		object.name = "Huey"
+		say("...a size")
+		object.size = DEFAULT_OBJECT_SIZE
+		say("...a Location with x and y coordiates")
+		object.location = Location.new(WIDTH/2, HEIGHT/2)
+		say("...a Color with red, green and blue components ranging from 0 to 1")
+		object.color = Color.new(1, 0, 0)
+		say("...and a Vector giving its speed and an angle from 0 to 360.")
+		object.vector = Vector.new(10, 45)
+		
+		say("Once your object is ready, add it to the environment.")
+		@environment.objects << object
 
+	end
+	
+	def test_render_2
+	
+		say("Let's add a couple more objects with different colors and vectors.")
+		@environment.objects << GameObject.new(
+			:name => "Duey",
+			:location => Location.new(WIDTH/2, HEIGHT/2),
+			:color => Color.new(0, 1, 0),
+			:vector => Vector.new(20, 135),
+			:size => DEFAULT_OBJECT_SIZE * 2
+		)
+		@environment.objects << GameObject.new(
+			:name => "Louie",
+			:location => Location.new(WIDTH/2, HEIGHT/2),
+			:color => Color.new(0, 0, 1),
+			:vector => Vector.new(30, 225),
+			:size => DEFAULT_OBJECT_SIZE * 3
+		)
+				
+	end
+	
+	
 	#Demonstrates environmental factors by adding gravity to the environment.
 	def test_environmental_factors
 
 		populate(@environment)
 		
-		thread = Thread.new do
+		say("Without gravity, objects just travel on forever.")
+	
+	end
+	
+	def test_environmental_factors_2
+	
+		say("Let's add a new EnvironmentalFactor to simulate gravity.")
+		gravity = Gravity.new(200)
 		
-			say("Without gravity, objects just travel on forever.")
-			animate(FRAME_COUNT)
-			
-			say("Let's add a new EnvironmentalFactor to simulate gravity.")
-			gravity = Gravity.new(200)
-			
-			say("We add gravity to the Environment.")
-			@environment.environmental_factors << gravity
-			
-			say("Everything immediately drops.")
-			animate(FRAME_COUNT)
-			
-		end
+		say("We add gravity to the Environment.")
+		@environment.environmental_factors << gravity
+		
+		say("Everything immediately drops.")
 		
 	end
 
@@ -217,39 +246,38 @@ class Demo
 
 		populate(@environment)
 		
-		thread = Thread.new do
-
-			say("Let's add a Behavior to our creatures.")
-			chase = Behavior.new
-			
-			say("A Behavior has one or more Action objects that define an action to take on the current target.")
-			say("We'll add an Action that makes the creatures head straight toward their target.")
-			chase.actions << FaceAction.new
-			
-			say("A Behavior also has one or more Condition objects.")
-			say("Unless every Condition is true, the action(s) won't be carried out.")
-			say("So that they don't target every creature on the screen, we'll add a condition to the behavior saying the target must have the label 'food'.")
-			chase.conditions << TagCondition.new("food")
-			
-			say("We'll apply this behavior to all creatures currently in the environment.")
-			@environment.objects.each {|creature| creature.behaviors << chase}
-			animate(FRAME_COUNT)
-			
-			say("Then we'll toss a piece of food (a GameObject with the label 'food') into the environment.")
-			@environment.objects << GameObject.new(
-				"target", #Name.
-				Location.new(@view.width / 2, @view.height / 2),
-				Color.new(1, 1, 1),
-				Vector.new(50, 315),
-				0, #Age.
-				DEFAULT_OBJECT_SIZE * 2, #Size.
-				["food"] #Tags.
-			)
-			
-			say("Let's see what the creatures do.")
-			animate(FRAME_COUNT)
-			
-		end
+		say("Let's add a Behavior to our creatures.")
+		chase = Behavior.new
+		
+		say("A Behavior has one or more Action objects that define an action to take on the current target.")
+		say("We'll add an Action that makes the creatures head straight toward their target.")
+		chase.actions << FaceAction.new
+		
+		say("A Behavior also has one or more Condition objects.")
+		say("Unless every Condition is true, the action(s) won't be carried out.")
+		say("So that they don't target every creature on the screen, we'll add a condition to the behavior saying the target must have the label 'food'.")
+		chase.conditions << TagCondition.new("food")
+		
+		say("We'll apply this behavior to all creatures currently in the environment.")
+		@environment.objects.each {|creature| creature.behaviors << chase}
+		
+	end
+	
+	def test_behaviors_2
+		
+		say("Then we'll toss a piece of food into the environment.")
+		say("(It's just a GameObject with the tag 'food'.)")
+		@environment.objects << GameObject.new(
+			:name => "target",
+			:location => Location.new(WIDTH / 2, HEIGHT / 2),
+			:color => Color.new(1, 1, 1),
+			:vector => Vector.new(30, 315),
+			:size => DEFAULT_OBJECT_SIZE * 2, #Size.
+			:tags => ["food"]
+		)
+		
+		say("Now there's a target in the environment for which the condition is true.")
+		say("All the Creatures will turn and chase it.")
 		
 	end
 
@@ -278,14 +306,28 @@ class Demo
 		say("Morphers are created with a single behavior, which shifts the color of any nearby target to match the Morpher's color.")
 		
 		say("Let's place a red Morpher...")
-		@environment.objects << Morpher.new(nil, Location.new(0, 100), Color.new(1, 0, 0), Vector.new(100, 0), 0, DEFAULT_OBJECT_SIZE)
+		@environment.objects << Morpher.new(
+			:location => Location.new(0, 100),
+			:color => Color.new(1, 0, 0),
+			:vector => Vector.new(100, 0),
+			:size => DEFAULT_OBJECT_SIZE
+		)
 		say("a green one...")
-		@environment.objects << Morpher.new(nil, Location.new(0, 150), Color.new(0, 1, 0), Vector.new(200, 0), 0, DEFAULT_OBJECT_SIZE)
+		@environment.objects << Morpher.new(
+			:location => Location.new(0, 150),
+			:color => Color.new(0, 1, 0),
+			:vector => Vector.new(200, 0),
+			:size => DEFAULT_OBJECT_SIZE
+		)
 		say("and a blue one...")
-		@environment.objects << Morpher.new(nil, Location.new(0, 200), Color.new(0, 0, 1), Vector.new(300, 0), 0, DEFAULT_OBJECT_SIZE)
+		@environment.objects << Morpher.new(
+			:location => Location.new(0, 200),
+			:color => Color.new(0, 0, 1),
+			:vector => Vector.new(300, 0),
+			:size => DEFAULT_OBJECT_SIZE
+		)
 		
-		say("And see what they do.")
-		thread = Thread.new {animate(FRAME_COUNT)}
+		say("...and see what they do.")
 		
 	end
 
@@ -293,50 +335,32 @@ class Demo
 	#Demonstrates altering object speed.
 	def test_accelerate
 
+		say("Here are some Creatures, just plodding along.")
 		populate(@environment)
 		
-		thread = Thread.new do
-
-		
-			say("Here are some Creatures, just plodding along.")
-			animate(FRAME_COUNT / 4)
-			say("We're going to have them pick up the pace.")
-			
-			say("We add a Behavior with an AccelerateAction to all the creatures, and specify they should increase their speed by 100 units/second...")
-			@environment.objects.each do |creature|
-				accelerate = Behavior.new
-				accelerate.actions << AccelerateAction.new(100)
-				creature.behaviors << accelerate
-			end
-			
-			say("And watch them rocket away.")
-			animate(FRAME_COUNT)
-			
+		say("We're going to have them pick up the pace.")
+		say("We add a Behavior with an AccelerateAction to all the creatures.")
+		say("This AccelerateAction specifies they should increase their speed by 50 units/second.")
+		@environment.objects.each do |creature|
+			accelerate = Behavior.new
+			accelerate.actions << AccelerateAction.new(50)
+			creature.behaviors << accelerate
 		end
-		
+			
 	end
 
 
 	#Demonstrates altering object vectors.
 	def test_turn
 
-		populate(@environment, 20)
-		
-		thread = Thread.new do
+		populate(@environment)
 		
-			say("This time we'll use the TurnAction class.")
-			animate(FRAME_COUNT / 2)
-			
-			say("We tell each creature it should turn by 90 degrees/second...")
-			@environment.objects.each do |creature|
-				turn = Behavior.new
-				turn.actions << TurnAction.new(90)
-				creature.behaviors << turn
-			end
-			
-			say("And watch things spiral out of control.")
-			animate(FRAME_COUNT)
-			
+		say("This time we'll use the TurnAction class.")
+		say("We tell each creature it should turn 90 degrees.")
+		@environment.objects.each do |creature|
+			turn = Behavior.new
+			turn.actions << TurnAction.new(100, 90)
+			creature.behaviors << turn
 		end
 		
 	end
@@ -360,17 +384,14 @@ class Demo
 		
 		say("Add a target...")
 		@environment.objects << Creature.new(
-			"target",
-			Location.new(@view.width / 2, @view.height / 3),
-			Color.new(1, 1, 1),
-			Vector.new(3, 0),
-			0, #Age.
-			DEFAULT_OBJECT_SIZE, #Size.
-			["food"] #Tags.
+			:name => "target",
+			:location => Location.new(WIDTH / 2, HEIGHT / 3),
+			:vector => Vector.new(10, 0),
+			:size => DEFAULT_OBJECT_SIZE,
+			:tags => ["food"]
 		)
 		
 		say("And watch them all TRY to catch it.")
-		thread = Thread.new {animate(FRAME_COUNT)}
 		
 	end
 
@@ -390,20 +411,15 @@ class Demo
 		end
 		
 		@environment.objects << Creature.new(
-			"target",
-			Location.new(@view.width / 2, @view.height / 2),
-			Color.new(1, 1, 1),
-			Vector.new(3, 0),
-			0, #Age.
-			DEFAULT_OBJECT_SIZE, #Size.
-			["predator"] #Tags.
+			:name => "hunter",
+			:location => Location.new(WIDTH / 2, HEIGHT / 2),
+			:vector => Vector.new(10, 0),
+			:size => DEFAULT_OBJECT_SIZE,
+			:tags => ["predator"]
 		)
 		
-		thread = Thread.new {animate(FRAME_COUNT)}
-		
 	end
 
-
 	
 	#Demonstrates keeping a reference to an Environment so a Creature can alter it.
 	def test_eat
@@ -412,7 +428,12 @@ class Demo
 		
 		say("Most games are all about destruction, but there hasn't been much so far.")
 		say("Let's create a creature that causes some havoc.")
-		predator = Creature.new(nil, Location.new(0, 150), Color.new(0, 1, 0), Vector.new(200, 0), 0, DEFAULT_OBJECT_SIZE * 2)
+		predator = Creature.new(
+			:location => Location.new(0, 150),
+			:color => Color.new(0, 1, 0),
+			:vector => Vector.new(200, 0), 
+			:size => DEFAULT_OBJECT_SIZE * 5
+		)
 		
 		say("The EatAction eats targets by removing them from their environment.")
 		say("Creatures and their Actions normally know nothing about the Environment they belong to, so EatAction takes an Environment in its constructor.")
@@ -432,38 +453,35 @@ class Demo
 		@environment.objects << predator
 		
 		say("And - chomp!")
-		thread = Thread.new {animate(FRAME_COUNT)}
 		
 	end
 
 
-	#Run all the demos.
-	def main
-		say "This is a demonstration of the Zyps library."
-		say "After each demo, close the window to proceed."
-		say("-" * 30)
-		demo {test_render}
-		demo {test_environmental_factors}
-		demo {test_behaviors}
-		demo {test_change_color}
-		demo {test_accelerate}
-		demo {test_turn}
-		demo {test_approach}
-		demo {test_flee}
-		demo {test_eat}
+	#End the demos.
+	def finish
 		say "To learn more about how the library works, you can read the source code in the 'bin/zyps_demo' file in the Zyps distribution."
 		say "And if you want to code your own Actions, Conditions, EnvironmentalFactors, or Views, see the distribution's 'lib' folder for examples."
 		say "Thanks for watching!"
 	end
+	
+	
+	private
+	
+		#Explain what's going on to the user.
+		def say(phrase)
+			puts phrase
+		end
 
-
+	
 end
 
 
 begin
 	#Run the demos.
-	Demo.new.main
-rescue => exception
+	Demo.new.main_loop
+rescue SystemExit
+	#No action.
+rescue Exception => exception
 	#Print error to STDERR and exit with an abnormal status.
 	abort "Error: " + exception.message
 end