coords 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71f88964e9d3049a37804c1c9db1401aefb8f163
-  data.tar.gz: 2bcbd911f75fa84b05482d8994ee1956bf53dca7
+  metadata.gz: 5650aafea9e3293dfabd0891b4b918454189af5d
+  data.tar.gz: 86475eb12664e5cc73ddeeab6b6ee528e03256c1
 SHA512:
-  metadata.gz: 28d4fe183b98a0b10c3ffb8e44035beb0042235722e98fa1f3a9c922bc66a38553332c584fed6db370fe18da846777fa3e824207b2851f882bf9ad24e3272471
-  data.tar.gz: a8077a0ea3ae2a4af4e8a1cfd09e18356c9cd1f920b063450cd649b52421bea3e31fa5b8c3798668fe6e29edc7dd8e1dc737d3ecc486d6982f2c30ba3a2d1805
+  metadata.gz: 8be3f54bd57d0287adb8188ef35dfd0ba22c766f7a77498d0ec195975255c272b8ae29ffff92d1218811092138998abe66447da2b7a1f55f8db54496855f47c1
+  data.tar.gz: 29f0df2c3e01fcc3354ecfea6846cf517106b731aa81397a93e2e95239a9d247572872bd1a4fd326f2114e8ce73685baa4a24535c622caeba5b0bd39a38c4521

data/README.md

@@ -19,11 +19,59 @@ Or install it yourself as:
     $ gem install coords
 
 ## Usage
+
+### Utilities
+```ruby
+# convert degrees to radians
+Coords.radians(180)
+ => 3.141592653589793
+
+# convert radians to degrees
+Coords.radians(Math::PI)
+ => 180.0
+```
+
+### Cartesian (2D)
 ```ruby
-point = Coords::Cartesian2d.new(1, 2)
-d = point.distance(point2)
-polar_point = point.to_polar
+# create a new point
+p = Cartesian2d.new(1, 2)
+
+# access point coordinates
+p.x
+ => 1
+p.y
+ => 2
+
+# find distances between points
+p2 = Cartesian2d.new(3, 3)
+p.distance_squared(p2)
+ => 5
+p.distance(p2)
+ => 2.23606797749979
+
+# convert to polar coordinate system
+p.to_polar
+ => #<Coords::Polar @radius=2.2360679775, @theta=1.107148717794>
+
+# translate coordinates (add values to them)
+p.translate(1, 1)
+ => #<Coords::Cartesian2d @x=2, @y=3>
+
+# rotate point around origin
+p.rotate(Coords.radians(180))
+ => #<Coords::Cartesian2d @x=-1.0, @y=-2.0>
+
+# reflect point against origin, line, x-axis or y-axis
+p.reflect('origin')
+ => #<Coords::Cartesian2d @x=-1, @y=-2> 
+p.reflect('line')
+ => #<Coords::Cartesian2d @x=2, @y=1> 
+p.reflect('x')
+ => #<Coords::Cartesian2d @x=1, @y=-2> 
+p.reflect('y')
+ => #<Coords::Cartesian2d @x=-1, @y=2> 
 ```
+
 ## Contributing
 
 1. Fork it ( https://github.com/ceud/coords/fork )

data/lib/coords/cartesian3d.rb

@@ -48,16 +48,19 @@ module Coords
     end
 
     def rotate!(rZ = 0, rX = 0, rY = 0)
+      # rotate clockwise around z axis
       d = Math.hypot(y, x)
       theta = Math.atan2(y, x) + rZ
       @x = d * Math.cos(theta)
       @y = d * Math.sin(theta)
 
+      # rotate clockwise around x axis
       d = Math.hypot(y, z)
       theta = Math.atan2(z, y) + rX
       @y = d * Math.cos(theta)
       @z = d * Math.sin(theta)
 
+      # rotate clockwise around y axis
       d = Math.hypot(x, z)
       theta = Math.atan2(x, z) + rY
       @z = d * Math.cos(theta)

data/lib/coords/polar.rb

@@ -42,5 +42,33 @@ module Coords
       radius.round(12) == point.radius.round(12) && theta.round(12) == point.theta.round(12)
     end
 
+    def translate(radius2, theta2)
+      translated_point = Polar.new(radius, theta)
+      translated_point.translate!(radius2, theta2)
+      translated_point
+    end
+
+    def translate!(radius2, theta2)
+      c1 = self.to_cartesian
+      c2 = Polar.new(radius2, theta2).to_cartesian
+      c3 = c1.translate(c2.x, c2.y)
+      p = c3.to_polar
+
+      @radius = p.radius
+      @theta = p.theta
+    end
+
+    def rotate(radians)
+      rotated_point = Polar.new(radius, theta)
+      rotated_point.rotate!(radians)
+      rotated_point
+    end
+
+    def rotate!(radians)
+      @theta += radians
+      @theta -= (2 * Math::PI) while theta > (2 * Math::PI)
+      @theta += (2 * Math::PI) while theta < 0
+    end
+
   end
 end

data/lib/coords/version.rb

@@ -1,3 +1,3 @@
 module Coords
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/lib/coords/polar_spec.rb

@@ -50,4 +50,24 @@ describe Coords::Polar do
       expect(subject != point2).to be false
     end
   end
+
+  describe '#translate' do
+    it 'translates values to new point' do
+      point2 = subject.translate(2, 1)
+      expect(subject.radius).to eq(1)
+      expect(subject.theta).to eq(2)
+      expect(point2.radius).to eq(2.676043576528)
+      expect(point2.theta).to eq(1.319872910435)
+    end
+  end
+
+  describe '#rotate' do
+    it 'rotates values to new point' do
+      point2 = subject.rotate(1)
+      expect(subject.radius).to eq(1)
+      expect(subject.theta).to eq(2)
+      expect(point2.radius).to eq(1)
+      expect(point2.theta).to eq(3)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coords
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Craig Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler