steering_behaviors 1.0.7 → 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog for steering-behaviors
 
+## 1.1.0, 13 August 2013
+* Predictive interception lookahead tweaked slightly
+* Bugfix: angle-limited steering could never be accelerative
+* Evasion & pursuit demos are slower and more illustrative
+* Separation demo includes danger-radius circle, smaller time lookahead
+* Separation steering force scaled by speed for proper strength
+* feel_the_force() returns immediately for zero-vector steering
+* Bumping minor number; honestly, should have done this on 11 Aug
+
 ## 1.0.7, 12 August 2013
 * Fix embarrassing bug (left 'puts' statements uncommented in prior release)
 

data/lib/steering_behaviors/align.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Align
 

data/lib/steering_behaviors/arrive.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Arrive
   # Arrive 'gently' at the goal position by decelerating smoothly.

data/lib/steering_behaviors/broadside.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Broadside
 

data/lib/steering_behaviors/common.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 module SteeringBehaviors::Common
 
@@ -93,7 +93,7 @@ module SteeringBehaviors::Common
         tf = 1.8
       when 0
         gen="ahead, perpendicular"
-        tf = 1.35
+        tf = 1.45
       when -1
         gen="ahead, anti-parallel"
         tf = 1.10

data/lib/steering_behaviors/evade.rb

@@ -4,18 +4,18 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Evade
   extend SteeringBehaviors::Common
 
-  # Evade a moving target by anticipating its future position. Calculates where it thinks
-  # the target will be, and leverages 'flee' to calculate how to best escape.
+  # Evade a moving target by anticipating its future position. Our character calculates
+  # where it thinks the enemy will be, and leverages 'flee' to calculate how to best escape.
   # See http://www.red3d.com/cwr/steer/
   #
   # * *Args*    :
   #   - +character_kinematic+ -> kinematic of "our" character that is moving and evading
-  #   - +other_kinematic+ -> kinematic of the thing to evade
+  #   - +enemy_kinematic+ -> kinematic of the thing to evade
   # * *Returns* :
   #   - a steering force
   #

data/lib/steering_behaviors/flee.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Flee
 

data/lib/steering_behaviors/match.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Match
 

data/lib/steering_behaviors/orthogonal.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Orthogonal
 

data/lib/steering_behaviors/pursue.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Pursue
   extend SteeringBehaviors::Common

data/lib/steering_behaviors/seek.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Seek
 

data/lib/steering_behaviors/separation.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Separation
   extend SteeringBehaviors::Common
@@ -31,7 +31,7 @@ class SteeringBehaviors::Separation
     forwardness = unit_offset.dot(character_kinematic.heading_vec)
     parallelness = character_kinematic.heading_vec.dot(other_kinematic.heading_vec)
 
-    side_vec = character_kinematic.heading_vec.perpendicular
+    side_vec = character_kinematic.heading_vec.perpendicular * character_kinematic.speed
 
     if parallelness < -0.707
       # anti-parallel, head-on paths; steer away from the threat's future pos

data/lib/steering_behaviors/steering.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Steering
 
@@ -12,24 +12,28 @@ class SteeringBehaviors::Steering
   # Takes turn rate limitations, mass, and other limits into account, and
   # directly alters the provided Mobile component.
   #
+  # The options hash lets you alter the behaviors a bit from the 'canonical'
+  # behaviors. The routine understands these settings:
+  # * permit_accel => (boolean) whether the steering force should be permitted to
+  # accelerate our agent; set it to false if that is undesirable.
+  # * permit_decel => (boolean) whether the steering force should be permitted to
+  # decelerate our agent; set it to false if that is undesirable.
   # * *Args*    :
   #   - +character_kinematic+ -> "our" character that is moving
   #   - +steering_force+ -> force vector supplied by a steering behavior
   #   - +delta+ -> time delta (in seconds) used for scaling the result
+  #   - +options+ -> hash of user-set options for tuning the steering
   #
-  def self.feel_the_force(character_kinematic, steering_force, delta, accelerative=true)
-    return if steering_force.nil?
-
-    acceleration = steering_force / character_kinematic.mass
+  def self.feel_the_force(character_kinematic, steering_force, delta, options={})
+    return if steering_force.nil? || steering_force == SteeringBehaviors::VEC_ZERO
 
     # Compute the new, proposed velocity vector.
+    acceleration = steering_force / character_kinematic.mass
     desired_velocity = character_kinematic.velocity_vec + (acceleration * delta)
-    desired_velocity.truncate!(character_kinematic.speed) if !accelerative
-    desired_velocity.truncate!(character_kinematic.max_speed)
 
     # If this timeslice's proposed velocity-vector exceeds the turn rate,
     # come up with a revised velociy-vec that doesn't exceed the rate -- and use that.
-    angle             = Math.acos character_kinematic.heading_vec.clamped_dot(desired_velocity.normalize)
+    angle = Math.acos character_kinematic.heading_vec.clamped_dot(desired_velocity.normalize)
     max_course_change = character_kinematic.max_turn * delta
 
     if angle.abs > max_course_change
@@ -44,13 +48,28 @@ class SteeringBehaviors::Steering
       #   desired_velocity.radians,
       #   limited_crse
 
-      character_kinematic.velocity_vec = SteeringBehaviors::Vector.new(
-        Math.sin(limited_crse) * character_kinematic.speed,
-        Math.cos(limited_crse) * character_kinematic.speed
+      desired_velocity = SteeringBehaviors::Vector.new(
+        Math.sin(limited_crse) * desired_velocity.length,
+        Math.cos(limited_crse) * desired_velocity.length
       )
-    else
-      character_kinematic.velocity_vec = desired_velocity
     end
+
+    opts = {:permit_accel=>true, :permit_decel=>true}.merge(options)
+
+    # Don't permit acceleration if the caller disabled it
+    if !opts[:permit_accel]
+      desired_velocity.truncate!(character_kinematic.speed)
+    end
+
+    # Don't permit deceleration if the caller disabled it
+    if !opts[:permit_decel] && desired_velocity.length < character_kinematic.speed
+      desired_velocity = desired_velocity.normalize! * character_kinematic.speed
+    end
+
+    # And of course obey the character's maximum speed
+    desired_velocity.truncate!(character_kinematic.max_speed)
+
+    character_kinematic.velocity_vec = desired_velocity
   end
 
 end

data/lib/steering_behaviors/vector.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Vector
   TWOPI   = 6.283185307179586

data/lib/steering_behaviors/wander.rb

@@ -4,7 +4,7 @@
 # This file is part of The Ruby Steering Behaviors Library.
 # http://github.com/cpowell/steering-behaviors
 # You can redistribute and/or modify this software only in accordance with
-# the terms found in the "LICENSE" file included with the framework.
+# the terms found in the "LICENSE" file included with the library.
 
 class SteeringBehaviors::Wander
 

metadata

@@ -2,14 +2,14 @@
 name: steering_behaviors
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 1.0.7
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-12 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies: []
 description: |
   If you're building a game, you need your game agents and characters to move on their own. A standard way of doing this is with 'steering behaviors'. The seminal paper by Craig Reynolds established a core set of steering behaviors that could be utilized for a variety of common movement tasks and natural behaviors. This Ruby library can accomplish many/most of those tasks for your Ruby / JRuby game. The basic behaviors can be layered for more complicated and advanced behaviors, such as flocking and crowd movement.