zyps 0.2.1 → 0.3.1

data/README.txt

@@ -34,20 +34,6 @@ To see a tutorial on the library, at a command line, type:
 
 	zyps_demo
 
-To run a DRb server others can connect to and add creatures (NOTE: not thoroughly tested and probably insecure!):
-
-	zyps_server [options]
-	  -h, --help                       Display program help.
-	  -m, --max-population [number]    The maximum number of allowed game
-	                                   objects.  25 by default.
-	  -p, --port [number]              Port number to run the server on.
-	                                   If not defined, next available one
-	                                   will be selected and the URI printed
-	                                   to STDOUT.
-	  -f, --fps [frames]               Number of frames to draw per second.
-	      --view-width [pixels]        Window width.  800 by default.
-	      --view-height [pixels]       Window height.  600 by default.
-
 
 == Development
 

data/bin/zyps

@@ -261,11 +261,16 @@ class Generator
 end
 
 
+
 #Keeps all objects within a set of walls.
-class Enclose < Behavior
+class EncloseBehavior < Behavior
+
+	#Positions of walls.
 	attr_accessor :left, :top, :right, :bottom
+	
 	def initialize
 		super
+		@left, @top, @right, @bottom = 0, 0, 0, 0
 		@actions << lambda do |boundary, object|
 			#If object is beyond a boundary, set its position equal to the boundary and reflect it.
 			if (object.location.x < @left) then
@@ -284,9 +289,11 @@ class Enclose < Behavior
 			end
 		end
 	end
+	
 end
 
 
+
 class Application
 
 	#Tags to randomly choose from.
@@ -300,17 +307,18 @@ class Application
 	def initialize(width, height)
 		
 		@width, @height = width, height
-		@tag_pool, @color_pool = [], []
 		@birth_rate = 1
-
+		@fps = 30.0
+		
 		#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)
+		#Set up controls.
+		window.add(create_controls)
+	
+		#Show all widgets.
 		window.show_all
 		
 		#Create environment.
@@ -324,8 +332,9 @@ class Application
 	
 	def main
 	
+	
 		#Keep all objects within a boundary.
-		enclose = Enclose.new()
+		enclose = EncloseBehavior.new()
 		enclose.left = 0
 		enclose.right = @width
 		enclose.top = 0
@@ -333,30 +342,41 @@ class Application
 		@environment.environmental_factors << EnvironmentalFactor.new([enclose])
 
 		#Create a creature generator.
-		generator = Generator.new(@environment, 0, 0, @width, @height)
-		generator.tag_pool = @tag_pool
-		generator.color_pool = @color_pool
+		@generator = Generator.new(@environment, 0, 0, @width, @height)
 
 		#Create thread to update environment.
 		thread = Thread.new do
+		
 			begin
+			
+				drawing_clock = Clock.new
 				birth_clock = Clock.new
+				time_per_frame = 1.0 / @fps
 				time_since_birth = 0
+				
 				loop do
+				
 					@environment.interact
+					
 					#Control population.
 					@environment.objects.shift while @environment.objects.length > 25
-					#Create new creature every few seconds.
-					if (time_since_birth += birth_clock.elapsed_time) > birth_rate
-						@environment.objects << generator.create_creature()
-						time_since_birth = 0
+					
+					#Determine how much time is left in this frame.
+					time_left_in_frame = (time_per_frame) - drawing_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
-					#Delay 1/60th second to avoid screen flicker.
-					sleep 1.0 / 60.0
+					
 				end
+				
 			rescue Exception => exception
 				puts exception, exception.backtrace
 			end
+			
 		end
 		
 		#Activate the GUI.
@@ -364,28 +384,220 @@ class Application
 		
 	end
 	
+	
+	#Create a view and controls.
+	def create_controls(width = @width, height = @height, homogeneous = false, spacing = 0, expand = false, fill = false, padding = 0)
+	
+		#Create a container for the view and controls.
+		interface = Gtk::HBox.new(homogeneous, spacing)
+		
+		#Add view to interface.
+		@view = TrailsView.new(width, height)
+		interface.pack_start(@view.canvas, expand, fill, padding)
+		#Get mouse events on view.
+		@view.canvas.add_events(Gdk::Event::BUTTON_PRESS_MASK)
+		@view.canvas.signal_connect("button-press-event") do |canvas, event|
+			@press_location = Location.new(event.x, event.y)
+		end
+		@view.canvas.add_events(Gdk::Event::BUTTON_RELEASE_MASK)
+		@view.canvas.signal_connect("button-release-event") do |canvas, event|
+			@release_location = Location.new(event.x, event.y)
+			creature = Creature.new(
+				'',
+				@release_location,
+				Color.new(@red_slider.value, @green_slider.value, @blue_slider.value),
+				Vector.new(
+					Utility.find_distance(@press_location, @release_location) * 2, #Use distance dragged as speed.
+					Utility.find_angle(@press_location, @release_location) #Move in direction of drag.
+				),
+				0,
+				@tags_box.text.split(/,\s*/)
+			)
+			behavior = Behavior.new
+			condition_tags = @tag_condition_box.text
+			condition_tags.split(/,\s*/).each do |tag|
+				behavior.conditions << lambda do |creature, target|
+					target.tags.include?(tag)
+				end
+			end
+			proximity = @proximity_condition_slider.value
+			if proximity > 0
+				behavior.conditions << lambda do |creature, target|
+					Utility.find_distance(creature.location, target.location) < proximity
+				end
+			end
+			age = @age_condition_slider.value
+			if age > 0
+				behavior.conditions << lambda do |creature, target|
+					target.age > age
+				end
+			end
+			acceleration = @acceleration_slider.value
+			if acceleration != 0
+				behavior.actions << lambda do |creature, target|
+					creature.vector.speed += acceleration
+					creature.vector.speed = 0 if creature.vector.speed < 0
+				end
+			end
+			turn = @turn_slider.value
+			if turn != 0
+				behavior.actions << lambda do |creature, target|
+					creature.vector.pitch += turn
+				end
+			end
+			approach_angle = @approach_slider.value
+			if approach_angle > 0
+				heading = creature.vector.clone
+				behavior.actions << lambda do |creature, target|
+					#Find the difference between the current heading and the angle to the target.
+					turn_angle = Utility.find_angle(creature.location, target.location) - heading.pitch
+					#If the angle is the long way around from the current heading, change it to the smaller angle.
+					if turn_angle > 180 then
+						turn_angle -= 360.0
+					elsif turn_angle < -180 then
+						turn_angle += 360.0
+					end
+					#If turn angle is greater than allowed turn speed, reduce it.
+					turn_angle = Utility.constrain_value(turn_angle, approach_angle)
+					#Turn the appropriate amount.
+					heading.pitch += turn_angle
+					#Apply the heading to the creature's movement vector.
+					creature.vector += heading
+				end
+			end
+			flee_angle = @flee_slider.value
+			if flee_angle > 0
+				heading = creature.vector.clone
+				behavior.actions << lambda do |creature, target|
+					#Find the difference between the current heading and the angle to the target.
+					turn_angle = Utility.find_angle(creature.location, target.location) - heading.pitch + 180
+					#If the angle is the long way around from the current heading, change it to the smaller angle.
+					if turn_angle > 180 then
+						turn_angle -= 360.0
+					elsif turn_angle < -180 then
+						turn_angle += 360.0
+					end
+					#If turn angle is greater than allowed turn speed, reduce it.
+					turn_angle = Utility.constrain_value(turn_angle, flee_angle)
+					#Turn the appropriate amount.
+					heading.pitch += turn_angle
+					#Apply the heading to the creature's movement vector.
+					creature.vector += heading
+				end
+			end
+			if @eat_flag.active?
+				behavior.actions << lambda do |creature, target|
+					@environment.objects.delete(target)
+				end
+			end
+			apply_tags = @tag_action_box.text
+			apply_tags.split(/,\s*/).each do |tag|
+				behavior.conditions << lambda do |creature, target|
+					target.tags << tag unless target.tags.include?(tag)
+				end
+			end
+			creature.behaviors << behavior
+			@environment.objects << creature
+		end
+		
+		#Create a VBox for all controls.
+		control_panel = Gtk::VBox.new(homogeneous, spacing)
+	
+		#Create a group for the new object's attributes.
+		attribute_controls = Gtk::VBox.new(homogeneous, spacing)
+		
+		#Add sliders for the color components.
+		attribute_controls.pack_start(Gtk::Label.new("Color"), expand, fill, padding)
+		attribute_controls.pack_start(Gtk::Label.new("R"), expand, fill, padding)
+		@red_slider = Gtk::HScale.new(0, 1, 0.1)
+		attribute_controls.pack_start(@red_slider, expand, fill, padding)
+		attribute_controls.pack_start(Gtk::Label.new("G"), expand, fill, padding)
+		@green_slider = Gtk::HScale.new(0, 1, 0.1)
+		attribute_controls.pack_start(@green_slider, expand, fill, padding)
+		attribute_controls.pack_start(Gtk::Label.new("B"), expand, fill, padding)
+		@blue_slider = Gtk::HScale.new(0, 1, 0.1)
+		attribute_controls.pack_start(@blue_slider, expand, fill, padding)
+		@red_slider.value, @green_slider.value, @blue_slider.value = 1, 1, 1
+				
+		#Add a text box for the tags.
+		attribute_controls.pack_start(Gtk::Label.new("Tags"), expand, fill, padding)
+		@tags_box = Gtk::Entry.new
+		attribute_controls.pack_start(@tags_box, expand, fill, padding)
+		
+		#Add the attribute controls to the panel.
+		control_panel.pack_start(attribute_controls, expand, fill, padding)
+		
+		#Create a group for the conditions.
+		condition_controls = Gtk::VBox.new(homogeneous, spacing)
+		condition_controls.pack_start(Gtk::Label.new("Target"), expand, fill, padding)
+		#Add a text box for the tag condition.
+		condition_controls.pack_start(Gtk::Label.new("Tags"), expand, fill, padding)
+		@tag_condition_box = Gtk::Entry.new
+		condition_controls.pack_start(@tag_condition_box, expand, fill, padding)
+		#Add a slider for the age condition.
+		@age_condition_slider = Gtk::HScale.new(0, 300, 30)
+		condition_controls.pack_start(Gtk::Label.new("Age"), expand, fill, padding)
+		condition_controls.pack_start(@age_condition_slider, expand, fill, padding)
+		#Add a slider for the proximity condition.
+		@proximity_condition_slider = Gtk::HScale.new(1, 100, 10)
+		condition_controls.pack_start(Gtk::Label.new("Proximity"), expand, fill, padding)
+		condition_controls.pack_start(@proximity_condition_slider, expand, fill, padding)
+		#Add the condition controls to the panel.
+		control_panel.pack_start(condition_controls, expand, fill, padding)
+
+		#Create a group for the actions.
+		action_controls = Gtk::VBox.new(homogeneous, spacing)
+		action_controls.pack_start(Gtk::Label.new("Actions"), expand, fill, padding)
+		#Add a slider for the accelerate action.
+		@acceleration_slider = Gtk::HScale.new(-10, 10, 2)
+		action_controls.pack_start(Gtk::Label.new("Accelerate"), expand, fill, padding)
+		action_controls.pack_start(@acceleration_slider, expand, fill, padding)
+		@acceleration_slider.value = 0
+		#Add a slider for the turn action.
+		@turn_slider = Gtk::HScale.new(-180, 180, 20)
+		action_controls.pack_start(Gtk::Label.new("Turn"), expand, fill, padding)
+		action_controls.pack_start(@turn_slider, expand, fill, padding)
+		@turn_slider.value = 0
+		#Add a slider for the approach angle.
+		@approach_slider = Gtk::HScale.new(-180, 180, 20)
+		action_controls.pack_start(Gtk::Label.new("Approach"), expand, fill, padding)
+		action_controls.pack_start(@approach_slider, expand, fill, padding)
+		@approach_slider.value = 0
+		#Add a slider for the flee action.
+		@flee_slider = Gtk::HScale.new(-180, 180, 20)
+		action_controls.pack_start(Gtk::Label.new("Flee"), expand, fill, padding)
+		action_controls.pack_start(@flee_slider, expand, fill, padding)
+		@flee_slider.value = 0
+		#Add a checkbox for the eat action.
+		@eat_flag = Gtk::CheckButton.new("Eat")
+		action_controls.pack_start(@eat_flag, expand, fill, padding)
+		#Add a checkbox for the spawn action.
+		#TODO
+		#Add a text box for the tag action.
+		action_controls.pack_start(Gtk::Label.new("Apply Tag"), expand, fill, padding)
+		@tag_action_box = Gtk::Entry.new
+		action_controls.pack_start(@tag_action_box, expand, fill, padding)
+		#Add the action controls to the panel.
+		control_panel.pack_start(action_controls, expand, fill, padding)
+		
+		#Add the control panel to the interface.
+		interface.pack_start(control_panel, expand, fill, padding)
+		
+		interface
+		
+	end
+	
 
 end
 
 
 begin
-	TAG_POOL = %w{x y z}
-	COLOR_POOL = [
-		Color.new(1, 0, 0),
-		Color.new(1, 0.75, 0),
-		Color.new(1, 1, 0),
-		Color.new(0, 1, 0),
-		Color.new(0, 0, 1),
-		Color.new(1, 0, 1)
-	]
 	#The view width.
 	WIDTH = 500
 	#The view height.
-	HEIGHT = 400
+	HEIGHT = 600
 	#Run the application.
 	application = Application.new(WIDTH, HEIGHT)
-	application.color_pool = COLOR_POOL
-	application.tag_pool = TAG_POOL
 	application.main
 rescue => exception
 	#Print error to STDERR and exit with an abnormal status.

data/bin/zyps_demo

@@ -36,6 +36,8 @@ class Demo
 	HEIGHT = 300
 	#Number of frames to draw per demo.
 	FRAME_COUNT = 80
+	#Number of frames per second.
+	FRAMES_PER_SECOND = 30
 
 	#Set up a window, a canvas, and an object environment, then run the given block.
 	def demo
@@ -70,15 +72,28 @@ class Demo
 
 	#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
-				#Delay 1/60th second to avoid screen flicker.
-				sleep 1.0 / 60.0
+				#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
 		end
+		
 	end
 
 
@@ -176,6 +191,7 @@ class Demo
 	end
 
 
+	
 	#Demonstrates creature behaviors.
 	def test_behaviors
 

data/doc/classes/Behavior.html

@@ -0,0 +1,205 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Behavior</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Behavior</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/zyps_rb.html">
+                lib/zyps.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+A behavior that a <a href="Creature.html">Creature</a> or <a
+href="EnvironmentalFactor.html">EnvironmentalFactor</a> object (or other
+classes that include <a href="Responsive.html">Responsive</a>) engage in.
+The target can have its tags or colors changed, it can be
+&quot;herded&quot;, it can be destroyed, or any other action the library
+user can dream up. Likewise, the subject can change its own attributes, it
+can approach or flee from the target, it can spawn <a
+href="Behavior.html#M000003">new</a> Creatures or GameObjects (like
+bullets), or anything else.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000003">new</a>&nbsp;&nbsp;
+      <a href="#M000004">perform</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">actions</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc">
+A list of actions, which are Proc objects called with the object and its
+target when all conditions are met. An action can act on the subject or its
+target.
+
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">conditions</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc">
+A list of conditions, which are Proc objects called with the object itself
+and its target. A condition can consider the tags on the target, the
+distance from the subject, or any other criteria. If any condition returns
+false, the behavior will not be carried out.
+
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="Behavior.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('Behavior.src/M000003.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(actions = [], conditions = [])</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Optionally takes an array of actions and one of conditions.
+</p>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="Behavior.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('Behavior.src/M000004.html');return false;">
+          <span class="method-name">perform</span><span class="method-args">(subject, target)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Calls each Proc object in the list of conditions with the subject and its
+target. Returns nil if any condition returns false. Then calls each Proc
+object in the list of actions, also with the subject and its target.
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Behavior.src/M000003.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>new (Behavior)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/zyps.rb, line 170</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> (<span class="ruby-identifier">actions</span> = [], <span class="ruby-identifier">conditions</span> = [])
+                <span class="ruby-ivar">@actions</span>, <span class="ruby-ivar">@conditions</span> = <span class="ruby-identifier">actions</span>, <span class="ruby-identifier">conditions</span>
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Behavior.src/M000004.html

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>perform (Behavior)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/zyps.rb, line 176</span>
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">perform</span>(<span class="ruby-identifier">subject</span>, <span class="ruby-identifier">target</span>)
+                <span class="ruby-identifier">conditions</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">condition</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">condition</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">subject</span>, <span class="ruby-identifier">target</span>)}
+                <span class="ruby-identifier">actions</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">action</span><span class="ruby-operator">|</span> <span class="ruby-identifier">action</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">subject</span>, <span class="ruby-identifier">target</span>)}
+        <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>