zyps 0.5.2 → 0.6.1

data/README.txt

@@ -34,6 +34,24 @@ To see a tutorial on the library, at a command line, type:
 
 	zyps_demo
 
+To run a DRb server that clients can connect to:
+
+	zyps_server [options]
+	    -h, --help                       Display program help.
+	    -m, --max-population [number]    The maximum number of allowed game objects.
+	                                     25 by default.
+	    -s, --max-speed [number]         The fastest an object can go.  500 by
+	                                     default.
+	    -n, --no-enclosure               Disables the barrier that normally keeps
+	                                     objects on the screen.
+	    -u, --url [url]                  dRuby URL to run the server on.  If not
+	                                     defined, one will be selected and printed to
+	                                     STDOUT.
+	    -f, --fps [frames]               Number of frames to draw per second.  60 by
+	                                     default.
+	        --view-width [pixels]        Window width.  800 by default.
+	        --view-height [pixels]       Window height.  600 by default.
+
 
 == Development
 

data/bin/zyps

@@ -18,6 +18,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
+gems_loaded = false
 begin
 	require 'zyps'
 	require 'zyps/actions'
@@ -25,15 +26,18 @@ begin
 	require 'zyps/environmental_factors'
 	require 'zyps/views/trails'
 rescue LoadError
-	require 'rubygems'
-	require 'zyps'
-	require 'zyps/actions'
-	require 'zyps/conditions'
-	require 'zyps/environmental_factors'
-	require 'zyps/views/trails'
+	if gems_loaded == false
+		require 'rubygems'
+		gems_loaded = true
+		retry
+	else
+		raise
+	end
 end
 
 
+include Zyps
+
 
 class Application
 
@@ -79,6 +83,9 @@ class Application
 		#Keep all objects under a certain speed.
 		@environment.environmental_factors << SpeedLimit.new(100)
 		
+		#Limit population.
+		@environment.environmental_factors << PopulationLimit.new(@environment, 25)
+		
 		#Set up a creature generator.
 		@generator = CreatureGenerator.new(@environment)
 
@@ -94,9 +101,6 @@ class Application
 				
 					@environment.interact
 					
-					#Control population.
-					@environment.objects.shift while @environment.objects.length > 25
-					
 					#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.

data/bin/zyps_demo

@@ -32,6 +32,9 @@ rescue LoadError
 end
 
 
+include Zyps
+
+
 class Demo
 
 	#The view width.

data/bin/zyps_server

@@ -0,0 +1,262 @@
+#!/usr/local/bin/ruby
+
+# 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/>.
+
+
+gems_loaded = false
+begin
+	require 'optparse'
+	require 'zyps'
+	require 'zyps/actions'
+	require 'zyps/conditions'
+	require 'zyps/environmental_factors'
+	require 'zyps/views/trails'
+	require 'drb'
+rescue LoadError
+	if gems_loaded == false
+		require 'rubygems'
+		gems_loaded = true
+		retry
+	else
+		raise
+	end
+end
+
+
+include Zyps
+
+
+DEFAULT_VIEW_WIDTH = 800
+DEFAULT_VIEW_HEIGHT = 600
+DEFAULT_MAX_SPEED = 500
+DEFAULT_MAX_POPULATION = 25
+DEFAULT_FPS = 60
+
+
+#Extend Environment for serving over DRb.
+class Environment
+
+	include DRbUndumped
+	
+	def initialize (objects = [], environmental_factors = [])
+		@objects, @environmental_factors = objects, environmental_factors
+		@clock = Clock.new
+		@objects.extend DRbUndumped
+		@environmental_factors.extend DRbUndumped
+	end
+	
+	alias old_objects= objects=
+	def objects=(value)
+		old_objects=(value)
+		@objects.extend DRbUndumped
+	end
+	
+	alias old_environmental_factors= environmental_factors=
+	def environmental_factors=(value)
+		old_environmental_factors=(value)
+		@environmental_factors.extend DRbUndumped
+	end
+	
+end
+
+#A server for a Zyps Environment.
+class EnvironmentServer
+
+	#Port to open service on.
+	attr_accessor :url
+	#Maximum allowed number of objects.
+	attr_accessor :max_population
+	#View dimensions.
+	attr_accessor :view_width, :view_height
+	
+	#Set up default values.
+	def initialize(
+		url = nil,
+		view_width = DEFAULT_VIEW_WIDTH,
+		view_height = DEFAULT_VIEW_HEIGHT,
+		fps = DEFAULT_FPS,
+		max_population = DEFAULT_MAX_POPULATION,
+		max_speed = DEFAULT_MAX_SPEED,
+		enclosure = true
+	)
+		@url, @view_width, @view_height, @fps, @max_population, @max_speed, @enclosure =
+		url, view_width, view_height, fps, max_population, max_speed, enclosure
+	end
+
+	#Create app window, game environment, view, and network service.
+	def main
+	
+		#A clock to track frames to draw this second.
+		clock = Clock.new
+		time_per_frame = 1.0 / @fps
+	
+		#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(@view_width, @view_height)
+		window.add(view.canvas)
+		window.show_all
+		
+		#Create environment.
+		environment = Environment.new
+		
+		#Point view at environment.
+		environment.add_observer(view)
+		
+		#Limit population.
+		environment.environmental_factors << PopulationLimit.new(environment, @max_population) if @max_population
+		
+		#Limit speed of objects.
+		environment.environmental_factors << SpeedLimit.new(@max_speed) if @max_speed
+		
+		#Keep objects on screen.
+		if @enclosure
+			enclosure = Enclosure.new()
+			enclosure.left = 0
+			enclosure.bottom = 0
+			enclosure.top = @view_height
+			enclosure.right = @view_width
+			environment.environmental_factors << enclosure
+		end
+		
+		#Create thread to update environment.
+		update_thread = Thread.new do
+		
+			begin
+			
+				loop do
+				
+					begin
+						environment.interact
+					rescue Exception => exception
+						puts exception, exception.backtrace
+						puts environment.inspect
+					end
+					
+					#Control population.
+					environment.objects.shift while environment.objects.length > @max_population
+
+					#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
+		
+		#Start a network service.
+		DRb.start_service(
+			@url,
+			environment
+		)
+		#Display our URI.
+		puts "Zyps server active at #{DRb.uri}"
+		
+		#Disable file system access.
+		$SAFE = 2
+
+		#Activate the GUI.
+		Gtk.main
+		
+	end
+	
+	
+	#Set attributes according to command-line arguments.
+	def process_options(arguments)
+	
+		#Set up option parser.
+		options = OptionParser.new
+		
+		#Define valid options.
+		options.on("-h", "--help", TrueClass, "Display program help.") {
+			puts options.help
+			exit
+		}
+		options.on(
+			"-m",
+			"--max-population [number]",
+			Integer,
+			"The maximum number of allowed game objects.  #{DEFAULT_MAX_POPULATION} by default."
+		) {|value| @max_population = value}
+		options.on(
+			"-s",
+			"--max-speed [number]",
+			Integer,
+			"The fastest an object can go.  #{DEFAULT_MAX_SPEED ? DEFAULT_MAX_SPEED : 'No limit'} by default."
+		) {|value| @max_speed = value}
+		options.on(
+			"-n",
+			"--no-enclosure",
+			"Disables the barrier that normally keeps objects on the screen."
+		) {|value| @enclosure = false}
+		options.on(
+			"-u",
+			"--url [url]",
+			String,
+			"dRuby URL to run the server on.  If not defined, one will be selected and printed to STDOUT."
+		) {|value| @url = value}
+		options.on(
+			"-f",
+			"--fps [frames]",
+			Integer,
+			"Number of frames to draw per second.  #{DEFAULT_FPS} by default."
+		) {|value| @fps = value}
+		options.on(
+			"--view-width [pixels]",
+			Integer,
+			"Window width.  #{DEFAULT_VIEW_WIDTH} by default."
+		) {|value| @view_width = value}
+		options.on(
+			"--view-height [pixels]",
+			Integer,
+			"Window height.  #{DEFAULT_VIEW_HEIGHT} by default."
+		) {|value| @view_height = value}
+		
+		#Parse the options, printing usage if parsing fails.
+		options.parse(arguments) rescue puts "#{$!}\nType '#{$0} --help' for valid options."
+		
+	end
+
+
+end
+
+
+begin
+	#Create a server.
+	server = EnvironmentServer.new
+	#Parse the command line.
+	server.process_options(ARGV)
+	#Start the server.
+	server.main
+rescue => exception
+	#Print error to STDERR and exit with an abnormal status.
+	abort "Error: " + exception.message + exception.backtrace.join("\n")
+end

data/doc/classes/Zyps.html

@@ -0,0 +1,161 @@
+<?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>Module: Zyps</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>Module</strong></td>
+          <td class="class-name-in-header">Zyps</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 />
+                <a href="../files/lib/zyps/actions_rb.html">
+                lib/zyps/actions.rb
+                </a>
+        <br />
+                <a href="../files/lib/zyps/environmental_factors_rb.html">
+                lib/zyps/environmental_factors.rb
+                </a>
+        <br />
+                <a href="../files/lib/zyps/conditions_rb.html">
+                lib/zyps/conditions.rb
+                </a>
+        <br />
+                <a href="../files/lib/zyps/views/trails_rb.html">
+                lib/zyps/views/trails.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Zyps/Utility.html" class="link">Zyps::Utility</a><br />
+Class <a href="Zyps/AccelerateAction.html" class="link">Zyps::AccelerateAction</a><br />
+Class <a href="Zyps/Accelerator.html" class="link">Zyps::Accelerator</a><br />
+Class <a href="Zyps/Action.html" class="link">Zyps::Action</a><br />
+Class <a href="Zyps/AgeCondition.html" class="link">Zyps::AgeCondition</a><br />
+Class <a href="Zyps/ApproachAction.html" class="link">Zyps::ApproachAction</a><br />
+Class <a href="Zyps/Behavior.html" class="link">Zyps::Behavior</a><br />
+Class <a href="Zyps/BlendAction.html" class="link">Zyps::BlendAction</a><br />
+Class <a href="Zyps/Clock.html" class="link">Zyps::Clock</a><br />
+Class <a href="Zyps/CollisionCondition.html" class="link">Zyps::CollisionCondition</a><br />
+Class <a href="Zyps/Color.html" class="link">Zyps::Color</a><br />
+Class <a href="Zyps/Condition.html" class="link">Zyps::Condition</a><br />
+Class <a href="Zyps/Creature.html" class="link">Zyps::Creature</a><br />
+Class <a href="Zyps/DestroyAction.html" class="link">Zyps::DestroyAction</a><br />
+Class <a href="Zyps/EatAction.html" class="link">Zyps::EatAction</a><br />
+Class <a href="Zyps/Enclosure.html" class="link">Zyps::Enclosure</a><br />
+Class <a href="Zyps/Environment.html" class="link">Zyps::Environment</a><br />
+Class <a href="Zyps/EnvironmentalFactor.html" class="link">Zyps::EnvironmentalFactor</a><br />
+Class <a href="Zyps/FaceAction.html" class="link">Zyps::FaceAction</a><br />
+Class <a href="Zyps/FleeAction.html" class="link">Zyps::FleeAction</a><br />
+Class <a href="Zyps/Friction.html" class="link">Zyps::Friction</a><br />
+Class <a href="Zyps/GameObject.html" class="link">Zyps::GameObject</a><br />
+Class <a href="Zyps/Gravity.html" class="link">Zyps::Gravity</a><br />
+Class <a href="Zyps/Location.html" class="link">Zyps::Location</a><br />
+Class <a href="Zyps/NoMatchException.html" class="link">Zyps::NoMatchException</a><br />
+Class <a href="Zyps/PopulationLimit.html" class="link">Zyps::PopulationLimit</a><br />
+Class <a href="Zyps/ProximityCondition.html" class="link">Zyps::ProximityCondition</a><br />
+Class <a href="Zyps/PullAction.html" class="link">Zyps::PullAction</a><br />
+Class <a href="Zyps/PushAction.html" class="link">Zyps::PushAction</a><br />
+Class <a href="Zyps/SpeedLimit.html" class="link">Zyps::SpeedLimit</a><br />
+Class <a href="Zyps/TagAction.html" class="link">Zyps::TagAction</a><br />
+Class <a href="Zyps/TagCondition.html" class="link">Zyps::TagCondition</a><br />
+Class <a href="Zyps/TrailsView.html" class="link">Zyps::TrailsView</a><br />
+Class <a href="Zyps/TurnAction.html" class="link">Zyps::TurnAction</a><br />
+Class <a href="Zyps/Vector.html" class="link">Zyps::Vector</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>